MaskFormatter is used to format and edit strings. The behavior of a MaskFormatter is controlled by way of a String mask that specifies the valid characters that can be contained at a particular location in the Document model. The following characters can be specified:

Valid characters and their descriptions
Character	Description
#	Any valid number, uses `Character.isDigit`.
'	Escape character, used to escape any of the special formatting characters.
U	Any character (`Character.isLetter`). All lowercase letters are mapped to upper case.
L	Any character (`Character.isLetter`). All upper case letters are mapped to lower case.
A	Any character or number (`Character.isLetter` or `Character.isDigit`).
?	Any character (`Character.isLetter`).
*	Anything.
H	Any hex character (0-9, a-f or A-F).

Typically characters correspond to one char, but in certain languages this is not the case. The mask is on a per character basis, and will thus adjust to fit as many chars as are needed.

You can further restrict the characters that can be input by the setInvalidCharacters and setValidCharacters methods. setInvalidCharacters allows you to specify which characters are not legal. setValidCharacters allows you to specify which characters are valid. For example, the following code block is equivalent to a mask of '0xHHH' with no invalid/valid characters:

MaskFormatter formatter = new MaskFormatter("0x***");
formatter.setValidCharacters("0123456789abcdefABCDEF");

When initially formatting a value if the length of the string is less than the length of the mask, two things can happen. Either the placeholder string will be used, or the placeholder character will be used. Precedence is given to the placeholder string. For example:

  MaskFormatter formatter = new MaskFormatter("###-####");
  formatter.setPlaceholderCharacter('_');
  System.out.println(formatter.valueToString("123"));

Would result in the string '123-____'. If setPlaceholder("555-1212") was invoked '123-1212' would result. The placeholder String is only used on the initial format, on subsequent formats only the placeholder character will be used.

If a MaskFormatter is configured to only allow valid characters (setAllowsInvalid(false)) literal characters will be skipped as necessary when editing. Consider a MaskFormatter with the mask "###-####" and current value "555-1212". Using the right arrow key to navigate through the field will result in (| indicates the position of the caret):

The '-' is a literal (non-editable) character, and is skipped.

Similar behavior will result when editing. Consider inserting the string '123-45' and '12345' into the MaskFormatter in the previous example. Both inserts will result in the same String, '123-45__'. When MaskFormatter is processing the insert at character position 3 (the '-'), two things can happen:

If the inserted character is '-', it is accepted.
If the inserted character matches the mask for the next non-literal character, it is accepted at the new location.
Anything else results in an invalid edit

By default MaskFormatter will not allow invalid edits, you can change this with the setAllowsInvalid method, and will commit edits on valid edits (use the setCommitsOnValidEdit to change this).

By default, MaskFormatter is in overwrite mode. That is as characters are typed a new character is not inserted, rather the character at the current location is replaced with the newly typed character. You can change this behavior by way of the method setOverwriteMode.

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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	MaskFormatter.AlphaNumericCharacter Represents either a character or digit, uses `Character.isLetterOrDigit`.
private class	MaskFormatter.CharCharacter Represents a letter, uses `Character.isLetter`.
private class	MaskFormatter.DigitMaskCharacter Represents a number, uses `Character.isDigit`.
private class	MaskFormatter.HexCharacter Represents a hex character, 0-9a-fA-F. a-f is mapped to A-F
private class	MaskFormatter.LiteralCharacter Used to represent a fixed character in the mask.
private class	MaskFormatter.LowerCaseCharacter Represents a character, upper case letters are mapped to lower case using `Character.toLowerCase`.
private class	MaskFormatter.MaskCharacter
private class	MaskFormatter.UpperCaseCharacter Represents a character, lower case letters are mapped to upper case using `Character.toUpperCase`.

Field Summary

