Module is.codion.swing.common.ui

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

Interface MultiInput.Builder<C extends JComponent,T>

Type Parameters:

C - the wrapped component type

T - the value type

All Superinterfaces:

ComponentBuilder<MultiInput<C,T>,MultiInput.Builder<C,T>>, ComponentValueBuilder<MultiInput<C,T>,Set<T>,MultiInput.Builder<C,T>>, Supplier<MultiInput<C,T>>

Enclosing class:

MultiInput<C extends JComponent,T>

public static interface MultiInput.Builder<C extends JComponent,T>
extends ComponentValueBuilder<MultiInput<C,T>,Set<T>,MultiInput.Builder<C,T>>

Builds a MultiInput.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MultiInput.Builder.ComponentStep	Provides a MultiInput.Builder

Field Summary

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

COMPONENT_VALUE

Method Summary

Modifier and Type	Method	Description
MultiInput.Builder<C,T>	addOnEnter(boolean addOnEnter)	Whether KeyEvent.VK_ENTER adds the wrapped component's value while it holds one, leaving the key to the component while it does not, so that typing, Enter, typing, Enter, Enter collects two values and then does what Enter does in the component.
MultiInput.Builder<C,T>	caption(@Nullable String caption)
MultiInput.Builder<C,T>	comparator(@Nullable Comparator<T> comparator)	The default comparator collates strings according to Text.COLLATOR_LOCALE, compares other Comparable values naturally and the rest by their string representation.
MultiInput.Builder<C,T>	format(@Nullable Format format)

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

Method Details

format

MultiInput.Builder<C,T> format(@Nullable Format format)

Parameters:

format - formats a value for the dialog and the button's tool tip, null for Object.toString()

Returns:

this builder instance

caption

MultiInput.Builder<C,T> caption(@Nullable String caption)

Parameters:

caption - the caption of the border around the dialog's list, the caption of what is collected; null for none

Returns:

this builder instance

comparator

MultiInput.Builder<C,T> comparator(@Nullable Comparator<T> comparator)

The default comparator collates strings according to Text.COLLATOR_LOCALE, compares other Comparable values naturally and the rest by their string representation.

Parameters:

comparator - the comparator to use when sorting member items, null for insertion order

Returns:

this builder instance

addOnEnter

MultiInput.Builder<C,T> addOnEnter(boolean addOnEnter)

Whether KeyEvent.VK_ENTER adds the wrapped component's value while it holds one, leaving the key to the component while it does not, so that typing, Enter, typing, Enter, Enter collects two values and then does what Enter does in the component. Default true, unless the wrapped component is a JComboBox, whose Enter is its own, the editor a combo box has taking it before the component does.

Parameters:

addOnEnter - true if Enter should add the value

Returns:

this builder instance