Package jmri.jmrit.display

Class GlobalVariableComboIcon

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrit.display.PositionableJPanel

jmri.jmrit.display.MemoryOrGVComboIcon

jmri.jmrit.display.GlobalVariableComboIcon

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, Cloneable, EventListener, Accessible, Positionable, InlineLogixNG, JmriMouseListener, JmriMouseMotionListener

public class GlobalVariableComboIcon
extends MemoryOrGVComboIcon
implements PropertyChangeListener, ActionListener

An icon to display and input a GlobalVariable value in a TextField.

Handles the case of either a String or an Integer in the GlobalVariable, preserving what it finds.

Since:

2.7.2

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrit.display.MemoryOrGVComboIcon

MemoryOrGVComboIcon.ComboModel

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

Nested classes/interfaces inherited from interface jmri.jmrit.display.Positionable

Positionable.DuplicateIdException

Field Summary

Fields inherited from class jmri.jmrit.display.PositionableJPanel

_controlling, _displayLevel, _editable, _editor, _emptyHidden, _hidden, _iconEditor, _iconEditorFrame, _itemPanel, _paletteFrame, _popupUtil, _positionable, _showTooltip, _viewCoordinates, active, lock, showTooltipItem

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
GlobalVariableComboIcon(Editor editor, String[] list)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)	Display
(package private) void	cleanup()	To be overridden if any special work needs to be done
Positionable	deepClone()	Make a deep copy of Positional object.
void	displayState()	Drive the current state of the display from the state of the GlobalVariable.
protected void	edit()
(package private) void	editGlobalVariable()
protected Positionable	finishClone(GlobalVariableComboIcon pos)
MemoryOrGVComboIcon.ComboModel	getComboModel()
GlobalVariable	getGlobalVariable()
NamedBeanHandle<GlobalVariable>	getNamedGlobalVariable()
String	getNameString()	Get the name of the positional as a String.
JComboBox<String>	getTextComponent()
String	getTypeString()	Get the type of the positional as a String.
void	mouseExited(JmriMouseEvent e)	Invoked when the mouse exits a component.
void	propertyChange(PropertyChangeEvent e)
boolean	setEditIconMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setGlobalVariable(String pName)	Attach a named GlobalVariable to this display item.
void	setGlobalVariable(NamedBeanHandle<GlobalVariable> m)	Attach a named GlobalVariable to this display item.
protected void	update()

Methods inherited from class jmri.jmrit.display.PositionableJPanel

addClass, doMouseClicked, doMouseDragged, doMouseEntered, doMouseExited, doMouseMoved, doMousePressed, doMouseReleased, doViemMenu, editTextItem, finishClone, finishItemUpdate, getClasses, getDegrees, getDisplayLevel, getEditor, getId, getLogixNG, getNamedBean, getPopupUtility, getScale, getToolTip, getViewCoordinates, initPaletteFrame, isActive, isControlling, isEditable, isEmptyHidden, isHidden, isPositionable, isValueEditDisabled, makeIconEditorFrame, makePaletteFrame, maxHeight, maxWidth, mouseClicked, mouseDragged, mouseEntered, mouseMoved, mousePressed, mouseReleased, remove, removeAllClasses, removeClass, rotate, setControlling, setDisableControlMenu, setDisplayLevel, setEditable, setEditItemMenu, setEditor, setEditTextItemMenu, setEmptyHidden, setHidden, setId, setLevel, setLogixNG, setLogixNG_SystemName, setPopupUtility, setPositionable, setRotateMenu, setRotateOrthogonalMenu, setScale, setScaleMenu, setShowToolTip, setTextEditMenu, setToolTip, setupLogixNG, setValueEditDisabled, setViewCoordinates, showHidden, showPopUp, showToolTip, storeItem, updateSize, updateTextItem

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

Methods inherited from interface jmri.jmrit.display.Positionable

contains, getBackground, getBounds, getEditorName, getFont, getForeground, getHeight, getLocation, getParent, getPreferredSize, getTypeName, getWidth, getX, getY, invalidate, isOpaque, repaint, requestFocusInWindow, setBackground, setBorder, setForeground, setLocation, setLocation, setOpaque, setSize, setVisible

Constructor Details

GlobalVariableComboIcon

public GlobalVariableComboIcon(Editor editor,
 String[] list)

Method Details

getTextComponent

public JComboBox<String> getTextComponent()

Specified by:

getTextComponent in interface Positionable

Specified by:

getTextComponent in class MemoryOrGVComboIcon

deepClone

public Positionable deepClone()

Description copied from interface: Positionable

Make a deep copy of Positional object. Implementation should create a new object and immediately pass the object to finishClone() returning the result of finishClone(). i.e. implementation must be:

public Positionable deepClone() { Subtype t = new Subtype(); return finishClone(t); }

Then finishClone() finishes the deep Copy of a Positional object. Implementation should make deep copies of the additional members of this sub class and then pass Positionable p to super.finishClone(). i.e. implementation must terminate with statement return super.finishClone(p); See IndicatorTurnoutIcon extends TurnoutIcon extends PositionableLabel for an example of how to continue deep cloning a chain of subclasses.

Specified by:

deepClone in interface Positionable

Overrides:

deepClone in class PositionableJPanel

Returns:

the copy

finishClone

protected Positionable finishClone(GlobalVariableComboIcon pos)

setGlobalVariable

public void setGlobalVariable(String pName)

Attach a named GlobalVariable to this display item.

Parameters:

pName - used as a system/user name to look up the GlobalVariable object

setGlobalVariable

public void setGlobalVariable(NamedBeanHandle<GlobalVariable> m)

Attach a named GlobalVariable to this display item.

Parameters:

m - The GlobalVariable object

getNamedGlobalVariable

public NamedBeanHandle<GlobalVariable> getNamedGlobalVariable()

getGlobalVariable

public GlobalVariable getGlobalVariable()

getComboModel

public MemoryOrGVComboIcon.ComboModel getComboModel()

Specified by:

getComboModel in class MemoryOrGVComboIcon

actionPerformed

public void actionPerformed(ActionEvent e)

Display

Specified by:

actionPerformed in interface ActionListener

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

getTypeString

@Nonnull
public String getTypeString()

Description copied from interface: Positionable

Get the type of the positional as a String.

Specified by:

getTypeString in interface Positionable

Overrides:

getTypeString in class PositionableJPanel

Returns:

the type to display

getNameString

public String getNameString()

Description copied from interface: Positionable

Get the name of the positional as a String. This is often the display name of the NamedBean being positioned.

Specified by:

getNameString in interface InlineLogixNG

Specified by:

getNameString in interface Positionable

Overrides:

getNameString in class PositionableJPanel

Returns:

the name to display

update

protected void update()

Specified by:

update in class MemoryOrGVComboIcon

setEditIconMenu

public boolean setEditIconMenu(JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setEditIconMenu in interface Positionable

Overrides:

setEditIconMenu in class PositionableJPanel

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

edit

protected void edit()

Overrides:

edit in class PositionableJPanel

editGlobalVariable

void editGlobalVariable()

displayState

public void displayState()

Drive the current state of the display from the state of the GlobalVariable.

mouseExited

public void mouseExited(JmriMouseEvent e)

Description copied from interface: JmriMouseListener

Invoked when the mouse exits a component.

Specified by:

mouseExited in interface JmriMouseListener

Overrides:

mouseExited in class PositionableJPanel

Parameters:

e - the event to be processed

cleanup

void cleanup()

Description copied from class: PositionableJPanel

To be overridden if any special work needs to be done

Overrides:

cleanup in class PositionableJPanel