Modifier and Type	Field and Description
private static final char	ALPHA_NUMERIC_KEY
private static final char	ANYTHING_KEY
private static final char	CHARACTER_KEY
private boolean	containsLiteralChars Indicates if the value contains the literal characters.
private static final char	DIGIT_KEY
private static final MaskFormatter.MaskCharacter[]	EmptyMaskChars
private static final char	HEX_KEY
private String	invalidCharacters List of invalid characters.
private static final char	LITERAL_KEY
private static final char	LOWERCASE_KEY
private String	mask The user specified mask.
private transient MaskFormatter.MaskCharacter[]	maskChars
private char	placeholder String used to represent characters not present.
private String	placeholderString String used for the passed in value if it does not completely fill the mask.
private static final char	UPPERCASE_KEY
private String	validCharacters List of valid characters.

Inherited from javax.swing.text.DefaultFormatter:: replaceHolder

Constructor Summary

Access	Constructor and Description
public	MaskFormatter() Creates a MaskFormatter with no mask.
public	MaskFormatter(String the mask mask) Creates a `MaskFormatter` with the specified mask.

Method Summary

Modifier and Type	Method and Description
private void	append(StringBuilder result, String value, int[] index, String placeholder, MaskFormatter.MaskCharacter[] mask) Invokes `append` on the mask characters in `mask`.
pack-priv boolean	canReplace(DefaultFormatter.ReplaceHolder rh) Overrides javax.swing.text.DefaultFormatter.canReplace. This method does the following (assuming !getAllowsInvalid()): iterate over the max of the deleted region or the text length, for each character: If it is valid (matches the mask at the particular position, or matches the literal character at the position), allow it Else if the position identifies a literal character, add it. This allows for the user to paste in text that may/may not contain the literals. For example, in passing in 5551212 into ###-#### when the 1 is evaluated it is illegal (by the first test), but there is a literal at this position (-), so it is used. NOTE: This has a problem that you can't tell (without looking ahead) if you should eat literals in the text. For example, if you paste '555' into #5##, should it result in '5555' or '555 '? The current code will result in the latter, which feels a little better as selecting text than pasting will always result in the same thing. Else if at the end of the inserted text, the replace the item with the placeholder Otherwise the insert is bogus and false is returned.
private char	getCharacter(int index, char aChar) Returns the character to insert at the specified location based on the passed in character.
public String	Returns: illegal characters. getInvalidCharacters() Returns the characters that are not valid for input.
private int	getInvalidOffset(String string, boolean completeMatch) Returns -1 if the passed in string is valid, otherwise the index of the first bogus character is returned.
private char	getLiteral(int index) Returns the literal character at the specified location.
public String	Returns: Mask dictating legal character values. getMask() Returns the formatting mask.
private MaskFormatter.MaskCharacter	getMaskCharacter(int index) Returns the MaskCharacter at the specified location.
private int	getMaxLength() Returns the maximum length the text can be.
public String	Returns: String used when formatting if the value does not completely fill the mask getPlaceholder() Returns the String to use if the value does not completely fill in the mask.
public char	Returns: Character used when formatting if the value does not completely fill the mask getPlaceholderCharacter() Returns the character to use in place of characters that are not present in the value, ie the user must fill them in.
public String	Returns: Legal characters getValidCharacters() Returns the valid characters that can be input.
public boolean	Returns: True if literal characters in mask should be returned in stringToValue getValueContainsLiteralCharacters() Returns true if `stringToValue` should return literal characters in the mask.
public void	install(JFormattedTextField JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField. ftf) Overrides javax.swing.text.DefaultFormatter.install. Installs the `DefaultFormatter` onto a particular `JFormattedTextField`.
private boolean	isLiteral(int index) Returns true if the character at the specified location is a literal, that is it can not be edited.
pack-priv boolean	isNavigatable(int offset) Overrides javax.swing.text.DefaultFormatter.isNavigatable. Returns true if the MaskFormatter allows invalid, or the offset is less than the max length and the character at `offset` is a literal.
private boolean	isPlaceholder(int index, char aChar) Returns true if the placeholder character matches aChar.
private boolean	isValidCharacter(int index, char aChar) Returns true if the passed in character matches the mask at the specified location.
pack-priv boolean	isValidEdit(DefaultFormatter.ReplaceHolder rh) Overrides javax.swing.text.DefaultFormatter.isValidEdit.
private void	readObject(ObjectInputStream s) Subclassed to update the internal representation of the mask after the default read operation has completed.
public void	setInvalidCharacters(String If non-null, specifies illegal characters. invalidCharacters) Allows for further restricting of the characters that can be input.
public void	setMask(String the mask mask) Sets the mask dictating the legal characters.
public void	setPlaceholder(String String used when formatting if the value does not completely fill the mask placeholder) Sets the string to use if the value does not completely fill in the mask.
public void	setPlaceholderCharacter(char Character used when formatting if the value does not completely fill the mask placeholder) Sets the character to use in place of characters that are not present in the value, ie the user must fill them in. The default value is a space.
public void	setValidCharacters(String If non-null, specifies legal characters. validCharacters) Allows for further restricting of the characters that can be input.
public void	setValueContainsLiteralCharacters(boolean Used to indicate if literal characters in mask should be returned in stringToValue containsLiteralChars) If true, the returned value and set value will also contain the literal characters in mask.
public Object	Returns: Object representation of text stringToValue(String String to convert value) Overrides javax.swing.text.DefaultFormatter.stringToValue. Parses the text, returning the appropriate Object representation of the String `value`.
private Object	stringToValue(String value, boolean completeMatch) Actual `stringToValue` implementation.
private String	stripLiteralChars(String string) Removes the literal characters from the passed in string.
private void	updateInternalMask() Updates the internal representation of the mask.
public String	Returns: String representation of value valueToString(Object Value to convert value) Overrides javax.swing.text.DefaultFormatter.valueToString. Returns a String representation of the Object `value` based on the mask.

