jmri.jmrit.display
Class PositionableLabel

Show UML class diagram

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLabel
                  jmri.jmrit.display.PositionableLabel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Cloneable, Accessible, SwingConstants, Positionable

Direct Known Subclasses:

LightIcon, LinkingLabel, LocoIcon, MemoryIcon, MultiSensorIcon, PositionableIcon, ReporterIcon, RpsPositionIcon, SlipTurnoutIcon, TextItemPanel.DragDecoratorLabel

public class PositionableLabel
extends JLabel
implements Positionable

PositionableLabel is a JLabel that can be dragged around the inside of the enclosing Container using a right-drag.

The positionable parameter is a global, set from outside. The 'fixed' parameter is local, set from the popup here.

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

Field Summary

protected boolean	_control
protected boolean	_controlling
protected int	_displayLevel
protected boolean	_editable
protected Editor	_editor
protected boolean	_hidden
protected boolean	_icon
(package private) IconAdder	_iconEditor
(package private) JFrame	_iconEditorFrame Methods for Item Popups in Panel editor
protected NamedIcon	_namedIcon
(package private) JmriJFrame	_paletteFrame
(package private) PositionablePopupUtil	_popupUtil
protected boolean	_positionable
protected boolean	_rotateText
protected boolean	_showTooltip
protected boolean	_text
protected ToolTip	_tooltip
protected String	_unRotatedText
protected boolean	_viewCoordinates
(package private) boolean	active
(package private) JCheckBoxMenuItem	disableItem
(package private) static org.slf4j.Logger	log
static ResourceBundle	rbean

Fields inherited from class javax.swing.JLabel

labelFor

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PositionableLabel(NamedIcon s, Editor editor)

PositionableLabel(String s, Editor editor)

Method Summary

protected NamedIcon	cloneIcon(NamedIcon icon, PositionableLabel pos)
Positionable	deepClone() Make a deep copy of Positional object.
void	dispose() Clean up when this object is no longer needed.
void	doMouseClicked(MouseEvent event)
void	doMouseDragged(MouseEvent event)
void	doMouseEntered(MouseEvent event)
void	doMouseExited(MouseEvent event)
void	doMouseMoved(MouseEvent event)
void	doMousePressed(MouseEvent event)
void	doMouseReleased(MouseEvent event)
boolean	doViemMenu() Use the 'Standard' presentation of the popup menu items.
protected void	edit()
protected void	editIcon()
Positionable	finishClone(Positionable p) Finsh the deep Copy of a Positional object.
int	getDegrees()
int	getDisplayLevel()
Editor	getEditor()
int	getHeight()
NamedBean	getNamedBean() Provides a generic method to return the bean associated with the Positionable
String	getNameString() Methods to add popup menu items return true if a popup item is set
PositionablePopupUtil	getPopupUtility()
boolean	getSaveOpaque()
double	getScale()
Dimension	getSize()
JComponent	getTextComponent()
ToolTip	getTooltip()
String	getUnRotatedText() When text is rotated or in an icon mode, the return of getText() may be null or some other value
boolean	getViewCoordinates()
int	getWidth()
boolean	isActive() "active" means that the object is still displayed, and should be stored.
boolean	isBackground()
boolean	isControl()
boolean	isControlling()
boolean	isEditable()
boolean	isHidden()
boolean	isIcon()
boolean	isPositionable()
boolean	isRotated()
boolean	isText()
protected void	makeIconEditorFrame(Container pos, String name, boolean table, IconAdder editor) For item popups in Panel Editor
protected void	makePalettteFrame(String title) For item popups in Control Panel Editor
protected NamedIcon	makeTextOverlaidIcon(String text, NamedIcon ic) Create an image of icon with text overlaid
int	maxHeight()
int	maxHeightTrue()
int	maxWidth()
int	maxWidthTrue()
protected void	paintComponent(Graphics g)
void	remove() Removes this object from display and persistance
void	rotate(int deg)
protected void	rotateOrthogonal()
void	saveOpaque(boolean set)
void	setControlling(boolean enabled)
void	setDegrees(int deg)
boolean	setDisableControlMenu(JPopupMenu popup)
void	setDisplayLevel(int l)
void	setEditable(boolean enabled)
boolean	setEditIconMenu(JPopupMenu popup)
boolean	setEditItemMenu(JPopupMenu popup)
void	setEditor(Editor ed)
void	setHidden(boolean hide)
void	setLevel(int l) Delayed setDisplayLevel for DnD
void	setPopupUtility(PositionablePopupUtil tu)
void	setPositionable(boolean enabled) Positionable methods
boolean	setRotateMenu(JPopupMenu popup) Rotate degrees return true if popup is set
boolean	setRotateOrthogonalMenu(JPopupMenu popup) Rotate othogonally return true if popup is set
void	setScale(double s)
boolean	setScaleMenu(JPopupMenu popup) Scale percentage return true if popup is set
void	setShowTooltip(boolean set)
protected void	setSuperText(String text)
void	setText(String text)
boolean	setTextEditMenu(JPopupMenu popup)
void	setTooltip(ToolTip tip)
void	setViewCoordinates(boolean enabled)
void	showHidden()
boolean	showPopUp(JPopupMenu popup) Call to a Positionable that has unique requirements - e.g.
boolean	showTooltip()
boolean	storeItem() Store a permanent copy of this Positionable The editorXml will call this method to find out whether it should store this Positionable item.
void	updateIcon(NamedIcon s)
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 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, transferFocusBackward, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, 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, getFont, getForeground, getLocation, getParent, getPreferredSize, getX, getY, invalidate, isOpaque, repaint, requestFocusInWindow, setBackground, setBorder, setForeground, setLocation, setLocation, setOpaque, setSize, setVisible

