javax.swing.text

Class MaskFormatter

java.lang.Object

javax.swing.JFormattedTextField.AbstractFormatter

javax.swing.text.DefaultFormatter

javax.swing.text.MaskFormatter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MaskFormatter
extends DefaultFormatter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MaskFormatter()
MaskFormatter(java.lang.String mask) Creates a MaskFormatter with the specified mask.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInvalidCharacters() Returns a String containing the characters that are not valid for input for this MaskFormatter.
java.lang.String	getMask() Returns the mask used in this MaskFormatter.
java.lang.String	getPlaceholder() Returns the place holder String that is used in place of missing characters when the value doesn't completely fill in the spaces in the mask.
char	getPlaceholderCharacter() Returns the character used in place of missing characters when the value doesn't completely fill the mask.
java.lang.String	getValidCharacters() Returns a String containing the characters that are valid for input for this MaskFormatter.
boolean	getValueContainsLiteralCharacters() Returns true if stringToValue should return the literal characters in the mask.
void	install(javax.swing.JFormattedTextField ftf) Installs this MaskFormatter on the JFormattedTextField.
void	setInvalidCharacters(java.lang.String invalidCharacters) Sets characters that are not valid for input.
void	setMask(java.lang.String mask) Sets the mask for this MaskFormatter.
void	setPlaceholder(java.lang.String placeholder) Sets the string to use if the value does not completely fill in the mask.
void	setPlaceholderCharacter(char placeholder) Sets the char to use if the value does not completely fill in the mask.
void	setValidCharacters(java.lang.String validCharacters) Sets characters that are valid for input.
void	setValueContainsLiteralCharacters(boolean containsLiteralChars) Determines whether stringToValue will return literal characters or not.
java.lang.Object	stringToValue(java.lang.String value) Parses the text using the mask, valid characters, and invalid characters to determine the appropriate Object to return.
java.lang.String	valueToString(java.lang.Object value) Returns a String representation of the Object value based on the mask.

Methods inherited from class javax.swing.text.DefaultFormatter

clone, getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getOverwriteMode, getValueClass, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass

Methods inherited from class javax.swing.JFormattedTextField.AbstractFormatter

getActions, getFormattedTextField, getNavigationFilter, invalidEdit, setEditValid, uninstall

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaskFormatter

public MaskFormatter()

MaskFormatter

public MaskFormatter(java.lang.String mask)
              throws java.text.ParseException

Creates a MaskFormatter with the specified mask.

Parameters:

mask -

Throws:

java.text.ParseException

Method Detail

getMask

public java.lang.String getMask()

Returns the mask used in this MaskFormatter.

Returns:

the mask used in this MaskFormatter.

getInvalidCharacters

public java.lang.String getInvalidCharacters()

Returns a String containing the characters that are not valid for input for this MaskFormatter.

Returns:

a String containing the invalid characters.

setInvalidCharacters

public void setInvalidCharacters(java.lang.String invalidCharacters)

Sets characters that are not valid for input. If invalidCharacters is non-null then no characters contained in it will be allowed to be input.

Parameters:

invalidCharacters - the String specifying invalid characters.

getValidCharacters

public java.lang.String getValidCharacters()

Returns a String containing the characters that are valid for input for this MaskFormatter.

Returns:

a String containing the valid characters.

setValidCharacters

public void setValidCharacters(java.lang.String validCharacters)

Sets characters that are valid for input. If validCharacters is non-null then no characters that are not contained in it will be allowed to be input.

Parameters:

validCharacters - the String specifying valid characters.

getPlaceholder

public java.lang.String getPlaceholder()

Returns the place holder String that is used in place of missing characters when the value doesn't completely fill in the spaces in the mask.

Returns:

the place holder String.

setPlaceholder

public void setPlaceholder(java.lang.String placeholder)

Sets the string to use if the value does not completely fill in the mask. If this is null, the place holder character will be used instead.

Parameters:

placeholder - the String to use if the value doesn't completely fill in the mask.

getPlaceholderCharacter

public char getPlaceholderCharacter()

Returns the character used in place of missing characters when the value doesn't completely fill the mask.

Returns:

the place holder character

setPlaceholderCharacter

public void setPlaceholderCharacter(char placeholder)

Sets the char to use if the value does not completely fill in the mask. This is only used if the place holder String has not been set or does not completely fill in the mask.

Parameters:

placeholder - the char to use if the value doesn't completely fill in the mask.

getValueContainsLiteralCharacters

public boolean getValueContainsLiteralCharacters()

Returns true if stringToValue should return the literal characters in the mask.

Returns:

true if stringToValue should return the literal characters in the mask

setValueContainsLiteralCharacters

public void setValueContainsLiteralCharacters(boolean containsLiteralChars)

Determines whether stringToValue will return literal characters or not.

Parameters:

containsLiteralChars - if true, stringToValue will return the literal characters in the mask, otherwise it will not.

setMask

public void setMask(java.lang.String mask)
             throws java.text.ParseException

Sets the mask for this MaskFormatter.

Parameters:

mask - the new mask for this MaskFormatter

Throws:

java.text.ParseException - if mask is not valid.

install

public void install(javax.swing.JFormattedTextField ftf)

Installs this MaskFormatter on the JFormattedTextField. Invokes valueToString to convert the current value from the JFormattedTextField to a String, then installs the Actions from getActions, the DocumentFilter from getDocumentFilter, and the NavigationFilter from getNavigationFilter. If valueToString throws a ParseException, this method sets the text to an empty String and marks the JFormattedTextField as invalid.

Overrides:

install in class DefaultFormatter

Parameters:

ftf - the JFormattedTextField in which this formatter is installed

stringToValue

public java.lang.Object stringToValue(java.lang.String value)
                               throws java.text.ParseException

Parses the text using the mask, valid characters, and invalid characters to determine the appropriate Object to return. This strips the literal characters if necessary and invokes super.stringToValue. If the paramter is invalid for the current mask and valid/invalid character sets this method will throw a ParseException.

Overrides:

stringToValue in class DefaultFormatter

Parameters:

value - the String to parse

Returns:

the value for the string

Throws:

java.text.ParseException - if value doesn't match the mask and valid/invalid character sets

valueToString

public java.lang.String valueToString(java.lang.Object value)
                               throws java.text.ParseException

Returns a String representation of the Object value based on the mask.

Overrides:

valueToString in class DefaultFormatter

Parameters:

value - the value to convert

Returns:

the string representation of the value

Throws:

java.text.ParseException - if value is invalid for this mask and valid/invalid character sets