- 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
extendsDefaultFormatter
, using an instance ofjava.text.Format
to handle the conversion to a String, and the conversion from a String.If
getAllowsInvalid()
is false, this will ask theFormat
to format the current text on every edit.You can specify a minimum and maximum value by way of the
setMinimum
andsetMaximum
methods. In order for this to work the values returned fromstringToValue
must be comparable to the min/max values by way of theComparable
interface.Be careful how you configure the
Format
and theInternationalFormatter
, as it is possible to create a situation where certain values can not be input. Consider the date format 'M/d/yy', anInternationalFormatter
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 theJFormattedTextField
being completely reset from theFormat
. The cursor position will also be adjusted as literal characters are added/removed from the resulting String.InternationalFormatter
's behavior ofstringToValue
is slightly different than that ofDefaultTextFormatter
, 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
implementsstringToValue
in this manner so that you can specify an alternate Class thanFormat
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 JavaBeansTM has been added to the
java.beans
package. Please seeXMLEncoder
.- Since:
- 1.4
- See Also:
Format
,Comparable
-
-
Constructor Summary
Constructors Constructor and Description InternationalFormatter()
Creates anInternationalFormatter
with noFormat
specified.InternationalFormatter(Format format)
Creates anInternationalFormatter
with the specifiedFormat
instance.
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Creates a copy of the DefaultFormatter.protected Action[]
getActions()
IfgetSupportsIncrement
returns true, this returns two Actions suitable for incrementing/decrementing the value.Format.Field[]
getFields(int offset)
Returns theFormat.Field
constants associated with the text atoffset
.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 theDefaultFormatter
onto a particularJFormattedTextField
.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 theObject
representation of theString
text
.String
valueToString(Object value)
Returns a String representation of the Objectvalue
.-
Methods inherited from class javax.swing.text.DefaultFormatter
getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getNavigationFilter, getOverwriteMode, getValueClass, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass
-
Methods inherited from class javax.swing.JFormattedTextField.AbstractFormatter
getFormattedTextField, invalidEdit, setEditValid, uninstall
-
-
-
-
Constructor Detail
-
InternationalFormatter
public InternationalFormatter()
Creates anInternationalFormatter
with noFormat
specified.
-
InternationalFormatter
public InternationalFormatter(Format format)
Creates anInternationalFormatter
with the specifiedFormat
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 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:
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 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:
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 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
public String valueToString(Object value) throws ParseException
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
public Object stringToValue(String text) throws ParseException
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
public Format.Field[] getFields(int offset)
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
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()
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
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 16:23:09 Cette version de la page est en cache (à la date du 05/11/2024 16:23:09) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 01/09/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/text/InternationalFormatter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.