Field Detail

rbean

public static final ResourceBundle rbean

_editor

protected Editor _editor

_icon

protected boolean _icon

_text

protected boolean _text

_control

protected boolean _control

_namedIcon

protected NamedIcon _namedIcon

_tooltip

protected ToolTip _tooltip

_showTooltip

protected boolean _showTooltip

_editable

protected boolean _editable

_positionable

protected boolean _positionable

_viewCoordinates

protected boolean _viewCoordinates

_controlling

protected boolean _controlling

_hidden

protected boolean _hidden

_displayLevel

protected int _displayLevel

_unRotatedText

protected String _unRotatedText

_rotateText

protected boolean _rotateText

_popupUtil

PositionablePopupUtil _popupUtil

_iconEditorFrame

JFrame _iconEditorFrame

Methods for Item Popups in Panel editor

_iconEditor

IconAdder _iconEditor

_paletteFrame

JmriJFrame _paletteFrame

disableItem

JCheckBoxMenuItem disableItem

active

boolean active

log

static org.slf4j.Logger log

Constructor Detail

PositionableLabel

public PositionableLabel(String s,
                         Editor editor)

PositionableLabel

public PositionableLabel(NamedIcon s,
                         Editor editor)

Method Detail

isIcon

public final boolean isIcon()

isText

public final boolean isText()

isControl

public final boolean isControl()

getEditor

public Editor getEditor()

Specified by:

getEditor in interface Positionable

setEditor

public void setEditor(Editor ed)

Specified by:

setEditor in interface Positionable

setPositionable

public void setPositionable(boolean enabled)

Positionable methods

Specified by:

setPositionable in interface Positionable

isPositionable

public final boolean isPositionable()

Specified by:

isPositionable in interface Positionable

setEditable

public void setEditable(boolean enabled)

Specified by:

setEditable in interface Positionable

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Positionable

setViewCoordinates

public void setViewCoordinates(boolean enabled)

Specified by:

setViewCoordinates in interface Positionable

getViewCoordinates

public boolean getViewCoordinates()

Specified by:

getViewCoordinates in interface Positionable

setControlling

public void setControlling(boolean enabled)

Specified by:

setControlling in interface Positionable

isControlling

public boolean isControlling()

Specified by:

isControlling in interface Positionable

setHidden

public void setHidden(boolean hide)

Specified by:

setHidden in interface Positionable

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Positionable

showHidden

public void showHidden()

Specified by:

showHidden in interface Positionable

setLevel

public void setLevel(int l)

Delayed setDisplayLevel for DnD

setDisplayLevel

public void setDisplayLevel(int l)

Specified by:

setDisplayLevel in interface Positionable

getDisplayLevel

public int getDisplayLevel()

Specified by:

getDisplayLevel in interface Positionable

setShowTooltip

public void setShowTooltip(boolean set)

Specified by:

setShowTooltip in interface Positionable

showTooltip

public boolean showTooltip()

Specified by:

showTooltip in interface Positionable

setTooltip

public void setTooltip(ToolTip tip)

Specified by:

setTooltip in interface Positionable

getTooltip

public ToolTip getTooltip()

Specified by:

getTooltip in interface Positionable

getNameString

public String getNameString()

Description copied from interface: Positionable

Methods to add popup menu items return true if a popup item is set

Specified by:

getNameString in interface Positionable

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); }

Specified by:

deepClone in interface Positionable

getUnRotatedText

public String getUnRotatedText()

When text is rotated or in an icon mode, the return of getText() may be null or some other value

Returns:

original defining text set by user

finishClone

public Positionable finishClone(Positionable p)

Description copied from interface: Positionable

Finsh 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:

finishClone in interface Positionable

getTextComponent

public JComponent getTextComponent()

Specified by:

getTextComponent in interface Positionable

cloneIcon

protected NamedIcon cloneIcon(NamedIcon icon,
                              PositionableLabel pos)

doMousePressed

public void doMousePressed(MouseEvent event)

Specified by:

doMousePressed in interface Positionable

doMouseReleased

public void doMouseReleased(MouseEvent event)

Specified by:

doMouseReleased in interface Positionable

doMouseClicked

