Module is.codion.swing.common.ui

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

Interface MaskedTextFieldBuilder

All Superinterfaces:

ComponentBuilder<String,JFormattedTextField,MaskedTextFieldBuilder>

public interface MaskedTextFieldBuilder
extends ComponentBuilder<String,JFormattedTextField,MaskedTextFieldBuilder>

Builds a formatted text field.

Field Summary

Fields inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

COMPONENT_VALUE, TRANSFER_FOCUS_ON_ENTER

Method Summary

Modifier and Type	Method	Description
MaskedTextFieldBuilder	allowsInvalid(boolean allowsInvalid)
static MaskedTextFieldBuilder	builder()
static MaskedTextFieldBuilder	builder(Value<String> linkedValue)
MaskedTextFieldBuilder	columns(int columns)
MaskedTextFieldBuilder	commitsOnValidEdit(boolean commitsOnValidEdit)
MaskedTextFieldBuilder	emptyStringToNullValue(boolean emptyStringToNullValue)
MaskedTextFieldBuilder	focusLostBehaviour(int focusLostBehaviour)
MaskedTextFieldBuilder	invalidCharacters(String invalidCharacters)
MaskedTextFieldBuilder	invalidStringToNullValue(boolean invalidStringToNullValue)
MaskedTextFieldBuilder	mask(String mask)
MaskedTextFieldBuilder	overwriteMode(boolean overwriteMode)
MaskedTextFieldBuilder	placeholder(String placeholder)
MaskedTextFieldBuilder	placeholderCharacter(char placeholderCharacter)
MaskedTextFieldBuilder	validCharacters(String validCharacters)
MaskedTextFieldBuilder	valueContainsLiteralCharacters(boolean valueContainsLiteralCharacters)

Methods inherited from interface is.codion.swing.common.ui.component.builder.ComponentBuilder

background, border, build, build, buildValue, buildValue, clientProperty, componentListener, componentOrientation, consumer, enabled, enabled, focusable, focusCycleRoot, focusListener, font, foreground, keyEvent, keyListener, label, link, link, listener, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onBuildValue, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, transferFocusOnEnter, transferHandler, validator, value, visible

Method Details

mask

MaskedTextFieldBuilder mask(String mask)

Parameters:

mask - the format mask string

Returns:

this builder instance

See Also:

• MaskFormatter.setMask(String)

valueContainsLiteralCharacters

MaskedTextFieldBuilder valueContainsLiteralCharacters(boolean valueContainsLiteralCharacters)

Parameters:

valueContainsLiteralCharacters - true if the value should contain literal characters

Returns:

this builder instance

See Also:

• MaskFormatter.setValueContainsLiteralCharacters(boolean)

placeholder

MaskedTextFieldBuilder placeholder(String placeholder)

Parameters:

placeholder - the placeholder

Returns:

this builder instance

See Also:

• MaskFormatter.setPlaceholder(String)

placeholderCharacter

MaskedTextFieldBuilder placeholderCharacter(char placeholderCharacter)

Parameters:

placeholderCharacter - the placeholder character

Returns:

this builder instance

See Also:

• MaskFormatter.setPlaceholderCharacter(char)

allowsInvalid

MaskedTextFieldBuilder allowsInvalid(boolean allowsInvalid)

Parameters:

allowsInvalid - true if this field should allow invalid values

Returns:

this builder instance

See Also:

• DefaultFormatter.setAllowsInvalid(boolean)

commitsOnValidEdit

MaskedTextFieldBuilder commitsOnValidEdit(boolean commitsOnValidEdit)

Parameters:

commitsOnValidEdit - true if value should be committed on valid edit

Returns:

this builder instance

See Also:

• DefaultFormatter.setCommitsOnValidEdit(boolean)

validCharacters

MaskedTextFieldBuilder validCharacters(String validCharacters)

Parameters:

validCharacters - the valid characters

Returns:

this builder instance

See Also:

• MaskFormatter.setValidCharacters(String)

invalidCharacters

MaskedTextFieldBuilder invalidCharacters(String invalidCharacters)

Parameters:

invalidCharacters - the invalid characters

Returns:

this builder instance

See Also:

• MaskFormatter.setInvalidCharacters(String)

overwriteMode

MaskedTextFieldBuilder overwriteMode(boolean overwriteMode)

Parameters:

overwriteMode - true if new characters should overwrite existing characters

Returns:

this builder instance

See Also:

• DefaultFormatter.setOverwriteMode(boolean)

emptyStringToNullValue

MaskedTextFieldBuilder emptyStringToNullValue(boolean emptyStringToNullValue)

Parameters:

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

Returns:

this builder instance

invalidStringToNullValue

MaskedTextFieldBuilder invalidStringToNullValue(boolean invalidStringToNullValue)

Parameters:

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

Returns:

this builder instance

columns

MaskedTextFieldBuilder columns(int columns)

Parameters:

columns - the number of colums in the text field

Returns:

this builder instance

See Also:

• JTextField.setColumns(int)

focusLostBehaviour

MaskedTextFieldBuilder focusLostBehaviour(int focusLostBehaviour)

Parameters:

focusLostBehaviour - the focus lost behaviour, JFormattedTextField.COMMIT by default

Returns:

this builder instance

See Also:

• JFormattedTextField.COMMIT
• JFormattedTextField.COMMIT_OR_REVERT
• JFormattedTextField.REVERT
• JFormattedTextField.PERSIST

builder

static MaskedTextFieldBuilder builder()

Returns:

a builder for a component

builder

static MaskedTextFieldBuilder builder(Value<String> linkedValue)

Parameters:

linkedValue - the value to link to the component

Returns:

a builder for a component