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<T,JComboBox<Item<T>>,ItemComboBoxBuilder<T>>

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

Builds a item combo box.

Field Summary

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

TRANSFER_FOCUS_ON_ENTER

Method Summary

Modifier and Type	Method	Description
static <T> ItemComboBoxBuilder<T>	builder(ItemComboBoxModel<T> comboBoxModel)
static <T> ItemComboBoxBuilder<T>	builder(ItemComboBoxModel<T> comboBoxModel, Value<T> linkedValue)
static <T> ItemComboBoxBuilder<T>	builder(List<Item<T>> values)
static <T> ItemComboBoxBuilder<T>	builder(List<Item<T>> values, Value<T> linkedValue)
ItemComboBoxBuilder<T>	comparator(Comparator<Item<T>> comparator)
ItemComboBoxBuilder<T>	completionMode(Completion.Mode completionMode)
ItemComboBoxBuilder<T>	editor(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>	nullable(boolean nullable)
ItemComboBoxBuilder<T>	popupWidth(int popupWidth)	Only used for the system and cross-platform Look and Feels.
ItemComboBoxBuilder<T>	renderer(ListCellRenderer<Item<T>> renderer)
ItemComboBoxBuilder<T>	sorted(boolean sorted)	Sorts the items by caption

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

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

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

Parameters:

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

Returns:

this builder instance

comparator

ItemComboBoxBuilder<T> comparator(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

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

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(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(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 <T> ItemComboBoxBuilder<T> builder(ItemComboBoxModel<T> comboBoxModel)

Type Parameters:

T - the value type

Parameters:

comboBoxModel - the combo box model

Returns:

a builder for a component

builder

static <T> ItemComboBoxBuilder<T> builder(ItemComboBoxModel<T> comboBoxModel,
 Value<T> linkedValue)

Type Parameters:

T - the value type

Parameters:

comboBoxModel - the combo box model

linkedValue - the value to link to the component

Returns:

a builder for a component

builder

static <T> ItemComboBoxBuilder<T> builder(List<Item<T>> values)

Type Parameters:

T - the value type

Parameters:

values - the values

Returns:

a builder for a component

builder

static <T> ItemComboBoxBuilder<T> builder(List<Item<T>> values,
 Value<T> linkedValue)

Type Parameters:

T - the value type

Parameters:

values - the values

linkedValue - the value to link to the component

Returns:

a builder for a component