Module is.codion.swing.framework.ui

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

Class EntityComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox<is.codion.framework.domain.entity.Entity>

is.codion.swing.framework.ui.component.EntityComboBox

All Implemented Interfaces:

ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, ListDataListener

public final class EntityComboBox
extends JComboBox<is.codion.framework.domain.entity.Entity>

A UI component based on the EntityComboBoxModel.

See Also:

• EntityComboBoxModel
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityComboBox.Builder	Builds a EntityComboBox instance.
static enum	EntityComboBox.KeyboardShortcut	The available keyboard shortcuts.

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

JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager

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 is.codion.swing.common.ui.key.KeyboardShortcuts<EntityComboBox.KeyboardShortcut>	KEYBOARD_SHORTCUTS	The default keyboard shortcut keyStrokes.

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

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
Optional<is.codion.swing.common.ui.control.Control>	addControl()
void	addFocusListener(FocusListener listener)
static EntityComboBox.Builder	builder(is.codion.swing.framework.model.component.EntityComboBoxModel comboBoxModel)	Instantiates a new EntityComboBox builder
static EntityComboBox.Builder	builder(is.codion.swing.framework.model.component.EntityComboBoxModel comboBoxModel, is.codion.common.value.Value<is.codion.framework.domain.entity.Entity> linkedValue)	Instantiates a new EntityComboBox builder
<B extends is.codion.swing.common.ui.component.combobox.ComboBoxBuilder<is.codion.framework.domain.entity.Entity, EntityComboBox, B>> is.codion.swing.common.ui.component.combobox.ComboBoxBuilder<is.codion.framework.domain.entity.Entity,EntityComboBox,B>	createForeignKeyFilterComboBox(is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)	Creates a ComboBoxBuilder returning a combo box for filtering this combo box via a foreign key
is.codion.swing.common.ui.control.Control	createForeignKeyFilterControl(is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)	Creates an Action which displays a dialog for filtering this combo box via a foreign key
Optional<is.codion.swing.common.ui.control.Control>	editControl()
is.codion.swing.framework.model.component.EntityComboBoxModel	getModel()
<B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer, is.codion.swing.common.ui.component.text.NumberField<Integer>, B>> is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,is.codion.swing.common.ui.component.text.NumberField<Integer>,B>	integerSelectorField(is.codion.framework.domain.entity.attribute.Attribute<Integer> attribute)	Creates a TextFieldBuilder returning a NumberField which value is bound to the selected value in this combo box
<B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer, is.codion.swing.common.ui.component.text.NumberField<Integer>, B>> is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,is.codion.swing.common.ui.component.text.NumberField<Integer>,B>	integerSelectorField(is.codion.swing.common.model.component.combobox.FilteredComboBoxModel.ItemFinder<is.codion.framework.domain.entity.Entity,Integer> itemFinder)	Creates a TextFieldBuilder returning a NumberField which value is bound to the selected value in this combo box
void	removeFocusListener(FocusListener listener)
void	requestFocus()	Overridden as a workaround for editable combo boxes as initial focus components on detail panels stealing the focus from the parent panel on initialization
<B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<String, JTextField, B>> is.codion.swing.common.ui.component.text.TextFieldBuilder<String,JTextField,B>	stringSelectorField(is.codion.framework.domain.entity.attribute.Attribute<String> attribute)	Creates a TextFieldBuilder returning a text field which value is bound to the selected value in this combo box
<B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<String, JTextField, B>> is.codion.swing.common.ui.component.text.TextFieldBuilder<String,JTextField,B>	stringSelectorField(is.codion.swing.common.model.component.combobox.FilteredComboBoxModel.ItemFinder<is.codion.framework.domain.entity.Entity,String> itemFinder)	Creates a TextFieldBuilder returning a text field which value is bound to the selected value in this combo box

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setSelectedItem, setUI, showPopup, updateUI

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, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, 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, setToolTipText, 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, 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, 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, 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

KEYBOARD_SHORTCUTS

public static final is.codion.swing.common.ui.key.KeyboardShortcuts<EntityComboBox.KeyboardShortcut> KEYBOARD_SHORTCUTS

The default keyboard shortcut keyStrokes.

Method Details

getModel

public is.codion.swing.framework.model.component.EntityComboBoxModel getModel()

Overrides:

getModel in class JComboBox<is.codion.framework.domain.entity.Entity>

addControl

public Optional<is.codion.swing.common.ui.control.Control> addControl()

Returns:

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

See Also:

• EntityComboBox.Builder.editPanel(Supplier)

