DefaultFormatterFactory (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.swing.JFormattedTextField.AbstractFormatterFactory
  • • javax.swing.text.DefaultFormatterFactory

• All Implemented Interfaces:
  Serializable

public class DefaultFormatterFactory
extends JFormattedTextField.AbstractFormatterFactory
implements Serializable
An implementation ofJFormattedTextField.AbstractFormatterFactory.DefaultFormatterFactory allows specifying a number of different JFormattedTextField.AbstractFormatters that are to be used. The most important one is the default one (setDefaultFormatter). The default formatter will be used if a more specific formatter could not be found. The following process is used to determine the appropriate formatter to use.

1. Is the passed in value null? Use the null formatter.
2. Does the JFormattedTextField have focus? Use the edit formatter.
3. Otherwise, use the display formatter.
4. If a non-null AbstractFormatter has not been found, use the default formatter.
   The following code shows how to configure aJFormattedTextField with twoJFormattedTextField.AbstractFormatters, one for display and one for editing.
   JFormattedTextField.AbstractFormatter editFormatter = ...;
   JFormattedTextField.AbstractFormatter displayFormatter = ...;
   DefaultFormatterFactory factory = new DefaultFormatterFactory(
   displayFormatter, displayFormatter, editFormatter);

JFormattedTextField tf = new JFormattedTextField(factory);

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:
JFormattedTextField

• • Constructor Summary

  Constructors

  Constructor	Description
  DefaultFormatterFactory()
  DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat)	Creates a DefaultFormatterFactory with the specifiedJFormattedTextField.AbstractFormatter.
  DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat,JFormattedTextField.AbstractFormatter displayFormat)	Creates a DefaultFormatterFactory with the specifiedJFormattedTextField.AbstractFormatters.
  DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat,JFormattedTextField.AbstractFormatter displayFormat,JFormattedTextField.AbstractFormatter editFormat)	Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.
  DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat,JFormattedTextField.AbstractFormatter displayFormat,JFormattedTextField.AbstractFormatter editFormat,JFormattedTextField.AbstractFormatter nullFormat)	Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  JFormattedTextField.AbstractFormatter	getDefaultFormatter()	Returns the JFormattedTextField.AbstractFormatter to use as a last resort, eg in case a display, edit or nullJFormattedTextField.AbstractFormatter has not been specified.
  JFormattedTextField.AbstractFormatter	getDisplayFormatter()	Returns the JFormattedTextField.AbstractFormatter to use if the JFormattedTextField is not being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.
  JFormattedTextField.AbstractFormatter	getEditFormatter()	Returns the JFormattedTextField.AbstractFormatter to use if the JFormattedTextField is being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.
  JFormattedTextField.AbstractFormatter	getFormatter(JFormattedTextField source)	Returns either the default formatter, display formatter, editor formatter or null formatter based on the state of the JFormattedTextField.
  JFormattedTextField.AbstractFormatter	getNullFormatter()	Returns the formatter to use if the value is null.
  void	setDefaultFormatter(JFormattedTextField.AbstractFormatter atf)	Sets the JFormattedTextField.AbstractFormatter to use as a last resort, eg in case a display, edit or nullJFormattedTextField.AbstractFormatter has not been specified.
  void	setDisplayFormatter(JFormattedTextField.AbstractFormatter atf)	Sets the JFormattedTextField.AbstractFormatter to use if the JFormattedTextField is not being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.
  void	setEditFormatter(JFormattedTextField.AbstractFormatter atf)	Sets the JFormattedTextField.AbstractFormatter to use if the JFormattedTextField is being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.
  void	setNullFormatter(JFormattedTextField.AbstractFormatter atf)	Sets the formatter to use if the value of the JFormattedTextField is null.

     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### DefaultFormatterFactory  
     public DefaultFormatterFactory()  
     * #### DefaultFormatterFactory  
     public DefaultFormatterFactory([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") defaultFormat)  
     Creates a `DefaultFormatterFactory` with the specified`JFormattedTextField.AbstractFormatter`.  
     Parameters:  
     `defaultFormat` \- JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.  
     * #### DefaultFormatterFactory  
     public DefaultFormatterFactory([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") defaultFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") displayFormat)  
     Creates a `DefaultFormatterFactory` with the specified`JFormattedTextField.AbstractFormatter`s.  
     Parameters:  
     `defaultFormat` \- JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.  
     `displayFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.  
     * #### DefaultFormatterFactory  
     public DefaultFormatterFactory([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") defaultFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") displayFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") editFormat)  
     Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.  
     Parameters:  
     `defaultFormat` \- JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.  
     `displayFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.  
     `editFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus.  
     * #### DefaultFormatterFactory  
     public DefaultFormatterFactory([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") defaultFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") displayFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") editFormat,  
                                    [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") nullFormat)  
     Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.  
     Parameters:  
     `defaultFormat` \- JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.  
     `displayFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.  
     `editFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus.  
     `nullFormat` \- JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has a null value.  

  • Method Detail

    * #### setDefaultFormatter  
    public void setDefaultFormatter([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") atf)  
    Sets the `JFormattedTextField.AbstractFormatter` to use as a last resort, eg in case a display, edit or null`JFormattedTextField.AbstractFormatter` has not been specified.  
    Parameters:  
    `atf` \- JFormattedTextField.AbstractFormatter used if a more specific is not specified  
    * #### getDefaultFormatter  
    public [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") getDefaultFormatter()  
    Returns the `JFormattedTextField.AbstractFormatter` to use as a last resort, eg in case a display, edit or null`JFormattedTextField.AbstractFormatter` has not been specified.  
    Returns:  
    JFormattedTextField.AbstractFormatter used if a more specific one is not specified.  
    * #### setDisplayFormatter  
    public void setDisplayFormatter([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") atf)  
    Sets the `JFormattedTextField.AbstractFormatter` to use if the `JFormattedTextField` is not being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.  
    Parameters:  
    `atf` \- JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus  
    * #### getDisplayFormatter  
    public [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") getDisplayFormatter()  
    Returns the `JFormattedTextField.AbstractFormatter` to use if the `JFormattedTextField` is not being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.  
    Returns:  
    JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus  
    * #### setEditFormatter  
    public void setEditFormatter([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") atf)  
    Sets the `JFormattedTextField.AbstractFormatter` to use if the `JFormattedTextField` is being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.  
    Parameters:  
    `atf` \- JFormattedTextField.AbstractFormatter to use when the component has focus  
    * #### getEditFormatter  
    public [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") getEditFormatter()  
    Returns the `JFormattedTextField.AbstractFormatter` to use if the `JFormattedTextField` is being edited and either the value is not-null, or the value is null and a null formatter has has not been specified.  
    Returns:  
    JFormattedTextField.AbstractFormatter to use when the component has focus  
    * #### setNullFormatter  
    public void setNullFormatter([JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") atf)  
    Sets the formatter to use if the value of the JFormattedTextField is null.  
    Parameters:  
    `atf` \- JFormattedTextField.AbstractFormatter to use when the value of the JFormattedTextField is null.  
    * #### getNullFormatter  
    public [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") getNullFormatter()  
    Returns the formatter to use if the value is null.  
    Returns:  
    JFormattedTextField.AbstractFormatter to use when the value is null  
    * #### getFormatter  
    public [JFormattedTextField.AbstractFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatter.html "class in javax.swing") getFormatter([JFormattedTextField](../../../javax/swing/JFormattedTextField.html "class in javax.swing") source)  
    Returns either the default formatter, display formatter, editor formatter or null formatter based on the state of the JFormattedTextField.  
    Specified by:  
    `[getFormatter](../../../javax/swing/JFormattedTextField.AbstractFormatterFactory.html#getFormatter-javax.swing.JFormattedTextField-)` in class `[JFormattedTextField.AbstractFormatterFactory](../../../javax/swing/JFormattedTextField.AbstractFormatterFactory.html "class in javax.swing")`  
    Parameters:  
    `source` \- JFormattedTextField requesting JFormattedTextField.AbstractFormatter  
    Returns:  
    JFormattedTextField.AbstractFormatter to handle formatting duties.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.