Module is.codion.swing.common.ui

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

Interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Type Parameters:

T - the type of the value the component represents

C - the component type

B - the builder type

All Known Subinterfaces:

BorderLayoutPanelBuilder, ButtonBuilder<T,C,B>, ButtonPanelBuilder, CheckBoxBuilder, CheckBoxMenuItemBuilder<B>, ComboBoxBuilder<T,C,B>, ControlPanelBuilder<C,B>, EntityComboBox.Builder, EntityComboBoxPanel.Builder, EntitySearchField.Builder<T,B>, EntitySearchField.MultiSelectionBuilder, EntitySearchField.SingleSelectionBuilder, EntitySearchFieldPanel.Builder<T,B>, EntitySearchFieldPanel.MultiSelectionBuilder, EntitySearchFieldPanel.SingleSelectionBuilder, FileInputPanel.Builder<T>, FilterTable.Builder<R,C>, ItemComboBoxBuilder<T>, ItemSpinnerBuilder<T>, LabelBuilder<T>, ListBoxBuilder<T>, ListBuilder<T,V,B>, ListBuilder.Items<T>, ListBuilder.SelectedItem<T>, ListBuilder.SelectedItems<T>, ListSpinnerBuilder<T>, MaskedTextFieldBuilder, MenuBuilder, MenuItemBuilder<C,B>, NumberField.Builder<T>, NumberSpinnerBuilder<T>, PanelBuilder, PasswordFieldBuilder, ProgressBarBuilder, RadioButtonBuilder, RadioButtonMenuItemBuilder<B>, ScrollPaneBuilder, SliderBuilder, SpinnerBuilder<T,B>, SplitPaneBuilder, TabbedPaneBuilder, TemporalField.Builder<T>, TemporalFieldPanel.Builder<T>, TextAreaBuilder, TextComponentBuilder<T,C,B>, TextFieldBuilder<T,C,B>, TextFieldPanel.Builder, TextPaneBuilder, ToggleButtonBuilder<C,B>, ToggleMenuItemBuilder<C,B>, ToolBarBuilder

All Known Implementing Classes:

AbstractComponentBuilder, DefaultComboBoxBuilder

public interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Use build() to build a JComponent instance or buildValue() to build a ComponentValue instance.
The component is available via ComponentValue.component() and the associated ComponentValue instance is available via the COMPONENT_VALUE client property.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_VALUE	The client property key for the associated ComponentValue JTextField textField = Components.stringField() .build(); ComponentValue<String, JTextField> componentValue = (ComponentValue<String, JTextField>) textField.getClientProperty(COMPONENT_VALUE);

Method Summary

Modifier and Type	Method	Description
B	background(@Nullable Color background)
B	border(@Nullable Border border)
C	build()	Builds a new component instance.
C	build(@Nullable Consumer<C> onBuild)	Builds a new component instance.
ComponentValue<T,C>	buildValue()	Builds and returns the component value.
ComponentValue<T,C>	buildValue(@Nullable Consumer<ComponentValue<T,C>> onBuild)	Builds and returns the component value.
B	clientProperty(Object key, @Nullable Object value)	Adds an arbitrary key/value "client property" to the component
B	componentListener(ComponentListener componentListener)
B	componentOrientation(@Nullable ComponentOrientation orientation)
B	consumer(Consumer<T> consumer)
B	enabled(boolean enabled)	Sets the enabled state of the component, for a dynamic enabled state use enabled(ObservableState).
B	enabled(@Nullable ObservableState enabled)
B	focusable(boolean focusable)
B	focusCycleRoot(boolean focusCycleRoot)
B	focusListener(FocusListener focusListener)
B	font(@Nullable Font font)
B	foreground(@Nullable Color foreground)
B	keyEvent(KeyEvents.Builder keyEventBuilder)	Enables the key event defined by the given KeyEvents.Builder on the component.
B	keyListener(KeyListener keyListener)
B	label(@Nullable JLabel label)
B	link(Observable<T> linkedValue)	Creates a read-only link to the given Observable.
B	link(Value<T> linkedValue)	Creates a bidirectional link to the given value.
B	listener(Runnable listener)
B	maximumHeight(int maximumHeight)
B	maximumSize(@Nullable Dimension maximumSize)
B	maximumWidth(int maximumWidth)
B	minimumHeight(int minimumHeight)
B	minimumSize(@Nullable Dimension minimumSize)
B	minimumWidth(int minimumWidth)
B	modifiedIndicator(@Nullable ObservableState modified)	Enables a modified indicator based on the given modified state.
B	modifiedIndicatorFactory(@Nullable ModifiedIndicatorFactory modifiedIndicatorFactory)	By default UnderlineModifiedIndicatorFactory.
B	mouseListener(MouseListener mouseListener)
B	mouseMotionListener(MouseMotionListener mouseMotionListener)
B	mouseWheelListener(MouseWheelListener mouseWheelListener)
B	name(@Nullable String name)
B	onBuild(Consumer<C> onBuild)
B	onBuildValue(Consumer<ComponentValue<T,C>> onBuildValue)
B	onSetVisible(Consumer<C> onSetVisible)
B	opaque(boolean opaque)
B	popupMenu(@Nullable Function<C,JPopupMenu> popupMenu)
B	popupMenuControl(@Nullable Function<C,Control> popupMenuControl)
B	popupMenuControls(@Nullable Function<C,Controls> popupMenuControls)
B	preferredHeight(int preferredHeight)
B	preferredSize(@Nullable Dimension preferredSize)
B	preferredWidth(int preferredWidth)
B	propertyChangeListener(PropertyChangeListener propertyChangeListener)
B	propertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)
ScrollPaneBuilder	scrollPane()
B	toolTipText(@Nullable Observable<String> toolTipText)	Overrides toolTipText(String)
B	toolTipText(@Nullable String toolTipText)
B	transferFocusOnEnter(boolean transferFocusOnEnter)	Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added for transferring the focus forward.
B	transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)	Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added for transferring the focus forward.
B	transferHandler(@Nullable TransferHandler transferHandler)
B	validator(Value.Validator<T> validator)
B	validIndicator(@Nullable ObservableState valid)	Enables a valid indicator based on the given valid state.
B	validIndicator(@Nullable Predicate<T> validator)	Enables a valid indicator based on the given validator.
B	validIndicatorFactory(@Nullable ValidIndicatorFactory validIndicatorFactory)
B	value(@Nullable T value)	Sets the initial value for the component, unless value(s) have been linked via link(Value) or link(Observable), which then control the inital value.
B	visible(boolean visible)

