Module is.codion.swing.common.ui

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

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

java.lang.Object

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

All Implemented Interfaces:

ComponentBuilder<C,B>, Supplier<C>

Direct Known Subclasses:

AbstractComponentValueBuilder

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentBuilder()

Method Summary

Modifier and Type	Method	Description
final B	background(@Nullable Color background)
final B	border(@Nullable Border border)
final C	build()	Builds a new component instance.
final C	build(@Nullable Consumer<C> onBuild)	Builds a new component instance.
final B	clientProperty(Object key, @Nullable Object value)	Adds an arbitrary key/value "client property" to the component
final B	componentListener(ComponentListener componentListener)
final B	componentOrientation(@Nullable ComponentOrientation componentOrientation)
protected C	configureComponent(C component)
protected abstract C	createComponent()	Creates the component.
final B	enabled(boolean enabled)	Sets the enabled state of the component, for a dynamic enabled state use ComponentBuilder.enabled(ObservableState).
final B	enabled(@Nullable ObservableState enabled)
protected void	enableTransferFocusOnEnter(C component, TransferFocusOnEnter transferFocusOnEnter)	Enables focus transfer on Enter, override for special handling
protected void	enableValidIndicator(ValidIndicatorFactory validIndicatorFactory, C component, ObservableState valid)	Enables a valid indicator on the given component, based on the given valid state instance using the given ValidIndicatorFactory, override for special handling.
final B	focusable(boolean focusable)	Sets the focusable state of the component, for a dynamic focusable state use ComponentBuilder.focusable(ObservableState).
final B	focusable(@Nullable ObservableState focusable)
final B	focusCycleRoot(boolean focusCycleRoot)
final B	focusListener(FocusListener focusListener)
final B	font(@Nullable Font font)	Overrides ComponentBuilder.font(UnaryOperator).
final B	font(UnaryOperator<Font> font)	Derives the component font from its default font.
final B	foreground(@Nullable 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(Consumer<LabelBuilder<String>> label)	Is overridden by ComponentBuilder.label(JLabel).
final B	label(@Nullable JLabel label)	Clears any label builder previously configured via ComponentBuilder.label(Consumer).
final B	maximumHeight(int maximumHeight)
final B	maximumSize(@Nullable Dimension maximumSize)
final B	maximumWidth(int maximumWidth)
final B	minimumHeight(int minimumHeight)
final B	minimumSize(@Nullable Dimension minimumSize)
final B	minimumWidth(int minimumWidth)
final B	mouseListener(MouseListener mouseListener)
final B	mouseMotionListener(MouseMotionListener mouseMotionListener)
final B	mouseWheelListener(MouseWheelListener mouseWheelListener)
final B	name(@Nullable String name)
final B	onBuild(Consumer<C> onBuild)
final B	onSetVisible(Consumer<C> onSetVisible)
final B	opaque(boolean opaque)
final B	popupMenu(@Nullable 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(@Nullable 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(@Nullable Observable<String> toolTipText)	Overrides ComponentBuilder.toolTipText(String)
final B	toolTipText(@Nullable String toolTipText)
final B	transferFocusOnEnter(boolean transferFocusOnEnter)	Note that in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.
final B	transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)	Note that in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.
final B	transferHandler(@Nullable TransferHandler transferHandler)
final B	visible(boolean visible)	Sets the visible state of the component, for a dynamic visible state use ComponentBuilder.visible(ObservableState).
final B	visible(@Nullable ObservableState visible)

Methods inherited from class java.lang.Object

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

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

get

Constructor Details

AbstractComponentBuilder

protected AbstractComponentBuilder()

Method Details

name

public final B name(@Nullable String name)

Specified by:

name in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

name - the name to assign to the component

Returns:

this builder instance

See Also:

• Component.setName(String)

label

public final B label(@Nullable JLabel label)

Description copied from interface: ComponentBuilder

Clears any label builder previously configured via ComponentBuilder.label(Consumer).

Specified by:

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

Parameters:

label - the label for the component

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

label

public final B label(Consumer<LabelBuilder<String>> label)

Description copied from interface: ComponentBuilder

Is overridden by ComponentBuilder.label(JLabel).

Specified by:

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

Parameters:

label - configures the component label builder

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

focusable

public final B focusable(boolean focusable)

Description copied from interface: ComponentBuilder

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

Specified by:

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

Parameters:

focusable - the initial component focusability, default true

Returns:

this builder instance

See Also:

• Component.setFocusable(boolean)

focusable

public final B focusable(@Nullable ObservableState focusable)

Specified by:

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

Parameters:

focusable - the state controlling the component focusable state

Returns:

this builder instance

See Also:

• Component.setFocusable(boolean)

preferredHeight

public final B preferredHeight(int preferredHeight)

Specified by:

preferredHeight in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

preferredWidth - the preferred component width

Returns:

this builder instance

preferredSize

public final B preferredSize(@Nullable Dimension preferredSize)

Specified by:

preferredSize in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

maximumWidth - the maximum component width

Returns:

this builder instance

maximumSize

public final B maximumSize(@Nullable Dimension maximumSize)

Specified by:

maximumSize in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

minimumWidth - the minimum component width

Returns:

this builder instance

minimumSize

public final B minimumSize(@Nullable Dimension minimumSize)

Specified by:

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

Parameters:

minimumSize - the minimum component size

Returns:

this builder instance

See Also:

• JComponent.setMinimumSize(Dimension)

border

public final B border(@Nullable Border border)

Specified by:

border in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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 in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.

Specified by:

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

Parameters:

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

Returns:

this builder instance

transferFocusOnEnter

public final B transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)

Description copied from interface: ComponentBuilder

Note that in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.

Specified by:

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

Parameters:

transferFocusOnEnter - the transfer focus on enter to enable

Returns:

this builder instance

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(ObservableState). Overridden by ComponentBuilder.enabled(ObservableState).

Specified by:

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

Parameters:

enabled - the enabled state

Returns:

this builder instance

See Also:

• JComponent.setEnabled(boolean)

enabled

public final B enabled(@Nullable ObservableState enabled)

Specified by:

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

Parameters:

enabled - the state controlling the component enabled status

Returns:

this builder instance

popupMenuControl

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

Specified by:

popupMenuControl in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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(@Nullable Function<C,JPopupMenu> popupMenu)

Specified by:

popupMenu in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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(@Nullable String toolTipText)

Specified by:

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

Parameters:

toolTipText - a static tool tip text

Returns:

this builder instance

See Also:

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

toolTipText

public final B toolTipText(@Nullable Observable<String> toolTipText)

Description copied from interface: ComponentBuilder

Overrides ComponentBuilder.toolTipText(String)

Specified by:

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

Parameters:

toolTipText - a dynamic tool tip text

Returns:

this builder instance

See Also:

• JComponent.setToolTipText(String)

font

public final B font(@Nullable Font font)

Description copied from interface: ComponentBuilder

Overrides ComponentBuilder.font(UnaryOperator).

Specified by:

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

Parameters:

font - the component font

Returns:

this builder instance

See Also:

• JComponent.setFont(Font)

font

public final B font(UnaryOperator<Font> font)

Description copied from interface: ComponentBuilder

Derives the component font from its default font. The operator is applied to the component's default font during build.

Is overridden by a font set via ComponentBuilder.font(Font).

Specified by:

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

Parameters:

font - provides the font to use, given the component's default font

Returns:

this builder instance

See Also:

• JComponent.setFont(Font)
• Component.getFont()

foreground

public final B foreground(@Nullable Color foreground)

Specified by:

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

Parameters:

foreground - the foreground color

Returns:

this builder instance

See Also:

• JComponent.setForeground(Color)

background

public final B background(@Nullable Color background)

Specified by:

background in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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)

