Module is.codion.swing.common.ui

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

Interface TextFieldBuilder<C extends JTextField,T,B extends TextFieldBuilder<C,T,B>>

Type Parameters:

C - the text field type

T - the type the text field represents

B - the builder type

All Superinterfaces:

ComponentBuilder<C,B>, ComponentValueBuilder<C,T,B>, Supplier<C>, TextComponentBuilder<C,T,B>

All Known Subinterfaces:

NumberField.Builder<T>, PasswordFieldBuilder, TemporalField.Builder<T>

public interface TextFieldBuilder<C extends JTextField,T,B extends TextFieldBuilder<C,T,B>>
extends TextComponentBuilder<C,T,B>

Builds a JTextField.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TextFieldBuilder.ValueClassStep	Provides a TextFieldBuilder

Nested classes/interfaces inherited from interface is.codion.swing.common.ui.component.text.TextComponentBuilder

TextComponentBuilder.CaretPosition

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	SELECT_ALL_ON_FOCUS_GAINED	Specifies whether text fields should select all on focus gained by default.

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

COMPONENT_VALUE

Method Summary

Modifier and Type	Method	Description
B	action(Action action)	Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).
B	actionListener(ActionListener actionListener)	Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).
static TextFieldBuilder.ValueClassStep	builder()
B	columns(int columns)
B	format(@Nullable Format format)	Associates the given format with the text field.
B	hint(String hint)
B	horizontalAlignment(int horizontalAlignment)

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

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

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

buildValue, buildValue, consumer, link, link, listener, modifiedIndicator, modifiedIndicatorFactory, onBuildValue, validator, validIndicator, validIndicator, validIndicatorFactory, value

Methods inherited from interface is.codion.swing.common.ui.component.text.TextComponentBuilder

caretListener, caretPosition, caretUpdatePolicy, controlDeleteWord, disabledTextColor, dragEnabled, editable, focusAccelerator, lowerCase, margin, maximumLength, moveCaretToEndOnFocusGained, moveCaretToStartOnFocusGained, onTextChanged, selectAllOnFocusGained, selectedTextColor, selectionColor, updateOn, upperCase

Field Details

SELECT_ALL_ON_FOCUS_GAINED

static final PropertyValue<Boolean> SELECT_ALL_ON_FOCUS_GAINED

Specifies whether text fields should select all on focus gained by default.

• Value type:Boolean
• Default value: false

Method Details

columns

B columns(int columns)

Parameters:

columns - the number of colums in the text component

Returns:

this builder instance

See Also:

• JTextField.setColumns(int)

action

B action(Action action)

Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).

Parameters:

action - the action to associate with the text field

Returns:

this builder instance

See Also:

• JTextField.setAction(Action)

actionListener

B actionListener(ActionListener actionListener)

Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).

Parameters:

actionListener - the action listener

Returns:

this builder instance

See Also:

• JTextField.addActionListener(ActionListener)

format

B format(@Nullable Format format)

Associates the given format with the text field. Note that the format instance is cloned on build, so format instances can be reused when calling this method.

Parameters:

format - the format

Returns:

this builder instance

horizontalAlignment

B horizontalAlignment(int horizontalAlignment)

Parameters:

horizontalAlignment - the horizontal text alignment

Returns:

this builder instance

See Also:

• JTextField.setHorizontalAlignment(int)

hint

B hint(String hint)

Parameters:

hint - the hint to display when the field is empty and unfocused

Returns:

this builder instance

builder

static TextFieldBuilder.ValueClassStep builder()

Returns:

a TextFieldBuilder.ValueClassStep