Field Details

COMPONENT_VALUE

static final String COMPONENT_VALUE

The client property key for the associated ComponentValue

   JTextField textField =
            Components.stringField()
                    .build();

   ComponentValue<String, JTextField> componentValue =
            (ComponentValue<String, JTextField>)
                    textField.getClientProperty(COMPONENT_VALUE);

See Also:

• JComponent.getClientProperty(Object)
• Constant Field Values

Method Details

name

B name(@Nullable String name)

Parameters:

name - the name to assign to the component

Returns:

this builder instance

See Also:

• Component.setName(String)

label

B label(@Nullable JLabel label)

Parameters:

label - the label for the component

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

focusable

B focusable(boolean focusable)

Parameters:

focusable - false if the component should not be focusable

Returns:

this builder instance

See Also:

• Component.setFocusable(boolean)

preferredHeight

B preferredHeight(int preferredHeight)

Parameters:

preferredHeight - the preferred component height

Returns:

this builder instance

preferredWidth

B preferredWidth(int preferredWidth)

Parameters:

preferredWidth - the preferred component width

Returns:

this builder instance

preferredSize

B preferredSize(@Nullable Dimension preferredSize)

Parameters:

preferredSize - the preferred component size

Returns:

this builder instance

See Also:

• JComponent.setPreferredSize(Dimension)

maximumHeight

B maximumHeight(int maximumHeight)

Parameters:

maximumHeight - the maximum component height

Returns:

this builder instance

maximumWidth

B maximumWidth(int maximumWidth)

Parameters:

maximumWidth - the maximum component width

Returns:

this builder instance

maximumSize

B maximumSize(@Nullable Dimension maximumSize)

Parameters:

maximumSize - the maximum component size

Returns:

this builder instance

See Also:

• JComponent.setMaximumSize(Dimension)

minimumHeight

B minimumHeight(int minimumHeight)

Parameters:

minimumHeight - the minimum component height

Returns:

this builder instance

minimumWidth

B minimumWidth(int minimumWidth)

Parameters:

minimumWidth - the minimum component width

Returns:

this builder instance

minimumSize

B minimumSize(@Nullable Dimension minimumSize)

Parameters:

minimumSize - the minimum component size

Returns:

this builder instance

See Also:

• JComponent.setMinimumSize(Dimension)

border

B border(@Nullable Border border)

Parameters:

border - the component border

Returns:

this builder instance

See Also:

• JComponent.setBorder(Border)

transferFocusOnEnter

B transferFocusOnEnter(boolean transferFocusOnEnter)

Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added for transferring the focus forward.

Parameters:

transferFocusOnEnter - if true then the compnent transfers focus on enter (shift-enter for backwards)

Returns:

this builder instance

transferFocusOnEnter

B transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)

Note that in case of JTextArea the InputEvent.CTRL_DOWN_MASK modifier is added for transferring the focus forward.

Parameters:

transferFocusOnEnter - the transfer focus on enter to enable

Returns:

this builder instance

toolTipText

B toolTipText(@Nullable String toolTipText)

Parameters:

toolTipText - a static tool tip text

Returns:

this builder instance

See Also:

• toolTipText(Observable)
• JComponent.setToolTipText(String)

toolTipText

B toolTipText(@Nullable Observable<String> toolTipText)

Overrides toolTipText(String)

Parameters:

toolTipText - a dynamic tool tip text

Returns:

this builder instance

See Also:

• JComponent.setToolTipText(String)

enabled

B enabled(boolean enabled)

Sets the enabled state of the component, for a dynamic enabled state use enabled(ObservableState). Overridden by enabled(ObservableState).

Parameters:

enabled - the enabled state

Returns:

this builder instance

See Also:

• JComponent.setEnabled(boolean)

enabled

B enabled(@Nullable ObservableState enabled)

Parameters:

enabled - the state observer controlling the component enabled status

Returns:

this builder instance

validIndicatorFactory

B validIndicatorFactory(@Nullable ValidIndicatorFactory validIndicatorFactory)

Parameters:

validIndicatorFactory - the ValidIndicatorFactory to use, null for none

Returns:

this builder instance

See Also:

• ValidIndicatorFactory.instance()

validIndicator

B validIndicator(@Nullable ObservableState valid)

Enables a valid indicator based on the given valid state.

Parameters:

valid - the valid state

Returns:

this builder instance

See Also:

• validIndicatorFactory(ValidIndicatorFactory)
• ValidIndicatorFactory

validIndicator

B validIndicator(@Nullable Predicate<T> validator)

Enables a valid indicator based on the given validator. Note that this is overridden by validIndicator(ObservableState).

The validator gets called each time the value changes and should return true as long as the value is valid.

Parameters:

validator - called each time the component value changes

Returns:

this builder instance

See Also:

• validIndicatorFactory(ValidIndicatorFactory)
• ValidIndicatorFactory

modifiedIndicatorFactory

B modifiedIndicatorFactory(@Nullable ModifiedIndicatorFactory modifiedIndicatorFactory)

By default UnderlineModifiedIndicatorFactory.

Parameters:

modifiedIndicatorFactory - the ModifiedIndicatorFactory to use, null for none

Returns:

this builder instance

modifiedIndicator

B modifiedIndicator(@Nullable ObservableState modified)

Enables a modified indicator based on the given modified state.

Parameters:

modified - the modified state

Returns:

this builder instance

See Also:

• modifiedIndicatorFactory(ModifiedIndicatorFactory)

popupMenuControl

B popupMenuControl(@Nullable Function<C,Control> popupMenuControl)

Parameters:

popupMenuControl - a function, receiving the component being built, providing the control to base a popup menu on

Returns:

this builder instance

popupMenuControls

B popupMenuControls(@Nullable Function<C,Controls> popupMenuControls)

Parameters:

popupMenuControls - a function, receiving the component being built, providing the controls to base a popup menu on

Returns:

this builder instance

popupMenu

B popupMenu(@Nullable Function<C,JPopupMenu> popupMenu)

Parameters:

popupMenu - a function, receiving the component being built, providing the popup menu

Returns:

this builder instance

See Also:

• JComponent.setComponentPopupMenu(JPopupMenu)

font

B font(@Nullable Font font)

Parameters:

font - the component font

Returns:

this builder instance

See Also:

• JComponent.setFont(Font)

foreground

B foreground(@Nullable Color foreground)

Parameters:

foreground - the foreground color

Returns:

this builder instance

See Also:

• JComponent.setForeground(Color)

background

B background(@Nullable Color background)

Parameters:

background - the background color

Returns:

this builder instance

See Also:

• JComponent.setBackground(Color)

opaque

B opaque(boolean opaque)

Parameters:

opaque - true if the component should be opaque

Returns:

this builder instance

See Also:

• JComponent.setOpaque(boolean)

visible

B visible(boolean visible)

Parameters:

visible - the initial component visibility, default true

Returns:

this builder instance

See Also:

• JComponent.setVisible(boolean)

componentOrientation

B componentOrientation(@Nullable ComponentOrientation orientation)

Parameters:

orientation - the component orientation

Returns:

this builder instance

See Also:

• Component.setComponentOrientation(ComponentOrientation)

validator

B validator(Value.Validator<T> validator)

Parameters:

validator - the validator to use

Returns:

this builder instance

keyEvent

B keyEvent(KeyEvents.Builder keyEventBuilder)

Enables the key event defined by the given KeyEvents.Builder on the component. Note that setting transferFocusOnEnter(boolean) to true overrides any conflicting key event based on KeyEvent.VK_ENTER added via this method.

