Class InternationalFormatter
- java.lang.Object
-
- javax.swing.JFormattedTextField.AbstractFormatter
-
- javax.swing.text.DefaultFormatter
-
- javax.swing.text.InternationalFormatter
- All Implemented Interfaces:
-
Serializable
,Cloneable
- Direct Known Subclasses:
-
DateFormatter
,NumberFormatter
public class InternationalFormatter extends DefaultFormatter
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:
-
parseObject
is invoked on theFormat
specified bysetFormat
- If a Class has been set for the values (
setValueClass
), supers implementation is invoked to convert the value returned fromparseObject
to the appropriate class. - If a
ParseException
has not been thrown, and the value is outside the min/max aParseException
is thrown. - The value is returned.
InternationalFormatter
implements stringToValue
in this manner so that you can specify an alternate Class than Format
may return. 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:
-
Format
,Comparable
, Serialized Form
Constructor Summary
Constructor | Description |
---|---|
InternationalFormatter() | Creates an |
InternationalFormatter(Format format) | Creates an |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
Object | clone() | Creates a copy of the DefaultFormatter. |
protected Action[] | getActions() | If |
Format.Field[] | getFields(int offset) | Returns the |
Format | getFormat() | Returns the format that dictates the legal values that can be edited and displayed. |
Comparable<?> | getMaximum() | Returns the maximum permissible value. |
Comparable<?> | getMinimum() | Returns the minimum permissible value. |
void | install(JFormattedTextField ftf) | Installs the |
void | setFormat(Format format) | Sets the format that dictates the legal values that can be edited and displayed. |
void | setMaximum(Comparable<?> max) | Sets the maximum permissible value. |
void | setMinimum(Comparable<?> minimum) | Sets the minimum permissible value. |
Object | stringToValue(String text) | Returns the |
String | valueToString(Object value) | Returns a String representation of the Object |
Methods declared in class javax.swing.text.DefaultFormatter
getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getNavigationFilter, getOverwriteMode, getValueClass, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass
Methods declared in class javax.swing.JFormattedTextField.AbstractFormatter
getFormattedTextField, invalidEdit, setEditValid, uninstall
Methods declared in class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
InternationalFormatter
public InternationalFormatter()
Creates an InternationalFormatter
with no Format
specified.
InternationalFormatter
public InternationalFormatter(Format format)
Creates an InternationalFormatter
with the specified Format
instance.
- Parameters:
-
format
- Format instance used for converting from/to Strings
Method Detail
setFormat
public void setFormat(Format format)
Sets the format that dictates the legal values that can be edited and displayed.
- Parameters:
-
format
-Format
instance used for converting from/to Strings
getFormat
public Format getFormat()
Returns the format that dictates the legal values that can be edited and displayed.
- Returns:
- Format instance used for converting from/to Strings
setMinimum
public void setMinimum(Comparable<?> minimum)
Sets the minimum permissible value. If the valueClass
has not been specified, and minimum
is non null, the valueClass
will be set to that of the class of minimum
.
- Parameters:
-
minimum
- Minimum legal value that can be input - See Also:
DefaultFormatter.setValueClass(java.lang.Class<?>)
getMinimum
public Comparable<?> getMinimum()
Returns the minimum permissible value.
- Returns:
- Minimum legal value that can be input
setMaximum
public void setMaximum(Comparable<?> max)
Sets the maximum permissible value. If the valueClass
has not been specified, and max
is non null, the valueClass
will be set to that of the class of max
.
- Parameters:
-
max
- Maximum legal value that can be input - See Also:
DefaultFormatter.setValueClass(java.lang.Class<?>)
getMaximum
public Comparable<?> getMaximum()
Returns the maximum permissible value.
- Returns:
- Maximum legal value that can be input
install
public void install(JFormattedTextField ftf)
Installs the DefaultFormatter
onto a particular JFormattedTextField
. This will invoke valueToString
to convert the current value from the JFormattedTextField
to a String. This will then install the Action
s 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.
- Overrides:
-
install
in classDefaultFormatter
- Parameters:
-
ftf
- JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.
valueToString
public String valueToString(Object value) throws ParseException
Returns a String representation of the Object value
. This invokes format
on the current Format
.
- Overrides:
-
valueToString
in classDefaultFormatter
- Parameters:
-
value
- Value to convert - Returns:
- String representation of value
- Throws:
-
ParseException
- if there is an error in the conversion
stringToValue
public Object stringToValue(String text) throws ParseException
Returns the Object
representation of the String
text
.
- Overrides:
-
stringToValue
in classDefaultFormatter
- Parameters:
-
text
-String
to convert - Returns:
-
Object
representation of text - Throws:
-
ParseException
- if there is an error in the conversion
getFields
public Format.Field[] getFields(int offset)
Returns the Format.Field
constants associated with the text at offset
. If offset
is not a valid location into the current text, this will return an empty array.
- Parameters:
-
offset
- offset into text to be examined - Returns:
- Format.Field constants associated with the text at the given position.
clone
public Object clone() throws CloneNotSupportedException
Creates a copy of the DefaultFormatter.
- Overrides:
-
clone
in classDefaultFormatter
- Returns:
- copy of the DefaultFormatter
- Throws:
-
CloneNotSupportedException
- if the object's class does not support theCloneable
interface. Subclasses that override theclone
method can also throw this exception to indicate that an instance cannot be cloned. - See Also:
Cloneable
getActions
protected Action[] getActions()
If getSupportsIncrement
returns true, this returns two Actions suitable for incrementing/decrementing the value.
- Overrides:
-
getActions
in classJFormattedTextField.AbstractFormatter
- Returns:
- Array of Actions to install on JFormattedTextField