Package jmri.jmrit.display.controlPanelEditor

Class PortalIcon

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

jmri.jmrit.display.PositionableLabel

jmri.jmrit.display.PositionableIcon

jmri.jmrit.display.controlPanelEditor.PortalIcon

All Implemented Interfaces:

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

public class PortalIcon
extends PositionableIcon
implements PropertyChangeListener

See Also:

• Serialized Form

Nested Class Summary

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
static final String	FROM_ARROW
static final String	HIDDEN
static final String	PATH
static final String	TO_ARROW
static final String	VISIBLE

Fields inherited from class jmri.jmrit.display.PositionableIcon

_iconFamily, _iconMap, _rotate, _scale

Fields inherited from class jmri.jmrit.display.PositionableLabel

_control, _controlling, _displayLevel, _editable, _editor, _emptyHidden, _hidden, _icon, _namedIcon, _paletteFrame, _positionable, _rotateText, _showTooltip, _text, _tooltip, _unRotatedText, _valueEditDisabled, _viewCoordinates

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

Constructor Summary

Constructors

Constructor	Description
PortalIcon(Editor editor)
PortalIcon(Editor editor, Portal portal)

Method Summary

Modifier and Type	Method	Description
Positionable	deepClone()	Make a deep copy of Positional object.
void	displayState(int state)
boolean	doViemMenu()	Disable popup items that apply to whole selection Group.
protected Positionable	finishClone(PortalIcon pos)
boolean	getArrowHide()
boolean	getArrowSwitch()
String	getFamily()	PortalIcon family is managed by editor, ignoring per icon setting if any.
String	getNameString()	Get the name of the positional as a String.
static HashMap<String,NamedIcon>	getPaletteMap()
Portal	getPortal()
String	getStatus()
String	getTypeString()	Get the type of the positional as a String.
void	makeIconMap()
void	propertyChange(PropertyChangeEvent e)
void	remove()	Removes this object from display and persistance
void	setArrowOrientation(boolean set)	Set direction of portal icon, renamed in 4.21.5
boolean	setEditItemMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setHideArrows(boolean set)
void	setIcon(String name, NamedIcon ic)
void	setLocation(int x, int y)
protected void	setMap(HashMap<String,NamedIcon> map)
void	setPortal(Portal portal)
boolean	setRotateMenu(JPopupMenu popup)	Rotate degrees return true if popup is set.
boolean	setScaleMenu(JPopupMenu popup)	Scale percentage form display.
void	setStatus(String status)
boolean	showPopUp(JPopupMenu popup)	Use this call to set actions that will not affect whole selection Group.

Methods inherited from class jmri.jmrit.display.PositionableIcon

cloneMap, finishClone, getIcon, getIconMap, getIconStateNames, getScale, getStateNameCollection, maxHeight, maxWidth, rotate, rotateOrthogonal, setFamily, setScale

Methods inherited from class jmri.jmrit.display.PositionableLabel

addClass, cloneIcon, dispose, doMouseClicked, doMouseDragged, doMouseEntered, doMouseExited, doMouseMoved, doMousePressed, doMouseReleased, edit, editIcon, editIconItem, editTextItem, finishClone, finishItemUpdate, getClasses, getDegrees, getDisplayLevel, getEditor, getHeight, getId, getLogixNG, getNamedBean, getPopupUtility, getSize, getTextComponent, getToolTip, getUnRotatedText, getViewCoordinates, getWidth, initPaletteFrame, isActive, isBackground, isControl, isControlling, isEditable, isEmptyHidden, isHidden, isIcon, isPositionable, isRotated, isText, isValueEditDisabled, makeIconEditorFrame, makePaletteFrame, makeTextOverlaidIcon, maxHeightTrue, maxWidthTrue, paintComponent, removeAllClasses, removeClass, setControlling, setDegrees, setDisableControlMenu, setDisplayLevel, setEditable, setEditIconMenu, setEditor, setEditTextItemMenu, setEmptyHidden, setHidden, setIcon, setId, setLevel, setLogixNG, setLogixNG_SystemName, setPopupUtility, setPositionable, setRotateOrthogonalMenu, setShowToolTip, setSuperText, setText, setTextEditMenu, setToolTip, setUnRotatedText, setupLogixNG, setValueEditDisabled, setViewCoordinates, showEmptyHidden, showHidden, showToolTip, storeItem, updateIcon, updateSize, 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

