com.jgoodies.binding.formatter
Class EmptyNumberFormatter

java.lang.Object
  extended by javax.swing.JFormattedTextField.AbstractFormatter
      extended by javax.swing.text.DefaultFormatter
          extended by javax.swing.text.InternationalFormatter
              extended by javax.swing.text.NumberFormatter
                  extended by com.jgoodies.binding.formatter.EmptyNumberFormatter
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class EmptyNumberFormatter
extends javax.swing.text.NumberFormatter

In addition to its superclass NumberFormatter, this class converts to/from the empty string. Therefore it holds an empty value that is the counterpart of the empty string. The Method #valueToString converts the empty value to the empty string. And #stringToValue converts blank strings to the empty value. In all other cases the conversion is delegated to its superclass.

Often the empty value is null or -1. Examples:

 new EmptyNumberFormatter();
 new EmptyNumberFormatter(-1);
 

Version:
$Revision: 1.6 $
Author:
Karsten Lentzsch
See Also:
Format, Serialized Form

Constructor Summary
EmptyNumberFormatter()
          Constructs an EmptyNumberFormatter that converts null to the empty string and vice versa.
EmptyNumberFormatter(java.lang.Number emptyValue)
          Constructs an EmptyNumberFormatter that converts the given emptyValue to the empty string and vice versa.
EmptyNumberFormatter(java.text.NumberFormat format)
          Constructs an EmptyNumberFormatter configured with the specified Format; converts null to the empty string and vice versa.
EmptyNumberFormatter(java.text.NumberFormat format, java.lang.Number emptyValue)
          Constructs an EmptyNumberFormatter configured with the specified Format; converts null to the given emptyValue and vice versa.
 
Method Summary
 java.lang.Object stringToValue(java.lang.String text)
          Returns the Object representation of the String text.
 java.lang.String valueToString(java.lang.Object value)
          Returns a String representation of the Object value.
 
Methods inherited from class javax.swing.text.NumberFormatter
setFormat
 
Methods inherited from class javax.swing.text.InternationalFormatter
clone, getActions, getFields, getFormat, getMaximum, getMinimum, install, setMaximum, setMinimum
 
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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmptyNumberFormatter

public EmptyNumberFormatter()
Constructs an EmptyNumberFormatter that converts null to the empty string and vice versa.


EmptyNumberFormatter

public EmptyNumberFormatter(java.text.NumberFormat format)
Constructs an EmptyNumberFormatter configured with the specified Format; converts null to the empty string and vice versa.

Parameters:
format - Format used to dictate legal values

EmptyNumberFormatter

public EmptyNumberFormatter(java.lang.Number emptyValue)
Constructs an EmptyNumberFormatter that converts the given emptyValue to the empty string and vice versa.

Parameters:
emptyValue - the representation of the empty string

EmptyNumberFormatter

public EmptyNumberFormatter(java.text.NumberFormat format,
                            java.lang.Number emptyValue)
Constructs an EmptyNumberFormatter configured with the specified Format; converts null to the given emptyValue and vice versa.

Parameters:
format - Format used to dictate legal values
emptyValue - the representation of the empty string
Method Detail

stringToValue

public java.lang.Object stringToValue(java.lang.String text)
                               throws java.text.ParseException
Returns the Object representation of the String text.

Unlike its superclass, this class converts blank strings to the empty value.

Overrides:
stringToValue in class javax.swing.text.InternationalFormatter
Parameters:
text - String to convert
Returns:
Object representation of text
Throws:
java.text.ParseException - if there is an error in the conversion

valueToString

public java.lang.String valueToString(java.lang.Object value)
                               throws java.text.ParseException
Returns a String representation of the Object value. This invokes format on the current Format.

Unlike its superclass, this class converts the empty value to the empty string.

Overrides:
valueToString in class javax.swing.text.InternationalFormatter
Parameters:
value - the value to convert
Returns:
a String representation of value
Throws:
java.text.ParseException - if there is an error in the conversion


Copyright © 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.