Module is.codion.swing.common.ui

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

Interface TextComponentBuilder<T,C extends JTextComponent,B extends TextComponentBuilder<T,C,B>>

All Superinterfaces:

ComponentBuilder<T,C,B>

All Known Subinterfaces:

NumberField.Builder<T>, PasswordFieldBuilder, TemporalField.Builder<T>, TextAreaBuilder, TextFieldBuilder<T,C,B>

public interface TextComponentBuilder<T,C extends JTextComponent,B extends TextComponentBuilder<T,C,B>>
extends ComponentBuilder<T,C,B>

A builder for text components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TextComponentBuilder.CaretPosition	Specifies the possible initial caret positions in case text component has an initial value.

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	caretListener(CaretListener caretListener)
B	caretPosition(TextComponentBuilder.CaretPosition caretPosition)	Specifies the initial caret position for the component in case an initial value is specified.
B	caretUpdatePolicy(int caretUpdatePolicy)
B	controlDeleteWord(boolean controlDeleteWord)
B	disabledTextColor(Color disabledTextColor)
B	dragEnabled(boolean dragEnabled)
B	editable(boolean editable)
B	focusAccelerator(char focusAcceleratorKey)
B	lowerCase(boolean lowerCase)
B	margin(Insets margin)
B	maximumLength(int maximumLength)
B	moveCaretToEndOnFocusGained(boolean moveCaretToEndOnFocusGained)
B	moveCaretToStartOnFocusGained(boolean moveCaretToStartOnFocusGained)
B	onTextChanged(Consumer<String> onTextChanged)
B	selectAllOnFocusGained(boolean selectAllOnFocusGained)	Makes the text component select all when it gains focus
B	selectedTextColor(Color selectedTextColor)
B	selectionColor(Color selectionColor)
B	updateOn(UpdateOn updateOn)	Default UpdateOn.VALUE_CHANGE
B	upperCase(boolean upperCase)

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

editable

B editable(boolean editable)

Parameters:

editable - false if the component should not be editable

Returns:

this builder instance

See Also:

• JTextComponent.setEditable(boolean)

updateOn

B updateOn(UpdateOn updateOn)

Default UpdateOn.VALUE_CHANGE

Parameters:

updateOn - specifies when the underlying value should be updated

Returns:

this builder instance

upperCase

B upperCase(boolean upperCase)

Parameters:

upperCase - if true the text component convert all lower case input to upper case

Returns:

this builder instance

lowerCase

B lowerCase(boolean lowerCase)

Parameters:

lowerCase - if true the text component convert all upper case input to lower case

Returns:

this builder instance

maximumLength

B maximumLength(int maximumLength)

Parameters:

maximumLength - the maximum text length

Returns:

this builder instance

margin

B margin(Insets margin)

Parameters:

margin - the margin

Returns:

this builder instance

See Also:

• JTextComponent.setMargin(Insets)

controlDeleteWord

B controlDeleteWord(boolean controlDeleteWord)

Parameters:

controlDeleteWord - true if CTRL-DEL and CTRL-BACKSPACE should delete the next/previous word

Returns:

this builder instance

disabledTextColor

B disabledTextColor(Color disabledTextColor)

Parameters:

disabledTextColor - the color used to render disabled text

Returns:

this builder instance

See Also:

• JTextComponent.setDisabledTextColor(Color)

selectedTextColor

B selectedTextColor(Color selectedTextColor)

Parameters:

selectedTextColor - the color used to render selected text

Returns:

this builder instance

See Also:

• JTextComponent.setSelectedTextColor(Color)

selectionColor

B selectionColor(Color selectionColor)

Parameters:

selectionColor - the color used to render selected text background

Returns:

this builder instance

See Also:

• JTextComponent.setSelectionColor(Color)

selectAllOnFocusGained

B selectAllOnFocusGained(boolean selectAllOnFocusGained)

Makes the text component select all when it gains focus

Parameters:

selectAllOnFocusGained - if true the component will select contents on focus gained

Returns:

this builder instance

moveCaretToEndOnFocusGained

B moveCaretToEndOnFocusGained(boolean moveCaretToEndOnFocusGained)

Parameters:

moveCaretToEndOnFocusGained - true if the caret should be moved to the end on focus gained

Returns:

this builder instance

moveCaretToStartOnFocusGained

B moveCaretToStartOnFocusGained(boolean moveCaretToStartOnFocusGained)

Parameters:

moveCaretToStartOnFocusGained - true if the caret should be moved to the start on focus gained

Returns:

this builder instance

caretListener

B caretListener(CaretListener caretListener)

Parameters:

caretListener - the caret listener to add

Returns:

this builder instance

onTextChanged

B onTextChanged(Consumer<String> onTextChanged)

Parameters:

onTextChanged - called when the text changes

Returns:

this builder instance

dragEnabled

B dragEnabled(boolean dragEnabled)

Parameters:

dragEnabled - true if automatic drag handling should be enabled

Returns:

this builder instance

See Also:

• JTextComponent.setDragEnabled(boolean)

focusAccelerator

B focusAccelerator(char focusAcceleratorKey)

Parameters:

focusAcceleratorKey - the focus accelerator key

Returns:

this builder instance

See Also:

• JTextComponent.setFocusAccelerator(char)

caretPosition

B caretPosition(TextComponentBuilder.CaretPosition caretPosition)

Specifies the initial caret position for the component in case an initial value is specified. Default TextComponentBuilder.CaretPosition.START

Parameters:

caretPosition - the initial caret position

Returns:

this builder instance

See Also:

• ComponentBuilder.value(Object)
• JTextComponent.setCaretPosition(int)

caretUpdatePolicy

B caretUpdatePolicy(int caretUpdatePolicy)

Parameters:

caretUpdatePolicy - the caret update policy

Returns:

this builder instance

See Also:

• DefaultCaret.setUpdatePolicy(int)