Package jmri.jmrit.display

Class GlobalVariableIcon

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

jmri.jmrit.display.PositionableLabel

jmri.jmrit.display.MemoryOrGVIcon

jmri.jmrit.display.GlobalVariableIcon

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, Cloneable, EventListener, Accessible, SwingConstants, Positionable, InlineLogixNG

Direct Known Subclasses:

GlobalVariableIcon

public class GlobalVariableIcon
extends MemoryOrGVIcon
implements PropertyChangeListener

An icon to display a status of a GlobalVariable.

The value of the global variable can't be changed with this icon.

See Also:

• Serialized Form

Nested Class Summary

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

PositionableLabel.PaletteFrameCloser

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

JLabel.AccessibleJLabel

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

Modifier and Type	Field	Description
(package private) Color	_saveColor
(package private) static final int	CENTRE
(package private) NamedIcon	defaultIcon
(package private) static final int	LEFT
(package private) HashMap<String,NamedIcon>	map
(package private) static final int	RIGHT
(package private) boolean	selectable

Fields inherited from class jmri.jmrit.display.PositionableLabel

_control, _controlling, _displayLevel, _editable, _editor, _emptyHidden, _hidden, _icon, _iconEditor, _iconEditorFrame, _iconItemPanel, _itemPanel, _namedIcon, _paletteFrame, _popupUtil, _positionable, _rotateText, _showTooltip, _text, _tooltip, _unRotatedText, _valueEditDisabled, _viewCoordinates, active, disableItem

Fields inherited from class javax.swing.JLabel

labelFor

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, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
GlobalVariableIcon(String s, Editor editor)
GlobalVariableIcon(NamedIcon s, Editor editor)

Method Summary

Modifier and Type	Method	Description
void	addKeyAndIcon(NamedIcon icon, String keyValue)
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	displayState(Object key)
void	dispose()	Clean up when this object is no longer needed.
void	doMouseClicked(JmriMouseEvent e)
protected void	edit()
(package private) void	editGlobalVariable()
protected void	editGlobalVariableValue()
protected Positionable	finishClone(GlobalVariableIcon pos)
protected void	flipIcon(int flip)
NamedIcon	getDefaultIcon()
GlobalVariable	getGlobalVariable()
HashMap<String,NamedIcon>	getMap()
NamedBean	getNamedBean()	Provide a generic method to return the bean associated with the Positionable.
NamedBeanHandle<GlobalVariable>	getNamedGlobalVariable()
String	getNameString()	Get the name of the positional as a String.
int	getOriginalX()
int	getOriginalY()
String	getTypeString()	Get the type of the positional as a String.
protected Object	getValue()
boolean	isSelectable()
void	propertyChange(PropertyChangeEvent e)
void	resetDefaultIcon()
void	setAttributes(PositionablePopupUtil util, Positionable that)	Special method to transfer a setAttributes call from the LE version of GlobalVariableIcon.
void	setDefaultIcon(NamedIcon n)
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.
void	setLocation(int x, int y)
void	setOriginalLocation(int x, int y)
void	setSelectable(boolean b)
boolean	setTextEditMenu(JPopupMenu popup)	Text edits cannot be done to GlobalVariable text - override
protected void	setValue(Object val)
boolean	showPopUp(JPopupMenu popup)	Call to a Positionable that has unique requirements - e.g.
void	updateSize()	Update the AWT and Swing size information due to change in internal state, e.g. if one or more of the icons that might be displayed is changed

Methods inherited from class jmri.jmrit.display.PositionableLabel

addClass, cloneIcon, doMouseDragged, doMouseEntered, doMouseExited, doMouseMoved, doMousePressed, doMouseReleased, doViemMenu, editIcon, editIconItem, editTextItem, finishClone, finishItemUpdate, getClasses, getDegrees, getDisplayLevel, getEditor, getHeight, getId, getLogixNG, getPopupUtility, getScale, getSize, getTextComponent, getToolTip, getUnRotatedText, getViewCoordinates, getWidth, initPaletteFrame, isActive, isBackground, isControl, isControlling, isEditable, isEmptyHidden, isHidden, isIcon, isPositionable, isRotated, isText, isValueEditDisabled, makeIconEditorFrame, makePaletteFrame, makeTextOverlaidIcon, maxHeight, maxHeightTrue, maxWidth, maxWidthTrue, paintComponent, remove, removeAllClasses, removeClass, rotate, rotateOrthogonal, setControlling, setDegrees, setDisableControlMenu, setDisplayLevel, setEditable, setEditItemMenu, setEditor, setEditTextItemMenu, setEmptyHidden, setHidden, setIcon, setId, setLevel, setLogixNG, setLogixNG_SystemName, setPopupUtility, setPositionable, setRotateMenu, setRotateOrthogonalMenu, setScale, setScaleMenu, setShowToolTip, setSuperText, setText, setToolTip, setUnRotatedText, setupLogixNG, setValueEditDisabled, setViewCoordinates, showEmptyHidden, showHidden, showToolTip, storeItem, updateIcon, updateTextItem

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setUI, setVerticalAlignment, setVerticalTextPosition, 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, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, 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, getLocation, getParent, getPreferredSize, getTypeName, getX, getY, invalidate, isOpaque, repaint, requestFocusInWindow, setBackground, setBorder, setForeground, setLocation, setOpaque, setSize, setVisible

