Package jmri.util.swing

Class BeanSelectPanel<E extends NamedBean>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.BeanSelectPanel<E>

Type Parameters:

E - the type of NamedBean

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class BeanSelectPanel<E extends NamedBean>
extends javax.swing.JPanel

Create a JPanel containing a NamedBeanComboBox. The default display option is DISPLAYNAME. JComboBoxUtil.setupComboBoxMaxRows() will be invoked.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
(package private) NamedBeanComboBox<E>	_beanComboBox
(package private) NamedBean.DisplayOptions	_display
(package private) E	_selection

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

Constructor Summary

Constructors

Constructor	Description
BeanSelectPanel(Manager<E> manager, E selection)
BeanSelectPanel(Manager<E> manager, E selection, NamedBean.DisplayOptions display)
BeanSelectPanel(Manager<E> manager, E selection, NamedBean.DisplayOptions display, boolean maxRows)	Create a JPanel that contains a named bean combo box.
BeanSelectPanel(Manager<E> manager, E selection, NamedBean.DisplayOptions display, boolean maxRows, java.util.function.Predicate<E> filter)	Create a JPanel that contains a named bean combo box.

Method Summary

Modifier and Type	Method	Description
void	dispose()
NamedBeanComboBox<E>	getBeanCombo()
E	getNamedBean()	Get the named bean that has been selected.
boolean	isEmpty()	Check that the user selected something in this BeanSelectPanel.
void	setDefaultNamedBean(E nBean)	Set the default selected item in the combo box.
void	setDefaultNamedBean(NamedBeanHandle<E> nBeanHandle)	Set the default selected item in the combo box.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, 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, 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 Detail

_selection

E extends NamedBean _selection

_beanComboBox

NamedBeanComboBox<E extends NamedBean> _beanComboBox

_display

NamedBean.DisplayOptions _display

Constructor Detail

BeanSelectPanel

public BeanSelectPanel(@Nonnull
                       Manager<E> manager,
                       E selection)

BeanSelectPanel

public BeanSelectPanel(@Nonnull
                       Manager<E> manager,
                       E selection,
                       NamedBean.DisplayOptions display)

BeanSelectPanel

public BeanSelectPanel(@Nonnull
                       Manager<E> manager,
                       E selection,
                       NamedBean.DisplayOptions display,
                       boolean maxRows)

Create a JPanel that contains a named bean combo box.

Parameters:

manager - The bean manager

selection - The bean that is selected, null for no selection.

display - The bean display option, null for default DISPLAYNAME.

maxRows - Should max rows be enabled; if false the JComboBox default of 8 will be used.

BeanSelectPanel

public BeanSelectPanel(@Nonnull
                       Manager<E> manager,
                       E selection,
                       NamedBean.DisplayOptions display,
                       boolean maxRows,
                       java.util.function.Predicate<E> filter)

Create a JPanel that contains a named bean combo box.

Parameters:

manager - The bean manager

selection - The bean that is selected, null for no selection.

display - The bean display option, null for default DISPLAYNAME.

maxRows - Should max rows be enabled; if false the JComboBox default of 8 will be used.

filter - The filter or null if no filter

Method Detail

getBeanCombo

public NamedBeanComboBox<E> getBeanCombo()

getNamedBean

public E getNamedBean()

Get the named bean that has been selected.

Returns:

the selected bean which may be null if the first row is selected.

setDefaultNamedBean

public void setDefaultNamedBean(E nBean)

Set the default selected item in the combo box.

Parameters:

nBean - the bean that is selected by default

setDefaultNamedBean

public void setDefaultNamedBean(NamedBeanHandle<E> nBeanHandle)

Set the default selected item in the combo box.

Parameters:

nBeanHandle - the bean that is selected by default

isEmpty

public boolean isEmpty()

Check that the user selected something in this BeanSelectPanel.

Returns:

true if nothing selected

dispose

public void dispose()