org.softsmithy.lib.swing.text

Class RegexFormatter

java.lang.Object

javax.swing.JFormattedTextField.AbstractFormatter

javax.swing.text.DefaultFormatter

org.softsmithy.lib.swing.text.RegexFormatter

All Implemented Interfaces:

Serializable, Cloneable

public class RegexFormatter
extends DefaultFormatter

A regular expression based implementation of AbstractFormatter. From: http://java.sun.com/products/jfc/tsc/articles/reftf/ Note: requires v1.4 Looks interessting but not yet used.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegexFormatter()
RegexFormatter(Pattern pattern) Creates a regular expression based AbstractFormatter.
RegexFormatter(String pattern) Creates a regular expression based AbstractFormatter.

Method Summary

Methods

Modifier and Type	Method and Description
protected Matcher	getMatcher() Returns the Matcher from the most test.
Pattern	getPattern() Returns the Pattern used to determine if a value is legal.
protected void	setMatcher(Matcher matcher) Sets the Matcher used in the most recent test if a value is legal.
void	setPattern(Pattern pattern) Sets the pattern that will be used to determine if a value is legal.
Object	stringToValue(String text) Parses text returning an arbitrary Object.

Methods inherited from class javax.swing.text.DefaultFormatter

clone, getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getNavigationFilter, getOverwriteMode, getValueClass, install, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass, valueToString

Methods inherited from class javax.swing.JFormattedTextField.AbstractFormatter

getActions, getFormattedTextField, invalidEdit, setEditValid, uninstall

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegexFormatter

public RegexFormatter()

RegexFormatter

public RegexFormatter(String pattern)
               throws PatternSyntaxException

Creates a regular expression based AbstractFormatter. pattern specifies the regular expression that will be used to determine if a value is legal.

Throws:

PatternSyntaxException

RegexFormatter

public RegexFormatter(Pattern pattern)

Creates a regular expression based AbstractFormatter. pattern specifies the regular expression that will be used to determine if a value is legal.

Method Detail

setPattern

public void setPattern(Pattern pattern)

Sets the pattern that will be used to determine if a value is legal.

getPattern

public Pattern getPattern()

Returns the Pattern used to determine if a value is legal.

setMatcher

protected void setMatcher(Matcher matcher)

Sets the Matcher used in the most recent test if a value is legal.

getMatcher

protected Matcher getMatcher()

Returns the Matcher from the most test.

stringToValue

public Object stringToValue(String text)
                     throws ParseException

Parses text returning an arbitrary Object. Some formatters may return null.

If a Pattern has been specified and the text completely matches the regular expression this will invoke setMatcher.

Overrides:

stringToValue in class DefaultFormatter

Parameters:

text - String to convert

Returns:

Object representation of text

Throws:

ParseException - if there is an error in the conversion