HIDDEN

public static final String HIDDEN

See Also:

• Constant Field Values

VISIBLE

public static final String VISIBLE

See Also:

• Constant Field Values

PATH

public static final String PATH

See Also:

• Constant Field Values

TO_ARROW

public static final String TO_ARROW

See Also:

• Constant Field Values

FROM_ARROW

public static final String FROM_ARROW

See Also:

• Constant Field Values

Constructor Details

PortalIcon

public PortalIcon(Editor editor)

PortalIcon

public PortalIcon(Editor editor,
 Portal portal)

Method Details

getPaletteMap

public static HashMap<String,NamedIcon> getPaletteMap()

makeIconMap

public void makeIconMap()

getFamily

public String getFamily()

PortalIcon family is managed by editor, ignoring per icon setting if any.

Overrides:

getFamily in class PositionableIcon

Returns:

the family name as set in editor.

setMap

protected void setMap(HashMap<String,NamedIcon> map)

deepClone

@Nonnull
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 PositionableIcon

Returns:

the copy

finishClone

protected Positionable finishClone(PortalIcon pos)

setIcon

public void setIcon(String name,
 NamedIcon ic)

setArrowOrientation

public void setArrowOrientation(boolean set)

Set direction of portal icon, renamed in 4.21.5

Parameters:

set - true for regular, false for opposite (flipped in edit frame)

setHideArrows

public void setHideArrows(boolean set)

getArrowSwitch

public boolean getArrowSwitch()

getArrowHide

public boolean getArrowHide()

getPortal

public Portal getPortal()

setPortal

public void setPortal(Portal portal)

setStatus

public void setStatus(String status)

getStatus

public String getStatus()

remove

public void remove()

Description copied from class: PositionableLabel

Removes this object from display and persistance

Specified by:

remove in interface Positionable

Overrides:

remove in class PositionableLabel

displayState

public void displayState(int state)

Overrides:

displayState in class PositionableIcon

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

@Nonnull
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

doViemMenu

public boolean doViemMenu()

Disable popup items that apply to whole selection Group.

Specified by:

doViemMenu in interface Positionable

Overrides:

doViemMenu in class PositionableLabel

Returns:

true if Editor may add the standardpopup menu items

See Also:

• PositionableLabel.doViemMenu()

showPopUp

public boolean showPopUp(JPopupMenu popup)

Use this call to set actions that will not affect whole selection Group.

Specified by:

showPopUp in interface Positionable

Overrides:

showPopUp in class PositionableLabel

See Also:

• PositionableLabel.setEditItemMenu(javax.swing.JPopupMenu)

setLocation

public void setLocation(int x,
 int y)

Specified by:

setLocation in interface Positionable

Overrides:

setLocation in class Component

setRotateMenu

public boolean setRotateMenu(@Nonnull
 JPopupMenu popup)

Description copied from class: PositionableLabel

Rotate degrees return true if popup is set.

Specified by:

setRotateMenu in interface Positionable

Overrides:

setRotateMenu in class PositionableLabel

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setScaleMenu

public boolean setScaleMenu(@Nonnull
 JPopupMenu popup)

Description copied from class: PositionableLabel

Scale percentage form display.

Specified by:

setScaleMenu in interface Positionable

Overrides:

setScaleMenu in class PositionableLabel

Parameters:

popup - the menu to add the menu items to

Returns:

true if popup is set

setEditItemMenu

public boolean setEditItemMenu(@Nonnull
 JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setEditItemMenu in interface Positionable

Overrides:

setEditItemMenu in class PositionableLabel

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise