Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui.component

Class EntitySearchField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

is.codion.swing.common.ui.component.text.HintTextField

is.codion.swing.framework.ui.component.EntitySearchField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

public final class EntitySearchField
extends HintTextField

A UI component based on the EntitySearchModel. The search is triggered by the ENTER key and behaves in the following way: If the search result is empty a message is shown, if a single entity fits the condition then that entity is selected, otherwise a component displaying the entities fitting the condition is shown in a dialog allowing either a single or multiple selection based on the search model settings. EntitySearchField.ListSelector is the default EntitySearchField.Selector. Use builder() for a builder instance.

See Also:

• EntitySearchModel
• builder()
• EntitySearchField.Builder.selector(Function)
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntitySearchField.Builder<T,B extends EntitySearchField.Builder<T,B>>	Builds an entity search field.
static final class	EntitySearchField.ControlKeys	The available controls.
static interface	EntitySearchField.ListSelector	A EntitySearchField.Selector based on a JList.
static interface	EntitySearchField.MultiSelectionBuilder	Builds a multi selection entity search field.
static enum	EntitySearchField.SearchIndicator	The ways which a search field can indicate that a search is in progress.
static interface	EntitySearchField.Selector	Provides a way for the user to select one or more of a given set of entities
static interface	EntitySearchField.SingleSelectionBuilder	Builds a single selection entity search field.
static interface	EntitySearchField.TableSelector	A EntitySearchField.Selector based on a FilterTable.

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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<EntitySearchField.SearchIndicator>	SEARCH_INDICATOR	Specifies the way a EntitySearchField indicates that a search is in progress.
static final PropertyValue<Integer>	SEARCH_PROGRESS_BAR_DELAY	Specifies the number of milliseconds to delay showing the refresh progress bar, if enabled.

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Method Summary

Modifier and Type	Method	Description
Optional<CommandControl>	addControl()
static EntitySearchField.Builder.ModelStep	builder()
Optional<CommandControl>	editControl()
static EntitySearchField.ListSelector	listSelector(EntitySearchField searchField)
EntitySearchModel	model()
Control	searchControl()
boolean	singleSelection()
static EntitySearchField.TableSelector	tableSelector(EntitySearchField searchField)
void	updateUI()

Methods inherited from class is.codion.swing.common.ui.component.text.HintTextField

addFocusListener, addPropertyChangeListener, hint, paint

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, viewToModel, viewToModel2D, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, addHierarchyBoundsListener, addHierarchyListener, 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, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, 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

SEARCH_INDICATOR

public static final PropertyValue<EntitySearchField.SearchIndicator> SEARCH_INDICATOR

Specifies the way a EntitySearchField indicates that a search is in progress.

• Value type: EntitySearchField.SearchIndicator
• Default value: EntitySearchField.SearchIndicator.PROGRESS_BAR

See Also:

• SEARCH_PROGRESS_BAR_DELAY

SEARCH_PROGRESS_BAR_DELAY

public static final PropertyValue<Integer> SEARCH_PROGRESS_BAR_DELAY

Specifies the number of milliseconds to delay showing the refresh progress bar, if enabled.

• Value type: Integer
• Default value: 350

See Also:

• SEARCH_INDICATOR
• EntitySearchField.SearchIndicator.PROGRESS_BAR

Method Details

updateUI

public void updateUI()

Overrides:

updateUI in class JTextComponent

model

public EntitySearchModel model()

Returns:

the search model this search field is based on

searchControl

public Control searchControl()

Returns:

a Control for triggering a search

addControl

public Optional<CommandControl> addControl()

Returns:

a Control for inserting a new record, if one is available

See Also:

• EntitySearchField.Builder.editPanel(Supplier)

editControl

public Optional<CommandControl> editControl()

Returns:

a Control for editing the selected record, if one is available

See Also:

• EntitySearchField.Builder.editPanel(Supplier)

singleSelection

public boolean singleSelection()

Returns:

true if single selection is enabled

builder

public static EntitySearchField.Builder.ModelStep builder()

Returns:

a EntitySearchField.Builder.ModelStep

listSelector

public static EntitySearchField.ListSelector listSelector(EntitySearchField searchField)

Parameters:

searchField - the search field

Returns:

a EntitySearchField.Selector based on a JList.

tableSelector

public static EntitySearchField.TableSelector tableSelector(EntitySearchField searchField)

Parameters:

searchField - the search field

Returns:

a EntitySearchField.Selector based on a FilterTable.