Module is.codion.swing.common.ui

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

Class AbstractComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

java.lang.Object

is.codion.swing.common.ui.component.builder.AbstractComponentBuilder<T,C,B>

All Implemented Interfaces:

ComponentBuilder<T,C,B>

Direct Known Subclasses:

DefaultComboBoxBuilder

public abstract class AbstractComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>
extends Object
implements ComponentBuilder<T,C,B>

Field Summary

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

COMPONENT_VALUE, TRANSFER_FOCUS_ON_ENTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentBuilder()
protected	AbstractComponentBuilder(Value<T> linkedValue)	Note that when a linked value is set via the constructor, it is considered locked and cannot be changed.

Method Summary

Modifier and Type	Method	Description
final B	background(Color background)
final B	border(Border border)
final C	build()	Builds a new component instance.
final C	build(Consumer<C> onBuild)	Builds a new component instance.
final ComponentValue<T,C>	buildValue()	Builds and returns the component value.
final ComponentValue<T,C>	buildValue(Consumer<ComponentValue<T,C>> onBuild)	Builds and returns the component value.
final B	clientProperty(Object key, Object value)	Adds an arbitrary key/value "client property" to the component
final B	componentListener(ComponentListener componentListener)
final B	componentOrientation(ComponentOrientation componentOrientation)
final B	consumer(Consumer<T> consumer)
protected abstract C	createComponent()	Creates the component.
protected abstract ComponentValue<T,C>	createComponentValue(C component)	Creates the component value
final B	enabled(boolean enabled)	Sets the enabled state of the component, for a dynamic enabled state use ComponentBuilder.enabled(StateObserver).
final B	enabled(StateObserver enabled)
protected void	enableTransferFocusOnEnter(C component)	Enables focus transfer on Enter, override for special handling
final B	focusable(boolean focusable)
final B	focusCycleRoot(boolean focusCycleRoot)
final B	focusListener(FocusListener focusListener)
final B	font(Font font)
final B	foreground(Color foreground)
final B	keyEvent(KeyEvents.Builder keyEventBuilder)	Enables the key event defined by the given KeyEvents.Builder on the component.
final B	keyListener(KeyListener keyListener)
final B	label(JLabel label)
final B	link(Value<T> linkedValue)	Creates a bidirectional link to the given value.
final B	link(ValueObserver<T> linkedValueObserver)	Creates a read-only link to the given ValueObserver.
final B	listener(Runnable listener)
final B	maximumHeight(int maximumHeight)
final B	maximumSize(Dimension maximumSize)
final B	maximumWidth(int maximumWidth)
final B	minimumHeight(int minimumHeight)
final B	minimumSize(Dimension minimumSize)
final B	minimumWidth(int minimumWidth)
final B	mouseListener(MouseListener mouseListener)
final B	mouseMotionListener(MouseMotionListener mouseMotionListener)
final B	mouseWheelListener(MouseWheelListener mouseWheelListener)
final B	onBuild(Consumer<C> onBuild)
final B	onBuildValue(Consumer<ComponentValue<T,C>> onBuildValue)
final B	onSetVisible(Consumer<C> onSetVisible)
final B	opaque(boolean opaque)
final B	popupMenu(Function<C,JPopupMenu> popupMenu)
final B	popupMenuControl(Function<C,Control> popupMenuControl)
final B	popupMenuControls(Function<C,Controls> popupMenuControls)
final B	preferredHeight(int preferredHeight)
final B	preferredSize(Dimension preferredSize)
final B	preferredWidth(int preferredWidth)
final B	propertyChangeListener(PropertyChangeListener propertyChangeListener)
final B	propertyChangeListener(String propertyName, PropertyChangeListener propertyChangeListener)
final ScrollPaneBuilder	scrollPane()
protected final B	self()
protected boolean	supportsNull()
final B	toolTipText(String toolTipText)
final B	transferFocusOnEnter(boolean transferFocusOnEnter)	Note that for JTextArea CTRL is added to move focus forward and CTRL + SHIFT to move it backwards
final B	transferHandler(TransferHandler transferHandler)
final B	validator(Value.Validator<T> validator)
final B	value(T value)	Sets the initial value for the component, unless value(s) have been linked via ComponentBuilder.link(Value) or ComponentBuilder.link(ValueObserver), which then control the inital value.
final B	visible(boolean visible)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractComponentBuilder

protected AbstractComponentBuilder()

AbstractComponentBuilder

protected AbstractComponentBuilder(Value<T> linkedValue)

Note that when a linked value is set via the constructor, it is considered locked and cannot be changed.

Parameters:

linkedValue - the linked value, may be null

Method Details

label

public final B label(JLabel label)

Specified by:

label in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

label - the label for the component

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

focusable

public final B focusable(boolean focusable)

Specified by:

focusable in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

focusable - false if the component should not be focusable

Returns:

this builder instance

See Also:

• Component.setFocusable(boolean)

preferredHeight

public final B preferredHeight(int preferredHeight)

Specified by:

preferredHeight in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

preferredHeight - the preferred component height

Returns:

