OpenJDK 27 · javax.swing.text.DefaultFormatterFactory

An implementation of JFormattedTextField.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.

Is the passed in value null? Use the null formatter.
Does the JFormattedTextField have focus? Use the edit formatter.
Otherwise, use the display formatter.
If a non-null AbstractFormatter has not been found, use the default formatter.

The following code shows how to configure a JFormattedTextField with two JFormattedTextField.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 java.beans.XMLEncoder.

Modifier and Type	Field and Description
private JFormattedTextField.AbstractFormatter	defaultFormat Default `AbstractFormatter` to use if a more specific one has not been specified.
private JFormattedTextField.AbstractFormatter	displayFormat `JFormattedTextField.AbstractFormatter` to use for display.
private JFormattedTextField.AbstractFormatter	editFormat `JFormattedTextField.AbstractFormatter` to use for editing.
private JFormattedTextField.AbstractFormatter	nullFormat `JFormattedTextField.AbstractFormatter` to use if the value is null.

Constructor Summary

Access	Constructor and Description
public	DefaultFormatterFactory() Constructs a `DefaultFormatterFactory`.
public	DefaultFormatterFactory(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. defaultFormat) Creates a `DefaultFormatterFactory` with the specified `JFormattedTextField.AbstractFormatter`.
public	DefaultFormatterFactory(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. defaultFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus. displayFormat) Creates a `DefaultFormatterFactory` with the specified `JFormattedTextField.AbstractFormatter`s.
public	DefaultFormatterFactory(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. defaultFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus. displayFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus. editFormat) Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.
public	DefaultFormatterFactory(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. defaultFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus. displayFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus. editFormat, JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has a null value. nullFormat) Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.

Method Summary

Modifier and Type	Method and Description
public JFormattedTextField.AbstractFormatter	Returns: JFormattedTextField.AbstractFormatter used if a more specific one is not specified. 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.
public JFormattedTextField.AbstractFormatter	Returns: JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus 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.
public JFormattedTextField.AbstractFormatter	Returns: JFormattedTextField.AbstractFormatter to use when the component has focus 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.
public JFormattedTextField.AbstractFormatter	Returns: JFormattedTextField.AbstractFormatter to handle formatting duties. getFormatter(JFormattedTextField JFormattedTextField requesting JFormattedTextField.AbstractFormatter source) Implements abstract javax.swing.JFormattedTextField.AbstractFormatterFactory.getFormatter. Returns either the default formatter, display formatter, editor formatter or null formatter based on the state of the JFormattedTextField.
public JFormattedTextField.AbstractFormatter	Returns: JFormattedTextField.AbstractFormatter to use when the value is null getNullFormatter() Returns the formatter to use if the value is null.
public void	setDefaultFormatter(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter used if a more specific is not specified 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.
public void	setDisplayFormatter(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus 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.
public void	setEditFormatter(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the component has focus 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.
public void	setNullFormatter(JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the value of the JFormattedTextField is null. atf) Sets the formatter to use if the value of the JFormattedTextField is null.

Field Detail

defaultFormat	back to summary
private JFormattedTextField.AbstractFormatter defaultFormat Default `AbstractFormatter` to use if a more specific one has not been specified.

displayFormat	back to summary
private JFormattedTextField.AbstractFormatter displayFormat `JFormattedTextField.AbstractFormatter` to use for display.

editFormat	back to summary
private JFormattedTextField.AbstractFormatter editFormat `JFormattedTextField.AbstractFormatter` to use for editing.

nullFormat	back to summary
private JFormattedTextField.AbstractFormatter nullFormat `JFormattedTextField.AbstractFormatter` to use if the value is null.

Constructor Detail

DefaultFormatterFactory	back to summary
public DefaultFormatterFactory() Constructs a `DefaultFormatterFactory`.

DefaultFormatterFactory back to summary

DefaultFormatterFactory	back to summary
public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat) Creates a `DefaultFormatterFactory` with the specified `JFormattedTextField.AbstractFormatter`. Parameters defaultFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.

public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat)

Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatter.

Parameters

defaultFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.

DefaultFormatterFactory back to summary

DefaultFormatterFactory	back to summary
public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat) Creates a `DefaultFormatterFactory` with the specified `JFormattedTextField.AbstractFormatter`s. Parameters defaultFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. displayFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.

public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat)

Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.

Parameters

defaultFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.
displayFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.

DefaultFormatterFactory	back to summary
public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat, JFormattedTextField.AbstractFormatter editFormat) Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters. Parameters defaultFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. displayFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus. editFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus.

