- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
DateFormatter
,NumberFormatter
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:
-
Constructor Summary
ConstructorDescriptionCreates anInternationalFormatter
with noFormat
specified.InternationalFormatter
(Format format) Creates anInternationalFormatter
with the specifiedFormat
instance. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a copy of the DefaultFormatter.protected Action[]
IfgetSupportsIncrement
returns true, this returns two Actions suitable for incrementing/decrementing the value.getFields
(int offset) Returns theFormat.Field
constants associated with the text atoffset
.Returns the format that dictates the legal values that can be edited and displayed.Comparable
<?> Returns the maximum permissible value.Comparable
<?> Returns the minimum permissible value.void
Installs theDefaultFormatter
onto a particularJFormattedTextField
.void
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.stringToValue
(String text) Returns theObject
representation of theString
text
.valueToString
(Object value) Returns a String representation of the Objectvalue
.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
-
Constructor Details
-
InternationalFormatter
public InternationalFormatter()Creates anInternationalFormatter
with noFormat
specified. -
InternationalFormatter
Creates anInternationalFormatter
with the specifiedFormat
instance.- Parameters:
format
- Format instance used for converting from/to Strings
-
-
Method Details
-
setFormat
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
Returns the format that dictates the legal values that can be edited and displayed.- Returns:
- Format instance used for converting from/to Strings
-
setMinimum
Sets the minimum permissible value. If thevalueClass
has not been specified, andminimum
is non null, thevalueClass
will be set to that of the class ofminimum
.- Parameters:
minimum
- Minimum legal value that can be input- See Also:
-
getMinimum
Returns the minimum permissible value.- Returns:
- Minimum legal value that can be input
-
setMaximum
Sets the maximum permissible value. If thevalueClass
has not been specified, andmax
is non null, thevalueClass
will be set to that of the class ofmax
.- Parameters:
max
- Maximum legal value that can be input- See Also:
-
getMaximum
Returns the maximum permissible value.- Returns:
- Maximum legal value that can be input
-
install
Installs theDefaultFormatter
onto a particularJFormattedTextField
. This will invokevalueToString
to convert the current value from theJFormattedTextField
to a String. This will then install theAction
s fromgetActions
, theDocumentFilter
returned fromgetDocumentFilter
and theNavigationFilter
returned fromgetNavigationFilter
onto theJFormattedTextField
.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 theJFormattedTextField
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
Returns a String representation of the Objectvalue
. This invokesformat
on the currentFormat
.- 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
Returns theObject
representation of theString
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
Returns theFormat.Field
constants associated with the text atoffset
. Ifoffset
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
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:
-
getActions
IfgetSupportsIncrement
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
-