InternationalFormatter

Class Overview

InternationalFormatter extends DefaultFormatter, using an instance of java.text.Format to handle the conversion to a String, and the conversion from a String.

If getAllowsInvalid() is false, this will ask the Format to format the current text on every edit.

You can specify a minimum and maximum value by way of the setMinimum and setMaximum methods. In order for this to work the values returned from stringToValue must be comparable to the min/max values by way of the Comparable interface.

Be careful how you configure the Format and the InternationalFormatter, as it is possible to create a situation where certain values can not be input. Consider the date format 'M/d/yy', an InternationalFormatter that is always valid (setAllowsInvalid(false)), is in overwrite mode (setOverwriteMode(true)) and the date 7/1/99. In this case the user will not be able to enter a two digit month or day of month. To avoid this, the format should be 'MM/dd/yy'.

If InternationalFormatter is configured to only allow valid values (setAllowsInvalid(false)), every valid edit will result in the text of the JFormattedTextField being completely reset from the Format. The cursor position will also be adjusted as literal characters are added/removed from the resulting String.

InternationalFormatter's behavior of stringToValue is slightly different than that of DefaultTextFormatter, it does the following:

1. parseObject is invoked on the Format specified by setFormat
2. If a Class has been set for the values (setValueClass), supers implementation is invoked to convert the value returned from parseObject to the appropriate class.
3. If a ParseException has not been thrown, and the value is outside the min/max a ParseException is thrown.
4. The value is returned.

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^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand] Inherited Methods
From class javax.swing.text.DefaultFormatter Object clone() Creates a copy of the DefaultFormatter. boolean getAllowsInvalid() Returns whether or not the value being edited is allowed to be invalid for a length of time. boolean getCommitsOnValidEdit() Returns when edits are published back to the JFormattedTextField. DocumentFilter getDocumentFilter() Returns the DocumentFilter used to restrict the characters that can be input into the JFormattedTextField. NavigationFilter getNavigationFilter() Returns the NavigationFilter used to restrict where the cursor can be placed. boolean getOverwriteMode() Returns the behavior when inserting characters. Class<?> getValueClass() Returns that class that is used to create new Objects. void install(JFormattedTextField ftf) Installs the DefaultFormatter onto a particular JFormattedTextField. void setAllowsInvalid(boolean allowsInvalid) Sets whether or not the value being edited is allowed to be invalid for a length of time (that is, stringToValue throws a ParseException). void setCommitsOnValidEdit(boolean commit) Sets when edits are published back to the JFormattedTextField. void setOverwriteMode(boolean overwriteMode) Configures the behavior when inserting characters. void setValueClass(Class<?> valueClass) Sets that class that is used to create new Objects. Object stringToValue(String string) Converts the passed in String into an instance of getValueClass by way of the constructor that takes a String argument. String valueToString(Object value) Converts the passed in Object into a String by way of the toString method.
From class javax.swing.JFormattedTextField.AbstractFormatter Object clone() Clones the AbstractFormatter. Action[] getActions() Subclass and override if you wish to provide a custom set of Actions. DocumentFilter getDocumentFilter() Subclass and override if you wish to provide a DocumentFilter to restrict what can be input. JFormattedTextField getFormattedTextField() Returns the current JFormattedTextField the AbstractFormatter is installed on. NavigationFilter getNavigationFilter() Subclass and override if you wish to provide a filter to restrict where the user can navigate to. void install(JFormattedTextField ftf) Installs the AbstractFormatter onto a particular JFormattedTextField. void invalidEdit() This should be invoked when the user types an invalid character. void setEditValid(boolean valid) Invoke this to update the editValid property of the JFormattedTextField. abstract Object stringToValue(String text) Parses text returning an arbitrary Object. void uninstall() Uninstalls any state the AbstractFormatter may have installed on the JFormattedTextField. abstract String valueToString(Object value) Returns the string value to display for value.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.