Description copied from interface: ComponentBuilder

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

Specified by:

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

Parameters:

visible - the initial component visibility, default true

Returns:

this builder instance

See Also:

• JComponent.setVisible(boolean)

visible

public final B visible(@Nullable ObservableState visible)

Specified by:

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

Parameters:

visible - the state controlling the component visible state

Returns:

this builder instance

See Also:

• JComponent.setVisible(boolean)

componentOrientation

public final B componentOrientation(@Nullable ComponentOrientation componentOrientation)

Specified by:

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

Parameters:

componentOrientation - the component orientation

Returns:

this builder instance

See Also:

• Component.setComponentOrientation(ComponentOrientation)

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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

keyEventBuilder - a key event builder to enable on the component

Returns:

this builder instance

clientProperty

public final B clientProperty(Object key,
 @Nullable Object value)

Description copied from interface: ComponentBuilder

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

Specified by:

clientProperty in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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(@Nullable TransferHandler transferHandler)

Specified by:

transferHandler in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

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

Returns:

this builder instance

scrollPane

public final ScrollPaneBuilder scrollPane()

Specified by:

scrollPane in interface ComponentBuilder<C extends JComponent,B extends ComponentBuilder<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<C extends JComponent,B extends ComponentBuilder<C,B>>

Parameters:

onBuild - called when the component 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<C extends JComponent,B extends ComponentBuilder<C,B>>

Returns:

the component

build

public final C build(@Nullable Consumer<C> onBuild)

Description copied from interface: ComponentBuilder

Builds a new component instance.

Specified by:

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

Parameters:

onBuild - called after the component is built.

Returns:

the component

createComponent

protected abstract C createComponent()

Creates the component.

Returns:

a new component instance

supportsNull

protected boolean supportsNull()

Returns:

true if this component can be linked with a nullable value

enableTransferFocusOnEnter

protected void enableTransferFocusOnEnter(C component,
 TransferFocusOnEnter transferFocusOnEnter)

Enables focus transfer on Enter, override for special handling

Parameters:

component - the component

transferFocusOnEnter - the transfer focus on enter to enable

enableValidIndicator

protected void enableValidIndicator(ValidIndicatorFactory validIndicatorFactory,
 C component,
 ObservableState valid)

Enables a valid indicator on the given component, based on the given valid state instance using the given ValidIndicatorFactory, override for special handling.

Parameters:

validIndicatorFactory - the ValidIndicatorFactory to use

component - the component

valid - the valid state to indicate

self

protected final B self()

configureComponent

protected C configureComponent(C component)