Field Detail

ALPHA_NUMERIC_KEY	back to summary
private static final char ALPHA_NUMERIC_KEY

ANYTHING_KEY	back to summary
private static final char ANYTHING_KEY

CHARACTER_KEY	back to summary
private static final char CHARACTER_KEY

containsLiteralChars	back to summary
private boolean containsLiteralChars Indicates if the value contains the literal characters.

DIGIT_KEY	back to summary
private static final char DIGIT_KEY

EmptyMaskChars	back to summary
private static final MaskFormatter.MaskCharacter[] EmptyMaskChars

HEX_KEY	back to summary
private static final char HEX_KEY

invalidCharacters	back to summary
private String invalidCharacters List of invalid characters.

LITERAL_KEY	back to summary
private static final char LITERAL_KEY

LOWERCASE_KEY	back to summary
private static final char LOWERCASE_KEY

mask	back to summary
private String mask The user specified mask.

maskChars	back to summary
private transient MaskFormatter.MaskCharacter[] maskChars

placeholder	back to summary
private char placeholder String used to represent characters not present.

placeholderString	back to summary
private String placeholderString String used for the passed in value if it does not completely fill the mask.

UPPERCASE_KEY	back to summary
private static final char UPPERCASE_KEY

validCharacters	back to summary
private String validCharacters List of valid characters.

Constructor Detail

MaskFormatter	back to summary
public MaskFormatter() Creates a MaskFormatter with no mask.

MaskFormatter back to summary

MaskFormatter	back to summary
public MaskFormatter(String mask) throws ParseException Creates a `MaskFormatter` with the specified mask. A `ParseException` will be thrown if `mask` is an invalid mask. Parameters mask:String the mask Exceptions ParseException: if mask does not contain valid mask characters

public MaskFormatter(String mask) throws ParseException

Creates a MaskFormatter with the specified mask. A ParseException will be thrown if mask is an invalid mask.

Parameters

mask:String: the mask

Exceptions

ParseException:: if mask does not contain valid mask characters

Method Detail

append	back to summary
private void append(StringBuilder result, String value, int[] index, String placeholder, MaskFormatter.MaskCharacter[] mask) throws ParseException Invokes `append` on the mask characters in `mask`.

canReplace	back to summary
pack-priv boolean canReplace(DefaultFormatter.ReplaceHolder rh) Overrides javax.swing.text.DefaultFormatter.canReplace. This method does the following (assuming !getAllowsInvalid()): iterate over the max of the deleted region or the text length, for each character: If it is valid (matches the mask at the particular position, or matches the literal character at the position), allow it Else if the position identifies a literal character, add it. This allows for the user to paste in text that may/may not contain the literals. For example, in passing in 5551212 into ###-#### when the 1 is evaluated it is illegal (by the first test), but there is a literal at this position (-), so it is used. NOTE: This has a problem that you can't tell (without looking ahead) if you should eat literals in the text. For example, if you paste '555' into #5##, should it result in '5555' or '555 '? The current code will result in the latter, which feels a little better as selecting text than pasting will always result in the same thing. Else if at the end of the inserted text, the replace the item with the placeholder Otherwise the insert is bogus and false is returned.

