Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.text

Interface MaskFormatterBuilder

public interface MaskFormatterBuilder

Builds a MaskFormatter instance.

Method Summary

Modifier and Type	Method	Description
MaskFormatterBuilder	allowsInvalid(boolean allowsInvalid)
MaskFormatter	build()
static MaskFormatterBuilder	builder()
MaskFormatterBuilder	commitsOnValidEdit(boolean commitsOnValidEdit)
MaskFormatterBuilder	emptyStringToNullValue(boolean emptyStringToNullValue)	If set to true then MaskFormatter.stringToValue(String) returns null when it encounters an empty string, instead of throwing a ParseException.
MaskFormatterBuilder	invalidCharacters(String invalidCharacters)
MaskFormatterBuilder	invalidStringToNullValue(boolean invalidStringToNullValue)	If set to true then MaskFormatter.stringToValue(String) returns null when it encounters an unparsable string, instead of throwing a ParseException.
MaskFormatterBuilder	mask(String mask)
MaskFormatterBuilder	overwriteMode(boolean overwriteMode)
MaskFormatterBuilder	placeholder(String placeholder)
MaskFormatterBuilder	placeholderCharacter(char placeholderCharacter)
MaskFormatterBuilder	validCharacters(String validCharacters)
MaskFormatterBuilder	valueContainsLiteralCharacters(boolean valueContainsLiteralCharacters)

Method Details

mask

MaskFormatterBuilder mask(String mask)

Parameters:

mask - the format mask string

Returns:

this builder instance

See Also:

• MaskFormatter.setMask(String)

valueContainsLiteralCharacters

MaskFormatterBuilder valueContainsLiteralCharacters(boolean valueContainsLiteralCharacters)

Parameters:

valueContainsLiteralCharacters - true if the value should contain literal characters

Returns:

this builder instance

See Also:

• MaskFormatter.setValueContainsLiteralCharacters(boolean)

placeholder

MaskFormatterBuilder placeholder(String placeholder)

Parameters:

placeholder - the placeholder

Returns:

this builder instance

See Also:

• MaskFormatter.setPlaceholder(String)

placeholderCharacter

MaskFormatterBuilder placeholderCharacter(char placeholderCharacter)

Parameters:

placeholderCharacter - the placeholder character

Returns:

this builder instance

See Also:

• MaskFormatter.setPlaceholderCharacter(char)

allowsInvalid

MaskFormatterBuilder allowsInvalid(boolean allowsInvalid)

Parameters:

allowsInvalid - true if this field should allow invalid values

Returns:

this builder instance

See Also:

• DefaultFormatter.setAllowsInvalid(boolean)

commitsOnValidEdit

MaskFormatterBuilder commitsOnValidEdit(boolean commitsOnValidEdit)

Parameters:

commitsOnValidEdit - true if value should be committed on valid edit

Returns:

this builder instance

See Also:

• DefaultFormatter.setCommitsOnValidEdit(boolean)

validCharacters

MaskFormatterBuilder validCharacters(String validCharacters)

Parameters:

validCharacters - the valid characters

Returns:

this builder instance

See Also:

• MaskFormatter.setValidCharacters(String)

invalidCharacters

MaskFormatterBuilder invalidCharacters(String invalidCharacters)

Parameters:

invalidCharacters - the invalid characters

Returns:

this builder instance

See Also:

• MaskFormatter.setInvalidCharacters(String)

overwriteMode

MaskFormatterBuilder overwriteMode(boolean overwriteMode)

Parameters:

overwriteMode - true if new characters should overwrite existing characters

Returns:

this builder instance

See Also:

• DefaultFormatter.setOverwriteMode(boolean)

emptyStringToNullValue

MaskFormatterBuilder emptyStringToNullValue(boolean emptyStringToNullValue)

If set to true then MaskFormatter.stringToValue(String) returns null when it encounters an empty string, instead of throwing a ParseException.

Parameters:

emptyStringToNullValue - if true then an empty string translates to a null value

Returns:

this builder instance

See Also:

• MaskFormatter.stringToValue(String)

invalidStringToNullValue

MaskFormatterBuilder invalidStringToNullValue(boolean invalidStringToNullValue)

If set to true then MaskFormatter.stringToValue(String) returns null when it encounters an unparsable string, instead of throwing a ParseException.

Parameters:

invalidStringToNullValue - if true then an unparsable string translates to a null value

Returns:

this builder instance

See Also:

• MaskFormatter.stringToValue(String)

build

MaskFormatter build()
             throws ParseException

Returns:

a new MaskFormatter instance based on this builder

Throws:

ParseException - if the mask does not contain valid mask characters

builder

static MaskFormatterBuilder builder()

Returns:

a new MaskFormatterBuilder instance