Module is.codion.swing.common.ui

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

Class AbstractComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

java.lang.Object

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

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

All Implemented Interfaces:

ComponentBuilder<C,B>, ComponentValueBuilder<C,T,B>, Supplier<C>

Direct Known Subclasses:

DefaultComboBoxBuilder

public abstract class AbstractComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>
extends AbstractComponentBuilder<C,B>
implements ComponentValueBuilder<C,T,B>

Field Summary

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

COMPONENT_VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentValueBuilder()

Method Summary

Modifier and Type	Method	Description
final ComponentValue<C,T>	buildValue()	Builds and returns the component value.
final ComponentValue<C,T>	buildValue(@Nullable Consumer<ComponentValue<C,T>> onBuild)	Builds and returns the component value.
protected final C	configureComponent(C component)
final B	consumer(Consumer<T> consumer)
protected abstract ComponentValue<C,T>	createComponentValue(C component)	Creates the component value
final B	link(Observable<T> linkedObservable)	Creates a read-only link to the given Observable.
final B	link(Value<T> linkedValue)	Creates a bidirectional link to the given value.
final B	listener(Runnable listener)
final B	modifiedIndicator(@Nullable ObservableState modified)	Enables a modified indicator based on the given modified state.
final B	modifiedIndicatorFactory(@Nullable ModifiedIndicatorFactory modifiedIndicatorFactory)	By default UnderlineModifiedIndicatorFactory.
final B	onBuildValue(Consumer<ComponentValue<C,T>> onBuildValue)
final B	validator(Value.Validator<T> validator)
final B	validIndicator(@Nullable ObservableState valid)	Enables a valid indicator based on the given valid state.
final B	validIndicator(@Nullable Predicate<T> validator)	Enables a valid indicator based on the given validator.
final B	validIndicatorFactory(@Nullable ValidIndicatorFactory validIndicatorFactory)
final B	value(@Nullable T value)	Sets the initial value for the component, unless value(s) have been linked via ComponentValueBuilder.link(Value) or ComponentValueBuilder.link(Observable), which then control the inital value.

Methods inherited from class is.codion.swing.common.ui.component.builder.AbstractComponentBuilder

background, border, build, build, clientProperty, componentListener, componentOrientation, createComponent, enabled, enabled, enableTransferFocusOnEnter, enableValidIndicator, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, keyEvent, keyListener, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, self, supportsNull, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, 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

background, border, build, build, clientProperty, componentListener, componentOrientation, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, get, keyEvent, keyListener, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupMenu, popupMenuControl, popupMenuControls, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, toolTipText, toolTipText, transferFocusOnEnter, transferFocusOnEnter, transferHandler, visible, visible

Constructor Details

AbstractComponentValueBuilder

protected AbstractComponentValueBuilder()

Method Details

validIndicatorFactory

public final B validIndicatorFactory(@Nullable ValidIndicatorFactory validIndicatorFactory)

Specified by:

validIndicatorFactory in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

validIndicatorFactory - the ValidIndicatorFactory to use, null for none

Returns:

this builder instance

See Also:

• ValidIndicatorFactory.instance()

validIndicator

public final B validIndicator(@Nullable ObservableState valid)

Description copied from interface: ComponentValueBuilder

Enables a valid indicator based on the given valid state.

Specified by:

validIndicator in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

valid - the valid state

Returns:

this builder instance

See Also:

• ComponentValueBuilder.validIndicatorFactory(ValidIndicatorFactory)
• ValidIndicatorFactory

validIndicator

public final B validIndicator(@Nullable Predicate<T> validator)

Description copied from interface: ComponentValueBuilder

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

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

Specified by:

validIndicator in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

validator - called each time the component value changes

Returns:

this builder instance

See Also:

• ComponentValueBuilder.validIndicatorFactory(ValidIndicatorFactory)
• ValidIndicatorFactory

modifiedIndicatorFactory

public final B modifiedIndicatorFactory(@Nullable ModifiedIndicatorFactory modifiedIndicatorFactory)

Description copied from interface: ComponentValueBuilder

By default UnderlineModifiedIndicatorFactory.

Specified by:

modifiedIndicatorFactory in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

modifiedIndicatorFactory - the ModifiedIndicatorFactory to use, null for none

Returns:

this builder instance

modifiedIndicator

public final B modifiedIndicator(@Nullable ObservableState modified)

Description copied from interface: ComponentValueBuilder

Enables a modified indicator based on the given modified state.

Specified by:

modifiedIndicator in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

modified - the modified state

Returns:

this builder instance

See Also:

• ComponentValueBuilder.modifiedIndicatorFactory(ModifiedIndicatorFactory)

validator

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

Specified by:

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

Parameters:

validator - the validator to use

Returns:

this builder instance

link

public final B link(Value<T> linkedValue)

Description copied from interface: ComponentValueBuilder

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

Specified by:

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

Parameters:

linkedValue - a value to link to the component value

Returns:

this builder instance

link

public final B link(Observable<T> linkedObservable)

Description copied from interface: ComponentValueBuilder

Creates a read-only link to the given Observable.

Specified by:

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

Parameters:

linkedObservable - a value to link to the component value

Returns:

this builder instance

listener

public final B listener(Runnable listener)

Specified by:

listener in interface ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,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 ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

consumer - a consumer to add to the resulting component value

Returns:

this builder instance

value

public final B value(@Nullable T value)

Description copied from interface: ComponentValueBuilder

Sets the initial value for the component, unless value(s) have been linked via ComponentValueBuilder.link(Value) or ComponentValueBuilder.link(Observable), 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 ComponentValueBuilder<C extends JComponent,T,B extends ComponentValueBuilder<C,T,B>>

Parameters:

value - the initial value

Returns:

this builder instance

onBuildValue

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

Specified by:

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

Parameters:

onBuildValue - called when the component value has been built.

Returns:

this builder instance

buildValue

public final ComponentValue<C,T> buildValue()

Description copied from interface: ComponentValueBuilder

Builds and returns the component value.

Specified by:

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

Returns:

the component value

buildValue

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

Description copied from interface: ComponentValueBuilder

Builds and returns the component value.

Specified by:

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

Parameters:

onBuild - called after the component value is built.

Returns:

the component value

configureComponent

protected final C configureComponent(C component)

Overrides:

configureComponent in class AbstractComponentBuilder<C extends JComponent,B extends ComponentValueBuilder<C,T,B>>

createComponentValue

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

Creates the component value

Parameters:

component - the component

Returns:

a component value based on the component