Module is.codion.swing.common.ui

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

Class AbstractComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<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>

is.codion.swing.common.ui.component.combobox.AbstractComboBoxBuilder<C,T,B>

Type Parameters:

C - the component type

T - the value type

B - the builder type

All Implemented Interfaces:

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

public abstract class AbstractComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>
extends AbstractComponentValueBuilder<C,T,B>
implements ComboBoxBuilder<C,T,B>

A base class for ComboBoxBuilder implementations, extendable in order to build combo box subclasses. ComboBoxBuilder.builder() provides one building a JComboBox.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.swing.common.ui.component.combobox.ComboBoxBuilder

ComboBoxBuilder.ModelStep

Field Summary

Fields

Modifier and Type	Field	Description
protected final ComboBoxModel<T>	comboBoxModel

Fields inherited from interface is.codion.swing.common.ui.component.combobox.ComboBoxBuilder

MOUSE_WHEEL_SCROLLING

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

COMPONENT_VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComboBoxBuilder(ComboBoxModel<T> comboBoxModel)

Method Summary

Modifier and Type	Method	Description
final B	completionMode(Completion.Mode completionMode)
protected C	createComboBox()
protected final C	createComponent()	Creates the component.
protected final ComponentValue<C,T>	createValue(C component)	Creates the component value
final B	editable(boolean editable)
final B	editor(@Nullable ComboBoxEditor editor)
final B	enterAction(Action action)	Adds an action for Enter, consulted after the ones already added, see ComboBoxBuilder.addEnterAction(JComboBox, Action).
final B	itemListener(ItemListener itemListener)
final B	maximumRowCount(int maximumRowCount)
final B	mouseWheelScrolling(boolean mouseWheelScrolling)	Enable mouse wheel scrolling on the combo box
final B	mouseWheelScrollingWithWrapAround(boolean mouseWheelScrollingWithWrapAround)	Enable mouse wheel scrolling on the combo box, with wrap around
final B	moveCaretToFrontOnSelection(boolean moveCaretToFrontOnSelection)	When a JComboBox is editable, and a long item is selected, the caret is moved to the end, hiding the start of the selected item.
final B	normalize(boolean normalize)	Specifies whether to normalize strings during auto-completion
final B	popupWidth(int popupWidth)	Only applicable for the system and cross-platform Look and Feels.
final B	renderer(@Nullable ListCellRenderer<? super T> renderer)
protected void	setName(C component, String name)	Sets the component name, override this method to set the name of composite components

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

buildValue, buildValue, changeConsumer, changeListener, configureComponent, consumer, enable, enable, link, link, listener, modified, modifiedIndicator, onBuildValue, supportsNull, valid, valid, validationIndicator, validator, value, warned, weakChangeConsumer, weakChangeListener, weakConsumer, weakListener, when, when, when, when

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

ancestorListener, background, border, build, build, clientProperty, componentListener, componentOrientation, enable, enabled, enabled, focusable, focusable, focusCycleRoot, focusListener, font, font, foreground, hierarchyListener, input, keyEvent, keyListener, label, label, label, label, maximumHeight, maximumSize, maximumWidth, minimumHeight, minimumSize, minimumWidth, mouseListener, mouseMotionListener, mouseWheelListener, name, onBuild, onSetVisible, opaque, popupControl, popupControls, popupControls, popupMenu, preferredHeight, preferredSize, preferredWidth, propertyChangeListener, propertyChangeListener, scrollPane, self, 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

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

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

buildValue, buildValue, changeConsumer, changeListener, consumer, link, link, listener, modified, modifiedIndicator, onBuildValue, valid, valid, validationIndicator, validator, value, warned, weakChangeConsumer, weakChangeListener, weakConsumer, weakListener, when, when, when, when

Field Details

comboBoxModel

protected final ComboBoxModel<T> comboBoxModel

Constructor Details

AbstractComboBoxBuilder

protected AbstractComboBoxBuilder(ComboBoxModel<T> comboBoxModel)

Method Details

editable

public final B editable(boolean editable)

Specified by:

editable in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

editable - specifies whether the combo box should be editable

Returns:

this builder instance

See Also:

• JComboBox.setEditable(boolean)

completionMode

public final B completionMode(Completion.Mode completionMode)

Specified by:

completionMode in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

completionMode - the completion mode

Returns:

this builder instance

normalize

public final B normalize(boolean normalize)

Description copied from interface: ComboBoxBuilder

Specifies whether to normalize strings during auto-completion

Specified by:

normalize in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

normalize - true if strings should be normalized during autocomplete

Returns:

this builder instance

See Also:

• ComboBoxBuilder.completionMode(Completion.Mode)

renderer

public final B renderer(@Nullable ListCellRenderer<? super T> renderer)

Specified by:

renderer in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

renderer - the renderer for the combo box

Returns:

this builder instance

See Also:

• JComboBox.setRenderer(ListCellRenderer)

editor

public final B editor(@Nullable ComboBoxEditor editor)

Specified by:

editor in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

editor - the editor for the combo box

Returns:

this builder instance

See Also:

• JComboBox.setEditor(ComboBoxEditor)

mouseWheelScrolling

public final B mouseWheelScrolling(boolean mouseWheelScrolling)

Description copied from interface: ComboBoxBuilder

Enable mouse wheel scrolling on the combo box

Specified by:

mouseWheelScrolling in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

mouseWheelScrolling - true if mouse wheel scrolling should be enabled

Returns:

this builder instance

See Also:

• ComboBoxBuilder.MOUSE_WHEEL_SCROLLING

mouseWheelScrollingWithWrapAround

public final B mouseWheelScrollingWithWrapAround(boolean mouseWheelScrollingWithWrapAround)

Description copied from interface: ComboBoxBuilder

Enable mouse wheel scrolling on the combo box, with wrap around

Specified by:

mouseWheelScrollingWithWrapAround in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

mouseWheelScrollingWithWrapAround - true if mouse wheel scrolling with wrap around should be enabled

Returns:

this builder instance

maximumRowCount

public final B maximumRowCount(int maximumRowCount)

Specified by:

maximumRowCount in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

maximumRowCount - the maximum row count before a scroll bar is shown

Returns:

this builder instance

See Also:

• JComboBox.setMaximumRowCount(int)

moveCaretToFrontOnSelection

public final B moveCaretToFrontOnSelection(boolean moveCaretToFrontOnSelection)

Description copied from interface: ComboBoxBuilder

When a JComboBox is editable, and a long item is selected, the caret is moved to the end, hiding the start of the selected item. Enabling this moves the caret to the front on selection, thereby showing the start of the selected item. Note that this only works in conjunction with a SwingFilterComboBoxModel. This is enabled by default.

Specified by:

moveCaretToFrontOnSelection in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

moveCaretToFrontOnSelection - if true the caret is moved to the front of the editor component on selection, displaying the start of the selected item, instead of the end

Returns:

this builder instance

popupWidth

public final B popupWidth(int popupWidth)

Description copied from interface: ComboBoxBuilder

Only applicable for the system and cross-platform Look and Feels.

Specified by:

popupWidth in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

popupWidth - a fixed popup width

Returns:

this builder instance

itemListener

public final B itemListener(ItemListener itemListener)

Specified by:

itemListener in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

itemListener - the item listener

Returns:

this builder instance

See Also:

• JComboBox.addItemListener(ItemListener)

enterAction

public final B enterAction(Action action)

Description copied from interface: ComboBoxBuilder

Adds an action for Enter, consulted after the ones already added, see ComboBoxBuilder.addEnterAction(JComboBox, Action). Note that this disables ComponentBuilder.transferFocusOnEnter(boolean), which would otherwise take the Enter key.

Specified by:

enterAction in interface ComboBoxBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

action - the action

Returns:

this builder instance

createComponent

protected final C createComponent()

Description copied from class: AbstractComponentBuilder

Creates the component.

Specified by:

createComponent in class AbstractComponentBuilder<C extends JComboBox<T>,B extends ComboBoxBuilder<C,T,B>>

Returns:

a new component instance

createValue

protected final ComponentValue<C,T> createValue(C component)

Description copied from class: AbstractComponentValueBuilder

Creates the component value

Specified by:

createValue in class AbstractComponentValueBuilder<C extends JComboBox<T>,T,B extends ComboBoxBuilder<C,T,B>>

Parameters:

component - the component

Returns:

a component value based on the component

createComboBox

protected C createComboBox()

setName

protected void setName(C component,
 String name)

Description copied from class: AbstractComponentBuilder

Sets the component name, override this method to set the name of composite components

Overrides:

setName in class AbstractComponentBuilder<C extends JComboBox<T>,B extends ComboBoxBuilder<C,T,B>>

Parameters:

component - the component

name - the name