editControl

public Optional<is.codion.swing.common.ui.control.Control> editControl()

Returns:

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

See Also:

• EntityComboBox.Builder.editPanel(Supplier)

requestFocus

public void requestFocus()

Overridden as a workaround for editable combo boxes as initial focus components on detail panels stealing the focus from the parent panel on initialization

Overrides:

requestFocus in class JComponent

addFocusListener

public void addFocusListener(FocusListener listener)

Overrides:

addFocusListener in class Component

removeFocusListener

public void removeFocusListener(FocusListener listener)

Overrides:

removeFocusListener in class Component

createForeignKeyFilterControl

public is.codion.swing.common.ui.control.Control createForeignKeyFilterControl(is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)

Creates an Action which displays a dialog for filtering this combo box via a foreign key

Parameters:

foreignKey - the foreign key on which to filter

Returns:

a Control for filtering this combo box

createForeignKeyFilterComboBox

public <B extends is.codion.swing.common.ui.component.combobox.ComboBoxBuilder<is.codion.framework.domain.entity.Entity,
EntityComboBox,
B>>
is.codion.swing.common.ui.component.combobox.ComboBoxBuilder<is.codion.framework.domain.entity.Entity,EntityComboBox,B> createForeignKeyFilterComboBox(is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)

Creates a ComboBoxBuilder returning a combo box for filtering this combo box via a foreign key

Type Parameters:

B - the builder type

Parameters:

foreignKey - the foreign key on which to filter

Returns:

a ComboBoxBuilder for a foreign key filter combo box

integerSelectorField

public <B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,
is.codion.swing.common.ui.component.text.NumberField<Integer>,
B>>
is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,is.codion.swing.common.ui.component.text.NumberField<Integer>,B> integerSelectorField(is.codion.framework.domain.entity.attribute.Attribute<Integer> attribute)

Creates a TextFieldBuilder returning a NumberField which value is bound to the selected value in this combo box

Type Parameters:

B - the builder type

Parameters:

attribute - the attribute

Returns:

a NumberField builder bound to the selected value

integerSelectorField

public <B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,
is.codion.swing.common.ui.component.text.NumberField<Integer>,
B>>
is.codion.swing.common.ui.component.text.TextFieldBuilder<Integer,is.codion.swing.common.ui.component.text.NumberField<Integer>,B> integerSelectorField(is.codion.swing.common.model.component.combobox.FilteredComboBoxModel.ItemFinder<is.codion.framework.domain.entity.Entity,Integer> itemFinder)

Creates a TextFieldBuilder returning a NumberField which value is bound to the selected value in this combo box

Type Parameters:

B - the builder type

Parameters:

itemFinder - responsible for finding the item to select by value

Returns:

a NumberField builder bound to the selected value

stringSelectorField

public <B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<String,
JTextField,
B>>
is.codion.swing.common.ui.component.text.TextFieldBuilder<String,JTextField,B> stringSelectorField(is.codion.framework.domain.entity.attribute.Attribute<String> attribute)

Creates a TextFieldBuilder returning a text field which value is bound to the selected value in this combo box

Type Parameters:

B - the builder type

Parameters:

attribute - the attribute

Returns:

a JTextField builder bound to the selected value

stringSelectorField

public <B extends is.codion.swing.common.ui.component.text.TextFieldBuilder<String,
JTextField,
B>>
is.codion.swing.common.ui.component.text.TextFieldBuilder<String,JTextField,B> stringSelectorField(is.codion.swing.common.model.component.combobox.FilteredComboBoxModel.ItemFinder<is.codion.framework.domain.entity.Entity,String> itemFinder)

Creates a TextFieldBuilder returning a text field which value is bound to the selected value in this combo box

Type Parameters:

B - the builder type

Parameters:

itemFinder - responsible for finding the item to select by value

Returns:

a JTextField builder bound to the selected value

builder

public static EntityComboBox.Builder builder(is.codion.swing.framework.model.component.EntityComboBoxModel comboBoxModel)

Instantiates a new EntityComboBox builder

Parameters:

comboBoxModel - the combo box model

Returns:

a builder for a EntityComboBox

builder

public static EntityComboBox.Builder builder(is.codion.swing.framework.model.component.EntityComboBoxModel comboBoxModel,
 is.codion.common.value.Value<is.codion.framework.domain.entity.Entity> linkedValue)

Instantiates a new EntityComboBox builder

Parameters:

comboBoxModel - the combo box model

linkedValue - the linked value

Returns:

a builder for a EntityComboBox