public void doMouseClicked(MouseEvent event)

Specified by:

doMouseClicked in interface Positionable

doMouseDragged

public void doMouseDragged(MouseEvent event)

Specified by:

doMouseDragged in interface Positionable

doMouseMoved

public void doMouseMoved(MouseEvent event)

Specified by:

doMouseMoved in interface Positionable

doMouseEntered

public void doMouseEntered(MouseEvent event)

Specified by:

doMouseEntered in interface Positionable

doMouseExited

public void doMouseExited(MouseEvent event)

Specified by:

doMouseExited in interface Positionable

storeItem

public boolean storeItem()

Description copied from interface: Positionable

Store a permanent copy of this Positionable The editorXml will call this method to find out whether it should store this Positionable item.

Specified by:

storeItem in interface Positionable

Returns:

true if the Editor should store this in the configuration file

doViemMenu

public boolean doViemMenu()

Description copied from interface: Positionable

Use the 'Standard' presentation of the popup menu items. The editor will call this method to find out whether it should creates any popup viewing menu items.

Specified by:

doViemMenu in interface Positionable

Returns:

true if Editor may add the standardpopup menu items

setPopupUtility

public void setPopupUtility(PositionablePopupUtil tu)

Specified by:

setPopupUtility in interface Positionable

getPopupUtility

public PositionablePopupUtil getPopupUtility()

Specified by:

getPopupUtility in interface Positionable

updateSize

public 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

Specified by:

updateSize in interface Positionable

maxWidth

public int maxWidth()

Specified by:

maxWidth in interface Positionable

maxHeight

public int maxHeight()

Specified by:

maxHeight in interface Positionable

maxWidthTrue

public int maxWidthTrue()

maxHeightTrue

public int maxHeightTrue()

isBackground

public boolean isBackground()

isRotated

public boolean isRotated()

updateIcon

public void updateIcon(NamedIcon s)

showPopUp

public boolean showPopUp(JPopupMenu popup)

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

Specified by:

showPopUp in interface Positionable

setRotateOrthogonalMenu

public boolean setRotateOrthogonalMenu(JPopupMenu popup)

Rotate othogonally return true if popup is set

Specified by:

setRotateOrthogonalMenu in interface Positionable

rotateOrthogonal

protected void rotateOrthogonal()

setEditItemMenu

public boolean setEditItemMenu(JPopupMenu popup)

Specified by:

setEditItemMenu in interface Positionable

setEditIconMenu

public boolean setEditIconMenu(JPopupMenu popup)

Specified by:

setEditIconMenu in interface Positionable

makeIconEditorFrame

protected void makeIconEditorFrame(Container pos,
                                   String name,
                                   boolean table,
                                   IconAdder editor)

For item popups in Panel Editor

edit

protected void edit()

editIcon

protected void editIcon()

makePalettteFrame

protected void makePalettteFrame(String title)

For item popups in Control Panel Editor

setRotateMenu

public boolean setRotateMenu(JPopupMenu popup)

Rotate degrees return true if popup is set

Specified by:

setRotateMenu in interface Positionable

setScaleMenu

public boolean setScaleMenu(JPopupMenu popup)

Scale percentage return true if popup is set

Specified by:

setScaleMenu in interface Positionable

setTextEditMenu

public boolean setTextEditMenu(JPopupMenu popup)

Specified by:

setTextEditMenu in interface Positionable

setDisableControlMenu

public boolean setDisableControlMenu(JPopupMenu popup)

Specified by:

setDisableControlMenu in interface Positionable

setScale

public void setScale(double s)

Specified by:

setScale in interface Positionable

getScale

public double getScale()

Specified by:

getScale in interface Positionable

saveOpaque

public void saveOpaque(boolean set)

getSaveOpaque

public boolean getSaveOpaque()

Specified by:

getSaveOpaque in interface Positionable

rotate

public void rotate(int deg)

Specified by:

rotate in interface Positionable

makeTextOverlaidIcon

protected NamedIcon makeTextOverlaidIcon(String text,
                                         NamedIcon ic)

Create an image of icon with text overlaid

setDegrees

public void setDegrees(int deg)

getDegrees

public int getDegrees()

Specified by:

getDegrees in interface Positionable

dispose

public void dispose()

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

remove

public void remove()

Removes this object from display and persistance

Specified by:

remove in interface Positionable

isActive

public boolean isActive()

"active" means that the object is still displayed, and should be stored.

setSuperText

protected void setSuperText(String text)

setText

public void setText(String text)

Overrides:

setText in class JLabel

getSize

public Dimension getSize()

Overrides:

getSize in class Component

getHeight

public int getHeight()

Specified by:

getHeight in interface Positionable

Overrides:

getHeight in class JComponent

getWidth

public int getWidth()

Specified by:

getWidth in interface Positionable

Overrides:

getWidth in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getNamedBean

public NamedBean getNamedBean()

Provides a generic method to return the bean associated with the Positionable

Specified by:

getNamedBean in interface Positionable