Module is.codion.swing.common.ui

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

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

Type Parameters:

C - the component type

B - the builder type

All Superinterfaces:

Supplier<C>

All Known Subinterfaces:

BorderLayoutPanelBuilder, ButtonBuilder<C,T,B>, ButtonPanelBuilder, CheckBoxBuilder, CheckBoxMenuItemBuilder<B>, ComboBoxBuilder<C,T,B>, ComponentValueBuilder<C,T,B>, ControlPanelBuilder<C,B>, EntityComboBox.Builder, EntityComboBoxInput.Builder, EntitySearchField.Builder, EntitySearchInput.Builder, FileInput.Builder<T>, FilterList.Builder<V,T,B>, FilterList.Builder.Items<T>, FilterList.Builder.SelectedItem<T>, FilterList.Builder.SelectedItems<T>, FilterTable.Builder<R,C>, FlexibleGridLayoutPanelBuilder, FlowLayoutPanelBuilder, GridLayoutPanelBuilder, ImagePane.Builder, InputPanelBuilder, ItemComboBoxBuilder<T>, ItemSpinnerBuilder<T>, LabelBuilder<T>, LayoutPanelBuilder, ListSpinnerBuilder<T>, MaskedTextFieldBuilder, MenuBuilder, MenuItemBuilder<B>, MultiInput.Builder<C,T>, NullableCheckBoxBuilder, NumberField.Builder<T>, NumberSpinnerBuilder<T>, PanelBuilder<L,B>, PasswordFieldBuilder, ProgressBarBuilder, RadioButtonBuilder, RadioButtonMenuItemBuilder<B>, ScrollPaneBuilder, SliderBuilder, SpinnerBuilder<T,B>, SplitPaneBuilder, TabbedPaneBuilder, TemporalField.Builder<T>, TemporalInput.Builder<T>, TextAreaBuilder, TextComponentBuilder<C,T,B>, TextFieldBuilder<C,T,B>, TextInput.Builder, TextPaneBuilder, ToggleButtonBuilder<C,B>, ToggleMenuItemBuilder<C,B>, ToolBarBuilder, TreeBuilder

All Known Implementing Classes:

AbstractComponentBuilder, AbstractComponentValueBuilder, DefaultComboBoxBuilder

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

Builds a component.

See Also:

• build()
• build(Consumer)

Method Summary

Modifier and Type	Method	Description
B	ancestorListener(AncestorListener ancestorListener)
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.
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	enabled(boolean enabled)	Sets the enabled state of the component, for a dynamic enabled state use enabled(ObservableState).
B	enabled(@Nullable ObservableState enabled)	Overrides enabled(boolean).
B	focusable(boolean focusable)	Sets the focusable state of the component, for a dynamic focusable state use focusable(ObservableState).
B	focusable(@Nullable ObservableState focusable)	Overrides focusable(boolean).
B	focusCycleRoot(boolean focusCycleRoot)
B	focusListener(FocusListener focusListener)
B	font(@Nullable Font font)	Overrides font(UnaryOperator).
B	font(UnaryOperator<Font> font)	Derives the component font from its default font.
B	foreground(@Nullable Color foreground)
default C	get()
B	hierarchyListener(HierarchyListener hierarchyListener)
B	keyEvent(KeyEvents.Builder keyEventBuilder)	Enables the key event defined by the given KeyEvents.Builder on the component.
B	keyListener(KeyListener keyListener)
B	label(String text)	Specifies the label text.
B	label(Consumer<LabelBuilder<String>> label)	Configures the label.
B	label(@Nullable JLabel label)	Specifies the label itself, replacing anything specified via label(String) or label(Consumer), as they in turn replace the label specified here.
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	mouseListener(MouseListener mouseListener)
B	mouseMotionListener(MouseMotionListener mouseMotionListener)
B	mouseWheelListener(MouseWheelListener mouseWheelListener)
B	name(@Nullable String name)
B	onBuild(Consumer<C> onBuild)
B	onSetVisible(Consumer<C> onSetVisible)
B	opaque(boolean opaque)
B	popupControl(Function<C,Control> popupMenuControl)	Overridden by popupMenu(Function).
B	popupControls(BiConsumer<C,ControlsBuilder> popupMenuControl)	Use ControlsBuilder.removeAll() in order to clear any previously added controls.
B	popupControls(Function<C,Controls> popupMenuControls)	Overridden by popupMenu(Function).
B	popupMenu(@Nullable Function<C,JPopupMenu> popupMenu)	Overrides popupControls(Function), popupControls(BiConsumer) and popupControl(Function).
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)	Overridden by toolTipText(Observable).
B	transferFocusOnEnter(boolean transferFocusOnEnter)	Note that in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.
B	transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)	Note that in case of JTextArea the KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.
B	transferHandler(@Nullable TransferHandler transferHandler)
B	visible(boolean visible)	Sets the visible state of the component, for a dynamic visible state use visible(ObservableState).
B	visible(@Nullable ObservableState visible)	Overrides visible(boolean).

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(String text)

