- java.lang.Object
-
- javax.swing.JFormattedTextField.AbstractFormatter
-
- javax.swing.text.DefaultFormatter
-
- javax.swing.text.InternationalFormatter
-
- javax.swing.text.NumberFormatter
-
- All Implemented Interfaces:
- Serializable, Cloneable
public class NumberFormatter extends InternationalFormatter
NumberFormatter
subclassesInternationalFormatter
adding special behavior for numbers. Among the specializations are (these are only used if theNumberFormatter
does not display invalid nubers, egsetAllowsInvalid(false)
):- Pressing +/- (- is determined from the
DecimalFormatSymbols
associated with theDecimalFormat
) in any field but the exponent field will attempt to change the sign of the number to positive/negative. - Pressing +/- (- is determined from the
DecimalFormatSymbols
associated with theDecimalFormat
) in the exponent field will attemp to change the sign of the exponent to positive/negative.
If you are displaying scientific numbers, you may wish to turn on overwrite mode,
setOverwriteMode(true)
. For example:DecimalFormat decimalFormat = new DecimalFormat("0.000E0"); NumberFormatter textFormatter = new NumberFormatter(decimalFormat); textFormatter.setOverwriteMode(true); textFormatter.setAllowsInvalid(false);
If you are going to allow the user to enter decimal values, you should either force the DecimalFormat to contain at least one decimal (
#.0###
), or allow the value to be invalidsetAllowsInvalid(true)
. Otherwise users may not be able to input decimal values.NumberFormatter
provides slightly different behavior tostringToValue
than that of its superclass. If you have specified a Class for values,DefaultFormatter.setValueClass(java.lang.Class<?>)
, that is one of ofInteger
,Long
,Float
,Double
,Byte
orShort
and the Format'sparseObject
returns an instance ofNumber
, the corresponding instance of the value class will be created using the constructor appropriate for the primitive type the value class represents. For example:setValueClass(Integer.class)
will cause the resulting value to be created vianew Integer(((Number)formatter.parseObject(string)).intValue())
. This is typically useful if you wish to set a min/max value as the variousNumber
implementations are generally not comparable to each other. This is also useful if for some reason you need a specificNumber
implementation for your values.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
-
-
Constructor Summary
Constructors Constructor and Description NumberFormatter()
Creates aNumberFormatter
with the a defaultNumberFormat
instance obtained fromNumberFormat.getNumberInstance()
.NumberFormatter(NumberFormat format)
Creates a NumberFormatter with the specified Format instance.
-
Method Summary
Methods Modifier and Type Method and Description void
setFormat(Format format)
Sets the format that dictates the legal values that can be edited and displayed.-
Methods inherited from class javax.swing.text.InternationalFormatter
clone, getActions, getFields, getFormat, getMaximum, getMinimum, install, setMaximum, setMinimum, stringToValue, valueToString
-
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
-
NumberFormatter
public NumberFormatter()
Creates aNumberFormatter
with the a defaultNumberFormat
instance obtained fromNumberFormat.getNumberInstance()
.
-
NumberFormatter
public NumberFormatter(NumberFormat format)
Creates a NumberFormatter with the specified Format instance.- Parameters:
format
- Format used to dictate legal values
-
-
Method Detail
-
setFormat
public void setFormat(Format format)
Sets the format that dictates the legal values that can be edited and displayed.If you have used the nullary constructor the value of this property will be determined for the current locale by way of the
NumberFormat.getNumberInstance()
method.- Overrides:
setFormat
in classInternationalFormatter
- Parameters:
format
- NumberFormat instance used to dictate legal values
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/text/numberformatter.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.