Module is.codion.swing.common.ui

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

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

Type Parameters:

T - the type the text field represents

C - the text field type

B - the builder type

All Superinterfaces:

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

All Known Subinterfaces:

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

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

Builds a JTextField.

Nested Class Summary

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

TextComponentBuilder.CaretPosition

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
B	action(Action action)	Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).
B	actionListener(ActionListener actionListener)	Note that this disables ComponentBuilder.transferFocusOnEnter(boolean).
static <T, C extends JTextField, B extends TextFieldBuilder<T, C, B>> TextFieldBuilder<T,C,B>	builder(Class<T> valueClass)
static <T, C extends JTextField, B extends TextFieldBuilder<T, C, B>> TextFieldBuilder<T,C,B>	builder(Class<T> valueClass, Value<T> linkedValue)
B	columns(int columns)
B	format(Format format)	Associates the given format with the text field.
B	hint(String hint)
B	horizontalAlignment(int horizontalAlignment)
B	selector(SelectionDialogBuilder.SingleSelector<T> selector)	Adds a CTRL-SPACE action the given text field allowing the user to select a value to display in the field

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

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

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)

selector

B selector(SelectionDialogBuilder.SingleSelector<T> selector)

Adds a CTRL-SPACE action the given text field allowing the user to select a value to display in the field

Parameters:

selector - the selector providing the values to select from

Returns:

this builder instance

format

B format(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 <T,
C extends JTextField,
B extends TextFieldBuilder<T,
C,
B>>
TextFieldBuilder<T,C,B> builder(Class<T> valueClass)

Type Parameters:

T - the value type

C - the text field type

B - the builder type

Parameters:

valueClass - the value class

Returns:

a builder for a component

builder

static <T,
C extends JTextField,
B extends TextFieldBuilder<T,
C,
B>>
TextFieldBuilder<T,C,B> builder(Class<T> valueClass,
 Value<T> linkedValue)

Type Parameters:

T - the value type

C - the text field type

B - the builder type

Parameters:

valueClass - the value class

linkedValue - the value to link to the component

Returns:

a builder for a component