Specifies the label text. Adds to whatever label(Consumer) has specified, and replaces a label specified via label(JLabel).

Parameters:

text - the label text

Returns:

this builder instance

label

B label(@Nullable JLabel label)

Specifies the label itself, replacing anything specified via label(String) or label(Consumer), as they in turn replace the label specified here.

Parameters:

label - the label for the component

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

label

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

Configures the label. Adds to whatever label(String) and previous calls to this method have specified, and replaces a label specified via label(JLabel).

Parameters:

label - configures the component label builder

Returns:

this builder instance

See Also:

• JLabel.setLabelFor(Component)

focusable

B focusable(boolean focusable)

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

Parameters:

focusable - the initial component focusability, default true

Returns:

this builder instance

See Also:

• Component.setFocusable(boolean)

focusable

B focusable(@Nullable ObservableState focusable)

Overrides focusable(boolean).

Parameters:

focusable - the state controlling the component focusable state

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 KeyEvents.MENU_SHORTCUT_MASK modifier is added for transferring the focus forward.

Parameters:

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

Returns:

this builder instance

transferFocusOnEnter

B transferFocusOnEnter(TransferFocusOnEnter transferFocusOnEnter)

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

Any conflicting key event added via keyEvent(KeyEvents.Builder) overrides this directive.

Parameters:

transferFocusOnEnter - the transfer focus on enter to enable

Returns:

this builder instance

See Also:

• keyEvent(KeyEvents.Builder)

toolTipText

B toolTipText(@Nullable String toolTipText)

Overridden by toolTipText(Observable).

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)

Overrides enabled(boolean).

Parameters:

enabled - the state controlling the component enabled status

Returns:

this builder instance

popupControl

B popupControl(Function<C,Control> popupMenuControl)

Overridden by popupMenu(Function).

Parameters:

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

Returns:

this builder instance

popupControls

B popupControls(Function<C,Controls> popupMenuControls)

Overridden by popupMenu(Function).

Parameters:

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

Returns:

this builder instance

popupControls

B popupControls(BiConsumer<C,ControlsBuilder> popupMenuControl)

Use ControlsBuilder.removeAll() in order to clear any previously added controls. Overridden by popupMenu(Function).

Parameters:

popupMenuControl - a function, receiving the component being built and the ControlsBuilder on which to base the popup menu.

Returns:

this builder instance

See Also:

• popupControl(Function)
• popupControls(Function)

popupMenu

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

Overrides popupControls(Function), popupControls(BiConsumer) and popupControl(Function).

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)

Overrides font(UnaryOperator).

Parameters:

font - the component font

Returns:

this builder instance

See Also:

• JComponent.setFont(Font)

font

B font(UnaryOperator<Font> font)

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

Overridden by font(Font).

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

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)

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

Parameters:

visible - the initial component visibility, default true

Returns:

this builder instance

See Also:

• JComponent.setVisible(boolean)

visible

B visible(@Nullable ObservableState visible)

Overrides visible(boolean).

Parameters:

visible - the state controlling the component visible state

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)

keyEvent

B keyEvent(KeyEvents.Builder keyEventBuilder)

Enables the key event defined by the given KeyEvents.Builder on the component.

Note that adding a key event conflicting with transferFocusOnEnter(boolean) disables focus transfer on Enter.

Parameters:

keyEventBuilder - a key event builder to enable on the component

Returns:

this builder instance

See Also:

• transferFocusOnEnter(boolean)

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)

ancestorListener

B ancestorListener(AncestorListener ancestorListener)

Parameters:

ancestorListener - the ancestor listener

Returns:

this builder instance

See Also:

• JComponent.addAncestorListener(AncestorListener)

hierarchyListener

B hierarchyListener(HierarchyListener hierarchyListener)

Parameters:

hierarchyListener - the hierarchy listener

Returns:

this builder instance

See Also:

• Component.addHierarchyListener(HierarchyListener)

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

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

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

get

default C get()

Specified by:

get in interface Supplier<C extends JComponent>