Field Details

defaultIcon

NamedIcon defaultIcon

map

HashMap<String,NamedIcon> map

selectable

boolean selectable

_saveColor

Color _saveColor

LEFT

static final int LEFT

See Also:

• Constant Field Values

RIGHT

static final int RIGHT

See Also:

• Constant Field Values

CENTRE

static final int CENTRE

See Also:

• Constant Field Values

Constructor Details

GlobalVariableIcon

public GlobalVariableIcon(String s,
 Editor editor)

GlobalVariableIcon

public GlobalVariableIcon(NamedIcon s,
 Editor editor)

Method Details

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 PositionableLabel

Returns:

the copy

finishClone

protected Positionable finishClone(GlobalVariableIcon pos)

resetDefaultIcon

public void resetDefaultIcon()

setDefaultIcon

public void setDefaultIcon(NamedIcon n)

getDefaultIcon

public NamedIcon getDefaultIcon()

setGlobalVariable

public void setGlobalVariable(String pName)

Attach a named GlobalVariable to this display item.

Parameters:

pName - Used as a system/user name to lookup 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()

getNamedBean

public NamedBean getNamedBean()

Description copied from class: PositionableLabel

Provide a generic method to return the bean associated with the Positionable.

Specified by:

getNamedBean in interface Positionable

Overrides:

getNamedBean in class PositionableLabel

getMap

public HashMap<String,NamedIcon> getMap()

addKeyAndIcon

public void addKeyAndIcon(NamedIcon icon,
 String keyValue)

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 PositionableLabel

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 PositionableLabel

Returns:

the name to display

setSelectable

public void setSelectable(boolean b)

isSelectable

public boolean isSelectable()

showPopUp

public boolean showPopUp(JPopupMenu popup)

Description copied from class: PositionableLabel

Call to a Positionable that has unique requirements - e.g. RpsPositionIcon, SecurityElementIcon

Specified by:

showPopUp in interface Positionable

Overrides:

showPopUp in class PositionableLabel

setTextEditMenu

public boolean setTextEditMenu(JPopupMenu popup)

Text edits cannot be done to GlobalVariable text - override

Specified by:

setTextEditMenu in interface Positionable

Overrides:

setTextEditMenu in class PositionableLabel

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

flipIcon

protected void flipIcon(int flip)

displayState

public void displayState()

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

Specified by:

displayState in class MemoryOrGVIcon

setAttributes

public void setAttributes(PositionablePopupUtil util,
 Positionable that)

Special method to transfer a setAttributes call from the LE version of GlobalVariableIcon. This eliminates the need to change references to public.

Parameters:

util - The LE popup util object.

that - The current positional object (this).

Since:

4.11.6

displayState

protected void displayState(Object key)

updateSize

public void updateSize()

Description copied from class: PositionableLabel

Update the AWT and Swing size information due to change in internal state, e.g. if one or more of the icons that might be displayed is changed

Specified by:

updateSize in interface Positionable

Overrides:

updateSize in class PositionableLabel

setOriginalLocation

public void setOriginalLocation(int x,
 int y)

getOriginalX

public int getOriginalX()

Specified by:

getOriginalX in class MemoryOrGVIcon

getOriginalY

public int getOriginalY()

Specified by:

getOriginalY in class MemoryOrGVIcon

setLocation

public void setLocation(int x,
 int y)

Specified by:

setLocation in interface Positionable

Overrides:

setLocation in class Component

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 PositionableLabel

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 PositionableLabel

editGlobalVariable

void editGlobalVariable()

dispose

public void dispose()

Description copied from class: PositionableLabel

Clean up when this object is no longer needed. Should not be called while the object is still displayed; see remove()

Overrides:

dispose in class PositionableLabel

doMouseClicked

public void doMouseClicked(JmriMouseEvent e)

Specified by:

doMouseClicked in interface Positionable

Overrides:

doMouseClicked in class PositionableLabel

editGlobalVariableValue

protected void editGlobalVariableValue()

getValue

protected Object getValue()

setValue

protected void setValue(Object val)