this builder instance

preferredWidth

public final B preferredWidth(int preferredWidth)

Specified by:

preferredWidth in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

preferredWidth - the preferred component width

Returns:

this builder instance

preferredSize

public final B preferredSize(Dimension preferredSize)

Specified by:

preferredSize in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

preferredSize - the preferred component size

Returns:

this builder instance

See Also:

• JComponent.setPreferredSize(Dimension)

maximumHeight

public final B maximumHeight(int maximumHeight)

Specified by:

maximumHeight in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

maximumHeight - the maximum component height

Returns:

this builder instance

maximumWidth

public final B maximumWidth(int maximumWidth)

Specified by:

maximumWidth in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

maximumWidth - the maximum component width

Returns:

this builder instance

maximumSize

public final B maximumSize(Dimension maximumSize)

Specified by:

maximumSize in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

maximumSize - the maximum component size

Returns:

this builder instance

See Also:

• JComponent.setMaximumSize(Dimension)

minimumHeight

public final B minimumHeight(int minimumHeight)

Specified by:

minimumHeight in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

minimumHeight - the minimum component height

Returns:

this builder instance

minimumWidth

public final B minimumWidth(int minimumWidth)

Specified by:

minimumWidth in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

minimumWidth - the minimum component width

Returns:

this builder instance

minimumSize

public final B minimumSize(Dimension minimumSize)

Specified by:

minimumSize in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

minimumSize - the minimum component size

Returns:

this builder instance

See Also:

• JComponent.setMinimumSize(Dimension)

border

public final B border(Border border)

Specified by:

border in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

border - the component border

Returns:

this builder instance

See Also:

• JComponent.setBorder(Border)

transferFocusOnEnter

public final B transferFocusOnEnter(boolean transferFocusOnEnter)

Description copied from interface: ComponentBuilder

Note that for JTextArea CTRL is added to move focus forward and CTRL + SHIFT to move it backwards

Specified by:

transferFocusOnEnter in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

transferFocusOnEnter - if true then the text field transfer focus on enter (shift-enter for backwards)

Returns:

this builder instance

See Also:

• ComponentBuilder.TRANSFER_FOCUS_ON_ENTER

enabled

public final B enabled(boolean enabled)

Description copied from interface: ComponentBuilder

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

Specified by:

enabled in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

enabled - the enabled state

Returns:

this builder instance

See Also:

• JComponent.setEnabled(boolean)

enabled

public final B enabled(StateObserver enabled)

Specified by:

enabled in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

enabled - the state observer controlling the component enabled status

Returns:

this builder instance

popupMenuControl

public final B popupMenuControl(Function<C,Control> popupMenuControl)

Specified by:

popupMenuControl in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

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

Returns:

this builder instance

popupMenuControls

public final B popupMenuControls(Function<C,Controls> popupMenuControls)

Specified by:

popupMenuControls in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

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

Returns:

this builder instance

popupMenu

public final B popupMenu(Function<C,JPopupMenu> popupMenu)

Specified by:

popupMenu in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

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

Returns:

this builder instance

See Also:

• JComponent.setComponentPopupMenu(JPopupMenu)

toolTipText

public final B toolTipText(String toolTipText)

Specified by:

toolTipText in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

toolTipText - the tool tip text

Returns:

this builder instance

See Also:

• JComponent.setToolTipText(String)

font

public final B font(Font font)

Specified by:

font in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

font - the component font

Returns:

this builder instance

See Also:

• JComponent.setFont(Font)

foreground

public final B foreground(Color foreground)

Specified by:

foreground in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

foreground - the foreground color

Returns:

this builder instance

See Also:

• JComponent.setForeground(Color)

background

public final B background(Color background)

Specified by:

background in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

background - the background color

Returns:

this builder instance

See Also:

• JComponent.setBackground(Color)

opaque

public final B opaque(boolean opaque)

Specified by:

opaque in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

opaque - true if the component should be opaque

Returns:

this builder instance

See Also:

• JComponent.setOpaque(boolean)

visible

public final B visible(boolean visible)

Specified by:

visible in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

visible - the initial component visibility, default true

Returns:

this builder instance

See Also:

• JComponent.setVisible(boolean)

componentOrientation

public final B componentOrientation(ComponentOrientation componentOrientation)

Specified by:

componentOrientation in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

componentOrientation - the component orientation

Returns:

this builder instance

See Also:

• Component.setComponentOrientation(ComponentOrientation)

validator

public final B validator(Value.Validator<T> validator)

Specified by:

validator in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

validator - the validator to use

Returns:

this builder instance

keyEvent

public final B keyEvent(KeyEvents.Builder keyEventBuilder)

Description copied from interface: ComponentBuilder

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

Specified by:

keyEvent in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

keyEventBuilder - a key event builder to enable on the component

Returns:

this builder instance

clientProperty

public final B clientProperty(Object key,
 Object value)

Description copied from interface: ComponentBuilder

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

Specified by:

clientProperty in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

key - the key

value - the value

Returns:

this builder instance

See Also:

• JComponent.putClientProperty(Object, Object)

focusListener