Parameters:

keyEventBuilder - a key event builder to enable on the component

Returns:

this builder instance

clientProperty

B clientProperty(Object key,
 @Nullable Object value)

Adds an arbitrary key/value "client property" to the component

Parameters:

key - the key

value - the value

Returns:

this builder instance

See Also:

• JComponent.putClientProperty(Object, Object)

focusListener

B focusListener(FocusListener focusListener)

Parameters:

focusListener - the focus listener

Returns:

this builder instance

See Also:

• Component.addFocusListener(FocusListener)

mouseListener

B mouseListener(MouseListener mouseListener)

Parameters:

mouseListener - the mouse listener

Returns:

this builder instance

See Also:

• Component.addMouseListener(MouseListener)

mouseMotionListener

B mouseMotionListener(MouseMotionListener mouseMotionListener)

Parameters:

mouseMotionListener - the mouse motion listener

Returns:

this builder instance

See Also:

• Component.addMouseMotionListener(MouseMotionListener)

mouseWheelListener

B mouseWheelListener(MouseWheelListener mouseWheelListener)

Parameters:

mouseWheelListener - the mouse wheel listener

Returns:

this builder instance

See Also:

• Component.addMouseWheelListener(MouseWheelListener)

keyListener

B keyListener(KeyListener keyListener)

Parameters:

keyListener - the key listener

Returns:

this builder instance

See Also:

• Component.addKeyListener(KeyListener)

componentListener

B componentListener(ComponentListener componentListener)

Parameters:

componentListener - the component listener

Returns:

this builder instance

See Also:

• Component.addComponentListener(ComponentListener)

propertyChangeListener

B propertyChangeListener(PropertyChangeListener propertyChangeListener)

Parameters:

propertyChangeListener - the property change listener

Returns:

this builder instance

See Also:

• Container.addPropertyChangeListener(PropertyChangeListener)

propertyChangeListener

B propertyChangeListener(String propertyName,
 PropertyChangeListener propertyChangeListener)

Parameters:

propertyName - the name of the property to listen for

propertyChangeListener - the property change listener

Returns:

this builder instance

See Also:

• Container.addPropertyChangeListener(String, PropertyChangeListener)

transferHandler

B transferHandler(@Nullable TransferHandler transferHandler)

Parameters:

transferHandler - the transfer handler

Returns:

this builder instance

See Also:

• JComponent.setTransferHandler(TransferHandler)

focusCycleRoot

B focusCycleRoot(boolean focusCycleRoot)

Parameters:

focusCycleRoot - true if the component should be the root of a focus traversal cycle

Returns:

this builder instance

See Also:

• Container.setFocusCycleRoot(boolean)

onSetVisible

B onSetVisible(Consumer<C> onSetVisible)

Parameters:

onSetVisible - called when the component is made visible for the first time

Returns:

this builder instance

link

B link(Value<T> linkedValue)

Creates a bidirectional link to the given value. Overrides any initial value set.

Parameters:

linkedValue - a value to link to the component value

Returns:

this builder instance

link

B link(Observable<T> linkedValue)

Creates a read-only link to the given Observable.

Parameters:

linkedValue - a value to link to the component value

Returns:

this builder instance

listener

B listener(Runnable listener)

Parameters:

listener - a listener to add to the resulting component value

Returns:

this builder instance

consumer

B consumer(Consumer<T> consumer)

Parameters:

consumer - a consumer to add to the resulting component value

Returns:

this builder instance

value

B value(@Nullable T value)

Sets the initial value for the component, unless value(s) have been linked via link(Value) or link(Observable), which then control the inital value. The initial value is set before any listeners are added, so no events are triggered.

Parameters:

value - the initial value

Returns:

this builder instance

scrollPane

ScrollPaneBuilder scrollPane()

Returns:

a ScrollPaneBuilder using this component as the view

onBuild

B onBuild(Consumer<C> onBuild)

Parameters:

onBuild - called when the component has been built.

Returns:

this builder instance

onBuildValue

B onBuildValue(Consumer<ComponentValue<T,C>> onBuildValue)

Parameters:

onBuildValue - called when the component value has been built.

Returns:

this builder instance

build

C build()

Builds a new component instance.

Returns:

the component

build

C build(@Nullable Consumer<C> onBuild)

Builds a new component instance.

Parameters:

onBuild - called after the component is built.

Returns:

the component

buildValue

ComponentValue<T,C> buildValue()

Builds and returns the component value.

Returns:

the component value

buildValue

ComponentValue<T,C> buildValue(@Nullable Consumer<ComponentValue<T,C>> onBuild)

Builds and returns the component value.

Parameters:

onBuild - called after the component value is built.

Returns:

the component value