canReplace

back to summary

pack-priv boolean canReplace(DefaultFormatter.ReplaceHolder rh)

Overrides javax.swing.text.DefaultFormatter.canReplace.

This method does the following (assuming !getAllowsInvalid()): iterate over the max of the deleted region or the text length, for each character:

If it is valid (matches the mask at the particular position, or matches the literal character at the position), allow it
Else if the position identifies a literal character, add it. This allows for the user to paste in text that may/may not contain the literals. For example, in passing in 5551212 into ###-#### when the 1 is evaluated it is illegal (by the first test), but there is a literal at this position (-), so it is used. NOTE: This has a problem that you can't tell (without looking ahead) if you should eat literals in the text. For example, if you paste '555' into #5##, should it result in '5555' or '555 '? The current code will result in the latter, which feels a little better as selecting text than pasting will always result in the same thing.
Else if at the end of the inserted text, the replace the item with the placeholder
Otherwise the insert is bogus and false is returned.

getCharacter	back to summary
private char getCharacter(int index, char aChar) Returns the character to insert at the specified location based on the passed in character. This provides a way to map certain sets of characters to alternative values (lowercase to uppercase...).

getInvalidCharacters	back to summary
public String getInvalidCharacters() Returns the characters that are not valid for input. Returns:String illegal characters.

getInvalidCharacters

back to summary

public String getInvalidCharacters()

Returns the characters that are not valid for input.

Returns:String: illegal characters.

getInvalidOffset	back to summary
private int getInvalidOffset(String string, boolean completeMatch) Returns -1 if the passed in string is valid, otherwise the index of the first bogus character is returned.

getLiteral	back to summary
private char getLiteral(int index) Returns the literal character at the specified location.

getMask	back to summary
public String getMask() Returns the formatting mask. Returns:String Mask dictating legal character values.

getMask

back to summary

public String getMask()

Returns the formatting mask.

Returns:String: Mask dictating legal character values.

getMaskCharacter	back to summary
private MaskFormatter.MaskCharacter getMaskCharacter(int index) Returns the MaskCharacter at the specified location.

getMaxLength	back to summary
private int getMaxLength() Returns the maximum length the text can be.

getPlaceholder	back to summary
public String getPlaceholder() Returns the String to use if the value does not completely fill in the mask. Returns:String String used when formatting if the value does not completely fill the mask

getPlaceholder

back to summary

public String getPlaceholder()

Returns the String to use if the value does not completely fill in the mask.

Returns:String: String used when formatting if the value does not completely fill the mask

getPlaceholderCharacter	back to summary
public char getPlaceholderCharacter() Returns the character to use in place of characters that are not present in the value, ie the user must fill them in. Returns:char Character used when formatting if the value does not completely fill the mask

getPlaceholderCharacter

back to summary

public char getPlaceholderCharacter()

Returns the character to use in place of characters that are not present in the value, ie the user must fill them in.

Returns:char: Character used when formatting if the value does not completely fill the mask

getValidCharacters	back to summary
public String getValidCharacters() Returns the valid characters that can be input. Returns:String Legal characters

getValidCharacters

back to summary

public String getValidCharacters()

Returns the valid characters that can be input.

Returns:String: Legal characters

getValueContainsLiteralCharacters back to summary

getValueContainsLiteralCharacters	back to summary
public boolean getValueContainsLiteralCharacters() Returns true if `stringToValue` should return literal characters in the mask. Returns:boolean True if literal characters in mask should be returned in stringToValue

public boolean getValueContainsLiteralCharacters()

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

Returns:boolean: True if literal characters in mask should be returned in stringToValue

install back to summary