DefaultFormatterFactory

back to summary

public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat, JFormattedTextField.AbstractFormatter editFormat)

Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.

Parameters

defaultFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.
displayFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.
editFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus.

DefaultFormatterFactory	back to summary
public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat, JFormattedTextField.AbstractFormatter editFormat, JFormattedTextField.AbstractFormatter nullFormat) Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters. Parameters defaultFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found. displayFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus. editFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus. nullFormat:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has a null value.

DefaultFormatterFactory

back to summary

public DefaultFormatterFactory(JFormattedTextField.AbstractFormatter defaultFormat, JFormattedTextField.AbstractFormatter displayFormat, JFormattedTextField.AbstractFormatter editFormat, JFormattedTextField.AbstractFormatter nullFormat)

Creates a DefaultFormatterFactory with the specified JFormattedTextField.AbstractFormatters.

Parameters

defaultFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used if a more specific JFormattedTextField.AbstractFormatter can not be found.
displayFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField does not have focus.
editFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has focus.
nullFormat:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to be used when the JFormattedTextField has a null value.

Method Detail

getDefaultFormatter back to summary

getDefaultFormatter	back to summary
public JFormattedTextField.AbstractFormatter 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 JFormattedTextField.AbstractFormatter used if a more specific one is not specified.

public JFormattedTextField.AbstractFormatter 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: JFormattedTextField.AbstractFormatter used if a more specific one is not specified.

getDisplayFormatter back to summary

getDisplayFormatter	back to summary
public 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. Returns:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus

public 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.

Returns:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus

getEditFormatter back to summary

getEditFormatter	back to summary
public 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. Returns:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the component has focus

public 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.

Returns:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the component has focus

getFormatter	back to summary
public JFormattedTextField.AbstractFormatter getFormatter(JFormattedTextField source) Implements abstract javax.swing.JFormattedTextField.AbstractFormatterFactory.getFormatter. Returns either the default formatter, display formatter, editor formatter or null formatter based on the state of the JFormattedTextField. Parameters source:JFormattedTextField JFormattedTextField requesting JFormattedTextField.AbstractFormatter Returns:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to handle formatting duties.

getFormatter

back to summary

public JFormattedTextField.AbstractFormatter getFormatter(JFormattedTextField source)

Implements abstract javax.swing.JFormattedTextField.AbstractFormatterFactory.getFormatter.

Returns either the default formatter, display formatter, editor formatter or null formatter based on the state of the JFormattedTextField.

Parameters

source:JFormattedTextField: JFormattedTextField requesting JFormattedTextField.AbstractFormatter

Returns:JFormattedTextField.AbstractFormatter

JFormattedTextField.AbstractFormatter to handle formatting duties.

getNullFormatter	back to summary
public JFormattedTextField.AbstractFormatter getNullFormatter() Returns the formatter to use if the value is null. Returns:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the value is null

getNullFormatter

back to summary

public JFormattedTextField.AbstractFormatter getNullFormatter()

Returns the formatter to use if the value is null.

Returns:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the value is null

setDefaultFormatter back to summary

setDefaultFormatter	back to summary
public void setDefaultFormatter(JFormattedTextField.AbstractFormatter 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 JFormattedTextField.AbstractFormatter used if a more specific is not specified

public void setDefaultFormatter(JFormattedTextField.AbstractFormatter 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: JFormattedTextField.AbstractFormatter used if a more specific is not specified

setDisplayFormatter back to summary

setDisplayFormatter	back to summary
public 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. Parameters atf:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus

public 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.

Parameters

atf:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the JFormattedTextField does not have focus

setEditFormatter back to summary

setEditFormatter	back to summary
public 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. Parameters atf:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the component has focus

public 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.

Parameters

atf:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the component has focus

setNullFormatter	back to summary
public void setNullFormatter(JFormattedTextField.AbstractFormatter atf) Sets the formatter to use if the value of the JFormattedTextField is null. Parameters atf:JFormattedTextField.AbstractFormatter JFormattedTextField.AbstractFormatter to use when the value of the JFormattedTextField is null.

setNullFormatter

back to summary

public void setNullFormatter(JFormattedTextField.AbstractFormatter atf)

Sets the formatter to use if the value of the JFormattedTextField is null.

Parameters

atf:JFormattedTextField.AbstractFormatter: JFormattedTextField.AbstractFormatter to use when the value of the JFormattedTextField is null.

public Class DefaultFormatterFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail