Module is.codion.swing.common.ui

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

Interface ItemComboBoxBuilder<T>

Type Parameters:

T - the value type

All Superinterfaces:

ComponentBuilder<JComboBox<Item<T>>,ItemComboBoxBuilder<T>>, ComponentValueBuilder<T,JComboBox<Item<T>>,ItemComboBoxBuilder<T>>, Supplier<JComboBox<Item<T>>>

public interface ItemComboBoxBuilder<T>
extends ComponentValueBuilder<T,JComboBox<Item<T>>,ItemComboBoxBuilder<T>>

Builds a item combo box.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemComboBoxBuilder.BuilderFactory	Provides a ItemComboBoxBuilder

Field Summary

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

COMPONENT_VALUE

Method Summary

Modifier and Type	Method	Description
static ItemComboBoxBuilder.BuilderFactory	builder()
ItemComboBoxBuilder<T>	comparator(@Nullable Comparator<Item<T>> comparator)
ItemComboBoxBuilder<T>	completionMode(Completion.Mode completionMode)
ItemComboBoxBuilder<T>	editor(@Nullable ComboBoxEditor editor)
ItemComboBoxBuilder<T>	itemListener(ItemListener itemListener)
ItemComboBoxBuilder<T>	maximumRowCount(int maximumRowCount)
ItemComboBoxBuilder<T>	mouseWheelScrolling(boolean mouseWheelScrolling)	Enable mouse wheel scrolling on the combo box
ItemComboBoxBuilder<T>	mouseWheelScrollingWithWrapAround(boolean mouseWheelScrollingWithWrapAround)	Enable mouse wheel scrolling on the combo box, with wrap around
ItemComboBoxBuilder<T>	normalize(boolean normalize)	Specifies whether to normalize strings during auto-completion
ItemComboBoxBuilder<T>	nullable(boolean nullable)
ItemComboBoxBuilder<T>	popupWidth(int popupWidth)	Only used for the system and cross-platform Look and Feels.
ItemComboBoxBuilder<T>	renderer(@Nullable ListCellRenderer<Item<T>> renderer)
ItemComboBoxBuilder<T>	sorted(boolean sorted)	Sorts the items by caption, false by default

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, 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

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

buildValue, buildValue, consumer, link, link, listener, modifiedIndicator, modifiedIndicatorFactory, onBuildValue, validator, validIndicator, validIndicator, validIndicatorFactory, value

Method Details

nullable

ItemComboBoxBuilder<T> nullable(boolean nullable)

Parameters:

nullable - true if a null value should be added to the model if missing

Returns:

this builder instance

sorted

ItemComboBoxBuilder<T> sorted(boolean sorted)

Sorts the items by caption, false by default

Parameters:

sorted - if true then the items will be sorted by caption

Returns:

this builder instance

comparator

ItemComboBoxBuilder<T> comparator(@Nullable Comparator<Item<T>> comparator)

Parameters:

comparator - if specified the combo box items are sorted using this comparator

Returns:

this builder instance

completionMode

ItemComboBoxBuilder<T> completionMode(Completion.Mode completionMode)

Parameters:

completionMode - the completion mode

Returns:

this builder instance

normalize

ItemComboBoxBuilder<T> normalize(boolean normalize)

Specifies whether to normalize strings during auto-completion

Parameters:

normalize - true if strings should be normalized during autocomplete

Returns:

this builder instance

See Also:

• completionMode(Completion.Mode)

mouseWheelScrolling

ItemComboBoxBuilder<T> mouseWheelScrolling(boolean mouseWheelScrolling)

Enable mouse wheel scrolling on the combo box

Parameters:

mouseWheelScrolling - true if mouse wheel scrolling should be enabled

Returns:

this builder instance

See Also:

• ComboBoxBuilder.MOUSE_WHEEL_SCROLLING

mouseWheelScrollingWithWrapAround

ItemComboBoxBuilder<T> mouseWheelScrollingWithWrapAround(boolean mouseWheelScrollingWithWrapAround)

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

Parameters:

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

Returns:

this builder instance

maximumRowCount

ItemComboBoxBuilder<T> maximumRowCount(int maximumRowCount)

Parameters:

maximumRowCount - the maximum row count

Returns:

this builder instance

popupWidth

ItemComboBoxBuilder<T> popupWidth(int popupWidth)

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

Parameters:

popupWidth - a fixed popup width

Returns:

this builder instance

renderer

ItemComboBoxBuilder<T> renderer(@Nullable ListCellRenderer<Item<T>> renderer)

Parameters:

renderer - the renderer for the combo box

Returns:

this builder instance

See Also:

• JComboBox.setRenderer(ListCellRenderer)

editor

ItemComboBoxBuilder<T> editor(@Nullable ComboBoxEditor editor)

Parameters:

editor - the editor for the combo box

Returns:

this builder instance

See Also:

• JComboBox.setEditor(ComboBoxEditor)

itemListener

ItemComboBoxBuilder<T> itemListener(ItemListener itemListener)

Parameters:

itemListener - the item listener

Returns:

this builder instance

See Also:

• JComboBox.addItemListener(ItemListener)

builder

static ItemComboBoxBuilder.BuilderFactory builder()

Returns:

a ItemComboBoxBuilder.BuilderFactory