public final B focusListener(FocusListener focusListener)

Specified by:

focusListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

focusListener - the focus listener

Returns:

this builder instance

See Also:

• Component.addFocusListener(FocusListener)

mouseListener

public final B mouseListener(MouseListener mouseListener)

Specified by:

mouseListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

mouseListener - the mouse listener

Returns:

this builder instance

See Also:

• Component.addMouseListener(MouseListener)

mouseMotionListener

public final B mouseMotionListener(MouseMotionListener mouseMotionListener)

Specified by:

mouseMotionListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

mouseMotionListener - the mouse motion listener

Returns:

this builder instance

See Also:

• Component.addMouseMotionListener(MouseMotionListener)

mouseWheelListener

public final B mouseWheelListener(MouseWheelListener mouseWheelListener)

Specified by:

mouseWheelListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

mouseWheelListener - the mouse wheel listener

Returns:

this builder instance

See Also:

• Component.addMouseWheelListener(MouseWheelListener)

keyListener

public final B keyListener(KeyListener keyListener)

Specified by:

keyListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

keyListener - the key listener

Returns:

this builder instance

See Also:

• Component.addKeyListener(KeyListener)

componentListener

public final B componentListener(ComponentListener componentListener)

Specified by:

componentListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

componentListener - the component listener

Returns:

this builder instance

See Also:

• Component.addComponentListener(ComponentListener)

propertyChangeListener

public final B propertyChangeListener(PropertyChangeListener propertyChangeListener)

Specified by:

propertyChangeListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

propertyChangeListener - the property change listener

Returns:

this builder instance

See Also:

• Container.addPropertyChangeListener(PropertyChangeListener)

propertyChangeListener

public final B propertyChangeListener(String propertyName,
 PropertyChangeListener propertyChangeListener)

Specified by:

propertyChangeListener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

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

public final B transferHandler(TransferHandler transferHandler)

Specified by:

transferHandler in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

transferHandler - the transfer handler

Returns:

this builder instance

See Also:

• JComponent.setTransferHandler(TransferHandler)

focusCycleRoot

public final B focusCycleRoot(boolean focusCycleRoot)

Specified by:

focusCycleRoot in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

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

public final B onSetVisible(Consumer<C> onSetVisible)

Specified by:

onSetVisible in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

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

Returns:

this builder instance

link

public final B link(Value<T> linkedValue)

Description copied from interface: ComponentBuilder

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

Specified by:

link in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

linkedValue - a value to link to the component value

Returns:

this builder instance

link

public final B link(ValueObserver<T> linkedValueObserver)

Description copied from interface: ComponentBuilder

Creates a read-only link to the given ValueObserver.

Specified by:

link in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

linkedValueObserver - a value to link to the component value

Returns:

this builder instance

listener

public final B listener(Runnable listener)

Specified by:

listener in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

listener - a listener to add to the resulting component value

Returns:

this builder instance

consumer

public final B consumer(Consumer<T> consumer)

Specified by:

consumer in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

consumer - a consumer to add to the resulting component value

Returns:

this builder instance

value

public final B value(T value)

Description copied from interface: ComponentBuilder

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

Specified by:

value in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

value - the initial value

Returns:

this builder instance

scrollPane

public final ScrollPaneBuilder scrollPane()

Specified by:

scrollPane in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Returns:

a ScrollPaneBuilder using this component as the view

onBuild

public final B onBuild(Consumer<C> onBuild)

Specified by:

onBuild in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

onBuild - called when the component has been built.

Returns:

this builder instance

onBuildValue

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

Specified by:

onBuildValue in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

onBuildValue - called when the component value has been built.

Returns:

this builder instance

build

public final C build()

Description copied from interface: ComponentBuilder

Builds a new component instance.

Specified by:

build in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Returns:

the component

build

public final C build(Consumer<C> onBuild)

Description copied from interface: ComponentBuilder

Builds a new component instance.

Specified by:

build in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

onBuild - called after the component is built.

Returns:

the component

buildValue

public final ComponentValue<T,C> buildValue()

Description copied from interface: ComponentBuilder

Builds and returns the component value.

Specified by:

buildValue in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Returns:

the component value

buildValue

public final ComponentValue<T,C> buildValue(Consumer<ComponentValue<T,C>> onBuild)

Description copied from interface: ComponentBuilder

Builds and returns the component value.

Specified by:

buildValue in interface ComponentBuilder<T,C extends JComponent,B extends ComponentBuilder<T,C,B>>

Parameters:

onBuild - called after the component value is built.

Returns:

the component value

createComponent

protected abstract C createComponent()

Creates the component.

Returns:

a new component instance

createComponentValue

protected abstract ComponentValue<T,C> createComponentValue(C component)

Creates the component value

Parameters:

component - the component

Returns:

a component value based on the component

supportsNull

protected boolean supportsNull()

Returns:

true if this component can be linked with a nullable value

enableTransferFocusOnEnter

protected void enableTransferFocusOnEnter(C component)

Enables focus transfer on Enter, override for special handling

Parameters:

component - the component

self

protected final B self()