javax.swing.JFormattedTextField.AbstractFormatter

Instances of AbstractFormatter are used by JFormattedTextField to handle the conversion both from an Object to a String, and back from a String to an Object. AbstractFormatters can also enfore editing policies, or navigation policies, or manipulate the JFormattedTextField in any way it sees fit to enforce the desired policy.

An AbstractFormatter can only be active in one JFormattedTextField at a time. JFormattedTextField invokes install when it is ready to use it followed by uninstall when done. Subclasses that wish to install additional state should override install and message super appropriately.

Subclasses must override the conversion methods stringToValue and valueToString. Optionally they can override getActions, getNavigationFilter and getDocumentFilter to restrict the JFormattedTextField in a particular way.

Subclasses that allow the JFormattedTextField to be in a temporarily invalid state should invoke setEditValid at the appropriate times.

since 1.4

Clones the AbstractFormatter. The returned instance is not associated with a JFormattedTextField.

return

Copy of the AbstractFormatter

Installs the AbstractFormatter onto a particular JFormattedTextField. This will invoke valueToString to convert the current value from the JFormattedTextField to a String. This will then install the Actions from getActions, the DocumentFilter returned from getDocumentFilter and the NavigationFilter returned from getNavigationFilter onto the JFormattedTextField.

Subclasses will typically only need to override this if they wish to install additional listeners on the JFormattedTextField.

If there is a ParseException in converting the current value to a String, this will set the text to an empty String, and mark the JFormattedTextField as being in an invalid state.

While this is a public method, this is typically only useful for subclassers of JFormattedTextField. JFormattedTextField will invoke this method at the appropriate times when the value changes, or its internal state changes. You will only need to invoke this yourself if you are subclassing JFormattedTextField and installing/uninstalling AbstractFormatter at a different time than JFormattedTextField does.

ftf JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.

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

Throws	ParseException: if there is an error in the conversion
text	String to convert
return	Object representation of text

Returns the string value to display for value.

Throws	ParseException: if there is an error in the conversion
value	Value to convert
return	String representation of value

Subclass and override if you wish to provide a custom set of Actions. install will install these on the JFormattedTextField's ActionMap.

return

Array of Actions to install on JFormattedTextField

Subclass and override if you wish to provide a DocumentFilter to restrict what can be input. install will install the returned value onto the JFormattedTextField.

return

DocumentFilter to restrict edits

Invoke this to update the editValid property of the JFormattedTextField. If you an enforce a policy such that the JFormattedTextField is always in a valid state, you will never need to invoke this.

valid

Valid state of the JFormattedTextField

Returns the current JFormattedTextField the AbstractFormatter is installed on.

return

JFormattedTextField formatting for.

Subclass and override if you wish to provide a filter to restrict where the user can navigate to. install will install the returned value onto the JFormattedTextField.

return

NavigationFilter to restrict navigation