install	back to summary
public void install(JFormattedTextField ftf) Overrides javax.swing.text.DefaultFormatter.install. Installs the `DefaultFormatter` onto a particular `JFormattedTextField`. This will invoke `valueToString` to convert the current value from the `JFormattedTextField` to a String. This will then install the `Action`s from `getActions`, the `DocumentFilter` returned from `getDocumentFilter` and the `NavigationFilter` returned from `getNavigationFilter` onto the `JFormattedTextField`. Subclasses will typically only need to override this if they wish to install additional listeners on the `JFormattedTextField`. If there is a `ParseException` in converting the current value to a String, this will set the text to an empty String, and mark the `JFormattedTextField` as being in an invalid state. While this is a public method, this is typically only useful for subclassers of `JFormattedTextField`. `JFormattedTextField` will invoke this method at the appropriate times when the value changes, or its internal state changes. Parameters ftf:JFormattedTextField JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.

public void install(JFormattedTextField ftf)

Overrides javax.swing.text.DefaultFormatter.install.

Installs the DefaultFormatter onto a particular JFormattedTextField. This will invoke valueToString to convert the current value from the JFormattedTextField to a String. This will then install the Actions from getActions, the DocumentFilter returned from getDocumentFilter and the NavigationFilter returned from getNavigationFilter onto the JFormattedTextField.

Subclasses will typically only need to override this if they wish to install additional listeners on the JFormattedTextField.

If there is a ParseException in converting the current value to a String, this will set the text to an empty String, and mark the JFormattedTextField as being in an invalid state.

While this is a public method, this is typically only useful for subclassers of JFormattedTextField. JFormattedTextField will invoke this method at the appropriate times when the value changes, or its internal state changes.

Parameters

ftf:JFormattedTextField: JFormattedTextField to format for, may be null indicating uninstall from current JFormattedTextField.

isLiteral	back to summary
private boolean isLiteral(int index) Returns true if the character at the specified location is a literal, that is it can not be edited.

isNavigatable back to summary

isNavigatable	back to summary
pack-priv boolean isNavigatable(int offset) Overrides javax.swing.text.DefaultFormatter.isNavigatable. Returns true if the MaskFormatter allows invalid, or the offset is less than the max length and the character at `offset` is a literal.

pack-priv boolean isNavigatable(int offset)

Overrides javax.swing.text.DefaultFormatter.isNavigatable.

Returns true if the MaskFormatter allows invalid, or the offset is less than the max length and the character at offset is a literal.

isPlaceholder	back to summary
private boolean isPlaceholder(int index, char aChar) Returns true if the placeholder character matches aChar.

isValidCharacter	back to summary
private boolean isValidCharacter(int index, char aChar) Returns true if the passed in character matches the mask at the specified location.

isValidEdit	back to summary
pack-priv boolean isValidEdit(DefaultFormatter.ReplaceHolder rh) Overrides javax.swing.text.DefaultFormatter.isValidEdit.

readObject	back to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Subclassed to update the internal representation of the mask after the default read operation has completed. Annotations @Serial

readObject

back to summary

private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Subclassed to update the internal representation of the mask after the default read operation has completed.

Annotations

@Serial

setInvalidCharacters back to summary

setInvalidCharacters	back to summary
public void setInvalidCharacters(String invalidCharacters) Allows for further restricting of the characters that can be input. Only characters specified in the mask, not in the `invalidCharacters`, and in `validCharacters` will be allowed to be input. Passing in null (the default) implies the valid characters are only bound by the mask and the valid characters. Parameters invalidCharacters:String If non-null, specifies illegal characters.

public void setInvalidCharacters(String invalidCharacters)

Allows for further restricting of the characters that can be input. Only characters specified in the mask, not in the invalidCharacters, and in validCharacters will be allowed to be input. Passing in null (the default) implies the valid characters are only bound by the mask and the valid characters.

Parameters

invalidCharacters:String: If non-null, specifies illegal characters.

setMask back to summary

setMask	back to summary
public void setMask(String mask) throws ParseException Sets the mask dictating the legal characters. This will throw a `ParseException` if `mask` is not valid. Parameters mask:String the mask Exceptions ParseException: if mask does not contain valid mask characters

public void setMask(String mask) throws ParseException

Sets the mask dictating the legal characters. This will throw a ParseException if mask is not valid.

Parameters

mask:String: the mask

Exceptions

ParseException:: if mask does not contain valid mask characters

setPlaceholder	back to summary
public void setPlaceholder(String placeholder) Sets the string to use if the value does not completely fill in the mask. A null value implies the placeholder char should be used. Parameters placeholder:String String used when formatting if the value does not completely fill the mask

setPlaceholder

back to summary

public void setPlaceholder(String placeholder)

Sets the string to use if the value does not completely fill in the mask. A null value implies the placeholder char should be used.

Parameters

placeholder:String: String used when formatting if the value does not completely fill the mask

setPlaceholderCharacter	back to summary
public void setPlaceholderCharacter(char placeholder) Sets the character to use in place of characters that are not present in the value, ie the user must fill them in. The default value is a space. This is only applicable if the placeholder string has not been specified, or does not completely fill in the mask. Parameters placeholder:char Character used when formatting if the value does not completely fill the mask

setPlaceholderCharacter

back to summary

public void setPlaceholderCharacter(char placeholder)

Sets the character to use in place of characters that are not present in the value, ie the user must fill them in. The default value is a space.

This is only applicable if the placeholder string has not been specified, or does not completely fill in the mask.

Parameters

placeholder:char: Character used when formatting if the value does not completely fill the mask

setValidCharacters back to summary

setValidCharacters	back to summary
public void setValidCharacters(String validCharacters) Allows for further restricting of the characters that can be input. Only characters specified in the mask, not in the `invalidCharacters`, and in `validCharacters` will be allowed to be input. Passing in null (the default) implies the valid characters are only bound by the mask and the invalid characters. Parameters validCharacters:String If non-null, specifies legal characters.

public void setValidCharacters(String validCharacters)

Parameters

validCharacters:String: If non-null, specifies legal characters.

setValueContainsLiteralCharacters back to summary

setValueContainsLiteralCharacters	back to summary
public void setValueContainsLiteralCharacters(boolean containsLiteralChars) If true, the returned value and set value will also contain the literal characters in mask. For example, if the mask is `'(###) ###-####'`, the current value is `'(415) 555-1212'`, and `valueContainsLiteralCharacters` is true `stringToValue` will return `'(415) 555-1212'`. On the other hand, if `valueContainsLiteralCharacters` is false, `stringToValue` will return `'4155551212'`. Parameters containsLiteralChars:boolean Used to indicate if literal characters in mask should be returned in stringToValue

public void setValueContainsLiteralCharacters(boolean containsLiteralChars)

If true, the returned value and set value will also contain the literal characters in mask.

For example, if the mask is '(###) ###-####', the current value is '(415) 555-1212', and valueContainsLiteralCharacters is true stringToValue will return '(415) 555-1212'. On the other hand, if valueContainsLiteralCharacters is false, stringToValue will return '4155551212'.

Parameters

containsLiteralChars:boolean: Used to indicate if literal characters in mask should be returned in stringToValue

stringToValue back to summary

stringToValue	back to summary
public Object stringToValue(String value) throws ParseException Overrides javax.swing.text.DefaultFormatter.stringToValue. Parses the text, returning the appropriate Object representation of the String `value`. This strips the literal characters as necessary and invokes supers `stringToValue`, so that if you have specified a value class (`setValueClass`) an instance of it will be created. This will throw a `ParseException` if the value does not match the current mask. Refer to `setValueContainsLiteralCharacters` for details on how literals are treated. Parameters value:String String to convert Returns:Object Object representation of text Exceptions ParseException: if there is an error in the conversion See Also `setValueContainsLiteralCharacters`

public Object stringToValue(String value) throws ParseException

Overrides javax.swing.text.DefaultFormatter.stringToValue.

Parses the text, returning the appropriate Object representation of the String value. This strips the literal characters as necessary and invokes supers stringToValue, so that if you have specified a value class (setValueClass) an instance of it will be created. This will throw a ParseException if the value does not match the current mask. Refer to setValueContainsLiteralCharacters for details on how literals are treated.

Parameters

value:String: String to convert

Returns:Object

Object representation of text

Exceptions

ParseException:: if there is an error in the conversion

See Also

setValueContainsLiteralCharacters

stringToValue	back to summary
private Object stringToValue(String value, boolean completeMatch) throws ParseException Actual `stringToValue` implementation. If `completeMatch` is true, the value must exactly match the mask, on the other hand if `completeMatch` is false the string must match the mask or the placeholder string.

stripLiteralChars	back to summary
private String stripLiteralChars(String string) Removes the literal characters from the passed in string.

updateInternalMask	back to summary
private void updateInternalMask() throws ParseException Updates the internal representation of the mask.

valueToString back to summary

public String valueToString(Object value) throws ParseException

Overrides javax.swing.text.DefaultFormatter.valueToString.

Returns a String representation of the Object value based on the mask. Refer to setValueContainsLiteralCharacters for details on how literals are treated.

Parameters

value:Object: Value to convert

Returns:String

String representation of value

Exceptions

ParseException:: if there is an error in the conversion

See Also

setValueContainsLiteralCharacters

javax.swing.text back to summary

private Class MaskFormatter.AlphaNumericCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.AlphaNumericCharacter

Represents either a character or digit, uses Character.isLetterOrDigit.

Constructor Summary

Access	Constructor and Description
private	AlphaNumericCharacter()

Method Summary

Modifier and Type	Method and Description
public boolean	isValidCharacter(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter. Returns true if `aChar` is a valid representation of the receiver.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append getChar isLiteral

Constructor Detail

AlphaNumericCharacter	back to summary
private AlphaNumericCharacter()

Method Detail

isValidCharacter back to summary

public boolean isValidCharacter(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Returns true if aChar is a valid representation of the receiver. The default implementation returns true if the receiver represents a literal character and getChar == aChar. Otherwise, this will return true is aChar is contained in the valid characters and not contained in the invalid characters.

javax.swing.text back to summary

private Class MaskFormatter.CharCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.CharCharacter

Represents a letter, uses Character.isLetter.

Constructor Summary

Access	Constructor and Description
private	CharCharacter()

Method Summary

Modifier and Type	Method and Description
public boolean	isValidCharacter(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter. Returns true if `aChar` is a valid representation of the receiver.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append getChar isLiteral

Constructor Detail

CharCharacter	back to summary
private CharCharacter()

Method Detail

isValidCharacter back to summary

public boolean isValidCharacter(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

javax.swing.text back to summary

private Class MaskFormatter.DigitMaskCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.DigitMaskCharacter

Represents a number, uses Character.isDigit.

Constructor Summary

Access	Constructor and Description
private	DigitMaskCharacter()

Method Summary

Modifier and Type	Method and Description
public boolean	isValidCharacter(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter. Returns true if `aChar` is a valid representation of the receiver.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append getChar isLiteral

Constructor Detail

DigitMaskCharacter	back to summary
private DigitMaskCharacter()

Method Detail

isValidCharacter back to summary

public boolean isValidCharacter(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

javax.swing.text back to summary

private Class MaskFormatter.HexCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.HexCharacter

Represents a hex character, 0-9a-fA-F. a-f is mapped to A-F

Constructor Summary

Access	Constructor and Description
private	HexCharacter()

Method Summary

Modifier and Type	Method and Description
public char	getChar(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar. Returns the character to insert for `aChar`.
public boolean	isValidCharacter(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter. Returns true if `aChar` is a valid representation of the receiver.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append isLiteral

Constructor Detail

HexCharacter	back to summary
private HexCharacter()

Method Detail

getChar back to summary

public char getChar(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.getChar.

Returns the character to insert for aChar. The default implementation returns aChar. Subclasses that wish to do some sort of mapping, perhaps lower case to upper case should override this and do the necessary mapping.

isValidCharacter back to summary

public boolean isValidCharacter(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

javax.swing.text back to summary

private Class MaskFormatter.LiteralCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.LiteralCharacter

Used to represent a fixed character in the mask.

Field Summary

Modifier and Type	Field and Description
private char	fixedChar

Constructor Summary

Access	Constructor and Description
public	LiteralCharacter(char fixedChar)

Method Summary

Modifier and Type	Method and Description
public char	getChar(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar. Returns the character to insert for `aChar`.
public boolean	isLiteral() Overrides javax.swing.text.MaskFormatter.MaskCharacter.isLiteral. Subclasses should override this returning true if the instance represents a literal character.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append isValidCharacter

Field Detail

fixedChar	back to summary
private char fixedChar

Constructor Detail

LiteralCharacter	back to summary
public LiteralCharacter(char fixedChar)

Method Detail

getChar back to summary

public char getChar(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.getChar.

isLiteral

back to summary

public boolean isLiteral()

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isLiteral.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isLiteral.

Subclasses should override this returning true if the instance represents a literal character. The default implementation returns false.

javax.swing.text back to summary

private Class MaskFormatter.LowerCaseCharacter

Class Inheritance

extends MaskCharacter

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter
javax.swing.text.MaskFormatter.LowerCaseCharacter

Represents a character, upper case letters are mapped to lower case using Character.toLowerCase.

Constructor Summary

Access	Constructor and Description
private	LowerCaseCharacter()

Method Summary

Modifier and Type	Method and Description
public char	getChar(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar. Returns the character to insert for `aChar`.
public boolean	isValidCharacter(char aChar) Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter. Returns true if `aChar` is a valid representation of the receiver.

Inherited from javax.swing.text.MaskFormatter.MaskCharacter:: append isLiteral

Constructor Detail

LowerCaseCharacter	back to summary
private LowerCaseCharacter()

Method Detail

getChar back to summary

public char getChar(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.getChar.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.getChar.

isValidCharacter back to summary

public boolean isValidCharacter(char aChar)

Overrides javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

Doc from javax.swing.text.MaskFormatter.MaskCharacter.isValidCharacter.

javax.swing.text back to summary

private Class MaskFormatter.MaskCharacter

Class Inheritance

extends Object

java.lang.Object
javax.swing.text.MaskFormatter.MaskCharacter

Known Direct Subclasses

javax.swing.text.MaskFormatter.LiteralCharacter, javax.swing.text.MaskFormatter.DigitMaskCharacter, javax.swing.text.MaskFormatter.UpperCaseCharacter, javax.swing.text.MaskFormatter.LowerCaseCharacter, javax.swing.text.MaskFormatter.AlphaNumericCharacter, javax.swing.text.MaskFormatter.CharCharacter, javax.swing.text.MaskFormatter.HexCharacter

Constructor Summary

Access	Constructor and Description
private	MaskCharacter()

Method Summary

Modifier and Type	Method and Description
public void	append(StringBuilder buff, String formatting, int[] index, String placeholder) Appends the necessary character in `formatting` at `index` to `buff`.
public char	getChar(char aChar) Returns the character to insert for `aChar`.
public boolean	isLiteral() Subclasses should override this returning true if the instance represents a literal character.
public boolean	isValidCharacter(char aChar) Returns true if `aChar` is a valid representation of the receiver.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

MaskCharacter	back to summary
private MaskCharacter()

Method Detail

append	back to summary
public void append(StringBuilder buff, String formatting, int[] index, String placeholder) throws ParseException Appends the necessary character in `formatting` at `index` to `buff`.

getChar	back to summary
public char getChar(char aChar) Returns the character to insert for `aChar`. The default implementation returns `aChar`. Subclasses that wish to do some sort of mapping, perhaps lower case to upper case should override this and do the necessary mapping.

isLiteral	back to summary
public boolean isLiteral() Subclasses should override this returning true if the instance represents a literal character. The default implementation returns false.

isValidCharacter	back to summary
public boolean isValidCharacter(char aChar) Returns true if `aChar` is a valid representation of the receiver. The default implementation returns true if the receiver represents a literal character and `getChar` == aChar. Otherwise, this will return true is `aChar` is contained in the valid characters and not contained in the invalid characters.

public Class MaskFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MaskFormatter.AlphaNumericCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.CharCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.DigitMaskCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.HexCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.LiteralCharacter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MaskFormatter.LowerCaseCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.MaskCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MaskFormatter.UpperCaseCharacter

Constructor Summary

Method Summary

Constructor Detail

Method Detail