Module is.codion.swing.common.ui

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

Class MultiInput<C extends JComponent,T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

is.codion.swing.common.ui.component.multi.MultiInput<C,T>

Type Parameters:

C - the wrapped component type

T - the value type

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public final class MultiInput<C extends JComponent,T>
extends JPanel

A field collecting a set of values through a wrapped component: the wrapped component, untouched, beside a button showing how many values have been collected, the button toggling a non-modal, undecorated dialog listing them under the field, the caption as its border's title. The dialog stays when the focus goes elsewhere, so that the values collected remain on display while more are added, follows the field around and goes when the field does.

• KeyEvent.VK_INSERT adds the wrapped component's value to the set and clears the component, as does KeyEvent.VK_ENTER while the component holds a value, see MultiInput.Builder.addOnEnter(boolean); an Enter the field does not use is the wrapped component's.
• KeyEvent.VK_INSERT with Alt held displays the values to select several from in a dialog, the ones selected added at once, see MultiInput.Builder.selector(Supplier).
• KeyEvent.VK_DOWN with Alt held, or the button, opens the dialog, the list in it focused, or moves the focus to the list in case the dialog is already open. KeyEvent.VK_UP with Alt held, or the button, closes it.
• In the dialog KeyEvent.VK_DELETE removes the selected values, the Clear button clears the set, KeyEvent.VK_UP with Alt held moves the focus back to the field, leaving the dialog open, for adding further values, and KeyEvent.VK_ESCAPE or KeyEvent.VK_ENTER closes it. Alt held, Down and Up thereby step from the field, into the list, and back out again, opening the dialog on the way in and closing it on the way out.

The value is the set collected, sorted, see MultiInput.Builder.comparator(Comparator), plus whatever the wrapped component holds, last, so a single value typed into the component counts without being added. Setting the value sets the collected values and clears the wrapped component. The wrapped component keeps every key of its own.

The value of a wrapped component able to supply several values at a time implements MultiInput.MultiValueSource.

See Also:

• Components.multiInput()
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiInput.Builder<C extends JComponent,T>	Builds a MultiInput.
static interface	MultiInput.MultiValueSource<T>	Implemented by the ComponentValue of a wrapped component able to supply several values at a time.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	BUTTON_FOCUSABLE	Specifies whether the member button is focusable by default.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Method Summary

Modifier and Type	Method	Description
static MultiInput.Builder.ComponentStep	builder()
C	component()
void	removeNotify()
void	requestFocus()
boolean	requestFocusInWindow()
void	setEnabled(boolean enabled)
void	setName(String name)
void	setToolTipText(@Nullable String text)
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

BUTTON_FOCUSABLE

public static final PropertyValue<Boolean> BUTTON_FOCUSABLE

Specifies whether the member button is focusable by default.

• Value type: Boolean
• Default value: false

Method Details

component

public C component()

Returns:

the wrapped component, the one the values are added through

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

setToolTipText

public void setToolTipText(@Nullable String text)

Overrides:

setToolTipText in class JComponent

setName

public void setName(String name)

Overrides:

setName in class Component

requestFocus

public void requestFocus()

Overrides:

requestFocus in class JComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Overrides:

requestFocusInWindow in class JComponent

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

removeNotify

public void removeNotify()

Overrides:

removeNotify in class JComponent

builder

public static MultiInput.Builder.ComponentStep builder()

Returns:

a MultiInput.Builder.ComponentStep