Class DefaultFormatter
- All Implemented Interfaces:
Serializable,Cloneable
- Direct Known Subclasses:
InternationalFormatter,MaskFormatter
DefaultFormatter formats arbitrary objects. Formatting is done
by invoking the toString method. In order to convert the
value back to a String, your class must provide a constructor that
takes a String argument. If no single argument constructor that takes a
String is found, the returned value will be the String passed into
stringToValue.
Instances of DefaultFormatter can not be used in multiple
instances of JFormattedTextField. To obtain a copy of
an already configured DefaultFormatter, use the
clone method.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans package.
Please see XMLEncoder.
- Since:
- 1.4
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Creates a copy of the DefaultFormatter.booleanReturns whether or not the value being edited is allowed to be invalid for a length of time.booleanReturns when edits are published back to theJFormattedTextField.protected DocumentFilterReturns theDocumentFilterused to restrict the characters that can be input into theJFormattedTextField.protected NavigationFilterReturns theNavigationFilterused to restrict where the cursor can be placed.booleanReturns the behavior when inserting characters.Class<?> Returns that class that is used to create new Objects.voidInstalls theDefaultFormatteronto a particularJFormattedTextField.voidsetAllowsInvalid(boolean allowsInvalid) Sets whether or not the value being edited is allowed to be invalid for a length of time (that is,stringToValuethrows aParseException).voidsetCommitsOnValidEdit(boolean commit) Sets when edits are published back to theJFormattedTextField.voidsetOverwriteMode(boolean overwriteMode) Configures the behavior when inserting characters.voidsetValueClass(Class<?> valueClass) Sets that class that is used to create new Objects.stringToValue(String string) Converts the passed in String into an instance ofgetValueClassby way of the constructor that takes a String argument.valueToString(Object value) Converts the passed in Object into a String by way of thetoStringmethod.Methods declared in class javax.swing.JFormattedTextField.AbstractFormatter
getActions, getFormattedTextField, invalidEdit, setEditValid, uninstall
-
Constructor Details
-
DefaultFormatter
public DefaultFormatter()Creates a DefaultFormatter.
-
-
Method Details
-
install
Installs theDefaultFormatteronto a particularJFormattedTextField. This will invokevalueToStringto convert the current value from theJFormattedTextFieldto a String. This will then install theActions fromgetActions, theDocumentFilterreturned fromgetDocumentFilterand theNavigationFilterreturned fromgetNavigationFilteronto theJFormattedTextField.Subclasses will typically only need to override this if they wish to install additional listeners on the
JFormattedTextField.If there is a
ParseExceptionin converting the current value to a String, this will set the text to an empty String, and mark theJFormattedTextFieldas being in an invalid state.While this is a public method, this is typically only useful for subclassers of
JFormattedTextField.JFormattedTextFieldwill invoke this method at the appropriate times when the value changes, or its internal state changes.- Overrides:
installin classJFormattedTextField.AbstractFormatter- Parameters:
ftf- JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.
-
setCommitsOnValidEdit
public void setCommitsOnValidEdit(boolean commit) Sets when edits are published back to theJFormattedTextField. If true,commitEditis invoked after every valid edit (any time the text is edited). On the other hand, if this is false than theDefaultFormatterdoes not publish edits back to theJFormattedTextField. As such, the only time the value of theJFormattedTextFieldwill change is whencommitEditis invoked onJFormattedTextField, typically when enter is pressed or focus leaves theJFormattedTextField.- Parameters:
commit- Used to indicate when edits are committed back to the JTextComponent
-
getCommitsOnValidEdit
public boolean getCommitsOnValidEdit()Returns when edits are published back to theJFormattedTextField.- Returns:
- true if edits are committed after every valid edit
-
setOverwriteMode
public void setOverwriteMode(boolean overwriteMode) Configures the behavior when inserting characters. IfoverwriteModeis true (the default), new characters overwrite existing characters in the model.- Parameters:
overwriteMode- Indicates if overwrite mode is used
-
getOverwriteMode
public boolean getOverwriteMode()Returns the behavior when inserting characters.- Returns:
- true if newly inserted characters overwrite existing characters
-
setAllowsInvalid
public void setAllowsInvalid(boolean allowsInvalid) Sets whether or not the value being edited is allowed to be invalid for a length of time (that is,stringToValuethrows aParseException). It is often convenient to allow the user to temporarily input an invalid value.- Parameters:
allowsInvalid- Used to indicate if the edited value must always be valid
-
getAllowsInvalid
public boolean getAllowsInvalid()Returns whether or not the value being edited is allowed to be invalid for a length of time.- Returns:
- false if the edited value must always be valid
-
setValueClass
Sets that class that is used to create new Objects. If the passed in class does not have a single argument constructor that takes a String, String values will be used.- Parameters:
valueClass- Class used to construct return value from stringToValue
-
getValueClass
Returns that class that is used to create new Objects.- Returns:
- Class used to construct return value from stringToValue
-
stringToValue
Converts the passed in String into an instance ofgetValueClassby way of the constructor that takes a String argument. IfgetValueClassreturns null, the Class of the current value in theJFormattedTextFieldwill be used. If this is null, a String will be returned. If the constructor throws an exception, aParseExceptionwill be thrown. If there is no single argument String constructor,stringwill be returned.- Specified by:
stringToValuein classJFormattedTextField.AbstractFormatter- Parameters:
string- String to convert- Returns:
- Object representation of text
- Throws:
ParseException- if there is an error in the conversion
-
valueToString
Converts the passed in Object into a String by way of thetoStringmethod.- Specified by:
valueToStringin classJFormattedTextField.AbstractFormatter- Parameters:
value- Value to convert- Returns:
- String representation of value
- Throws:
ParseException- if there is an error in the conversion
-
getDocumentFilter
Returns theDocumentFilterused to restrict the characters that can be input into theJFormattedTextField.- Overrides:
getDocumentFilterin classJFormattedTextField.AbstractFormatter- Returns:
- DocumentFilter to restrict edits
-
clone
Creates a copy of the DefaultFormatter.- Overrides:
clonein classJFormattedTextField.AbstractFormatter- Returns:
- copy of the DefaultFormatter
- Throws:
CloneNotSupportedException- if the object's class does not support theCloneableinterface. Subclasses that override theclonemethod can also throw this exception to indicate that an instance cannot be cloned.- See Also:
-