Package jmri.jmrit.display

Class PositionableLabel

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

Direct Known Subclasses:

AudioIcon, LightIcon, LinkingLabel, LocoIcon, LogixNGIcon, MemoryOrGVIcon, MultiSensorIcon, PositionableIcon, ReporterIcon, RpsPositionIcon, SlipTurnoutIcon

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

Modifier and Type	Class	Description
(package private) static class	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
protected boolean	_control
protected boolean	_controlling
protected int	_displayLevel
protected boolean	_editable
protected Editor	_editor
protected boolean	_emptyHidden
protected boolean	_hidden
protected boolean	_icon
(package private) IconAdder	_iconEditor
(package private) JFrame	_iconEditorFrame
(package private) IconItemPanel	_iconItemPanel
(package private) TextItemPanel	_itemPanel
protected NamedIcon	_namedIcon
DisplayFrame	_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	_valueEditDisabled
protected boolean	_viewCoordinates
(package private) boolean	active
(package private) JCheckBoxMenuItem	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, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
PositionableLabel(String s, Editor editor)	Create a new Positionable Label.
PositionableLabel(NamedIcon s, Editor editor)

Method Summary

Modifier and Type	Method	Description
void	addClass(String className)	Add a class name to this Positionable
static 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(JmriMouseEvent event)
void	doMouseDragged(JmriMouseEvent event)
void	doMouseEntered(JmriMouseEvent event)
void	doMouseExited(JmriMouseEvent event)
void	doMouseMoved(JmriMouseEvent event)
void	doMousePressed(JmriMouseEvent event)
void	doMouseReleased(JmriMouseEvent event)
boolean	doViemMenu()	Use the 'Standard' presentation of the popup menu items.
protected void	edit()
protected void	editIcon()
protected void	editIconItem()
protected void	editTextItem()
protected Positionable	finishClone(PositionableLabel pos)
void	finishItemUpdate(DisplayFrame paletteFrame, ItemPanel itemPanel)
Set<String>	getClasses()	Gets the class names of this Positionable
int	getDegrees()
int	getDisplayLevel()
Editor	getEditor()
int	getHeight()
String	getId()	Gets the Id of this Positionable
LogixNG	getLogixNG()	Get the LogixNG of this InlineLogixNG.
NamedBean	getNamedBean()	Provide a generic method to return the bean associated with the Positionable.
String	getNameString()	Get the name of the positional as a String.
PositionablePopupUtil	getPopupUtility()	Utility to handle Margins, Borders and other common popup items
double	getScale()
Dimension	getSize()
JComponent	getTextComponent()
ToolTip	getToolTip()
String	getTypeString()	Get the type of the positional as a String.
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()
void	initPaletteFrame(DisplayFrame paletteFrame, ItemPanel itemPanel)
boolean	isActive()	Check if the component is still displayed, and should be stored.
boolean	isBackground()
final boolean	isControl()
boolean	isControlling()
boolean	isEditable()
boolean	isEmptyHidden()
boolean	isHidden()
final boolean	isIcon()
final boolean	isPositionable()
boolean	isRotated()
final boolean	isText()
boolean	isValueEditDisabled()
protected void	makeIconEditorFrame(Container pos, String name, boolean table, IconAdder editor)	For item popups in Panel Editor.
DisplayFrame	makePaletteFrame(String title)	Create a palette window.
protected NamedIcon	makeTextOverlaidIcon(String text, NamedIcon ic)	Create an image of icon with overlaid text.
int	maxHeight()
int	maxHeightTrue()
int	maxWidth()
int	maxWidthTrue()
protected void	paintComponent(Graphics g)
void	remove()	Removes this object from display and persistance
void	removeAllClasses()	Remove a class name to this Positionable
void	removeClass(String className)	Remove a class name to this Positionable
void	rotate(int deg)
protected void	rotateOrthogonal()
void	setControlling(boolean enabled)
void	setDegrees(int deg)
boolean	setDisableControlMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setDisplayLevel(int l)
void	setEditable(boolean enabled)
boolean	setEditIconMenu(JPopupMenu popup)	Add additional menu items to the menu.
boolean	setEditItemMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setEditor(Editor ed)
boolean	setEditTextItemMenu(JPopupMenu popup)
void	setEmptyHidden(boolean hide)
void	setHidden(boolean hide)
void	setIcon(NamedIcon icon)
void	setId(String id)	Sets the Id of this Positionable
void	setLevel(int l)	Delayed setDisplayLevel for DnD.
void	setLogixNG(LogixNG logixNG)	Set the LogixNG of this InlineLogixNG.
void	setLogixNG_SystemName(String systemName)	Set the system name for the LogixNG of this InlineLogixNG.
void	setPopupUtility(PositionablePopupUtil tu)
void	setPositionable(boolean enabled)
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 form display.
void	setShowToolTip(boolean set)
protected void	setSuperText(String text)
void	setText(String text)
boolean	setTextEditMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setToolTip(ToolTip tip)
void	setUnRotatedText(String s)
void	setupLogixNG()	Setup the LogixNG of this InlineLogixNG.
void	setValueEditDisabled(boolean isDisabled)
void	setViewCoordinates(boolean enabled)
void	showEmptyHidden()
void	showHidden()
boolean	showPopUp(JPopupMenu popup)	Call to a Positionable that has unique requirements - e.g.
boolean	showToolTip()
boolean	storeItem()	Check if a permanent copy of this Positionable should be stored.
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
protected void	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, 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, setLocation, setOpaque, setSize, setVisible

Field Details

_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

_emptyHidden

protected boolean _emptyHidden

_valueEditDisabled

protected boolean _valueEditDisabled

_displayLevel

protected int _displayLevel

_unRotatedText

protected String _unRotatedText

_rotateText

protected boolean _rotateText

_popupUtil

PositionablePopupUtil _popupUtil

*************************************************************

_iconEditorFrame

JFrame _iconEditorFrame

_iconEditor

IconAdder _iconEditor

_paletteFrame

public DisplayFrame _paletteFrame

_iconItemPanel

IconItemPanel _iconItemPanel

_itemPanel

TextItemPanel _itemPanel

disableItem

JCheckBoxMenuItem disableItem

active

boolean active

Constructor Details

PositionableLabel

public PositionableLabel(String s,
 @Nonnull
 Editor editor)

Create a new Positionable Label.

Parameters:

s - label string.

editor - where this label is displayed.

PositionableLabel

public PositionableLabel(@CheckForNull
 NamedIcon s,
 @Nonnull
 Editor editor)

Method Details

setId

public void setId(String id)
           throws Positionable.DuplicateIdException

Sets the Id of this Positionable

Specified by:

setId in interface Positionable

Parameters:

id - the id or null if no id

Throws:

Positionable.DuplicateIdException - if another Positionable in the editor already has this id

getId

public String getId()

Gets the Id of this Positionable

Specified by:

getId in interface Positionable

Returns:

the id or null if no id

addClass

public void addClass(String className)

Add a class name to this Positionable

Specified by:

addClass in interface Positionable

Parameters:

className - the class name

removeClass

public void removeClass(String className)

Remove a class name to this Positionable

Specified by:

removeClass in interface Positionable

Parameters:

className - the class name

removeAllClasses

public void removeAllClasses()

Remove a class name to this Positionable

Specified by:

removeAllClasses in interface Positionable

getClasses

public Set<String> getClasses()

Gets the class names of this Positionable

Specified by:

getClasses in interface Positionable

Returns:

the classes

isIcon

public final boolean isIcon()

isText

public final boolean isText()

isControl

public final boolean isControl()

getEditor

@Nonnull
public Editor getEditor()

Specified by:

getEditor in interface Positionable

setEditor

public void setEditor(@Nonnull
 Editor ed)

Specified by:

setEditor in interface Positionable

setPositionable

public void setPositionable(boolean enabled)

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

setEmptyHidden

public void setEmptyHidden(boolean hide)

Specified by:

setEmptyHidden in interface Positionable

isEmptyHidden

public boolean isEmptyHidden()

Specified by:

isEmptyHidden in interface Positionable

setValueEditDisabled

public void setValueEditDisabled(boolean isDisabled)

Specified by:

setValueEditDisabled in interface Positionable

isValueEditDisabled

public boolean isValueEditDisabled()

Specified by:

isValueEditDisabled in interface Positionable

showEmptyHidden

public void showEmptyHidden()

setLevel

public void setLevel(int l)

Delayed setDisplayLevel for DnD.

Parameters:

l - the level to set

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

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

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

Returns:

the name to display

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

setUnRotatedText

public void setUnRotatedText(String s)

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

Returns:

the copy

finishClone

@Nonnull
protected Positionable finishClone(@Nonnull
 PositionableLabel pos)

getTextComponent

@Nonnull
public JComponent getTextComponent()

Specified by:

getTextComponent in interface Positionable

cloneIcon

@Nonnull
public static NamedIcon cloneIcon(NamedIcon icon,
 PositionableLabel pos)

doMousePressed

public void doMousePressed(JmriMouseEvent event)

Specified by:

doMousePressed in interface Positionable

doMouseReleased

public void doMouseReleased(JmriMouseEvent event)

Specified by:

doMouseReleased in interface Positionable

doMouseClicked

public void doMouseClicked(JmriMouseEvent event)

Specified by:

doMouseClicked in interface Positionable

doMouseDragged

public void doMouseDragged(JmriMouseEvent event)

Specified by:

doMouseDragged in interface Positionable

doMouseMoved

public void doMouseMoved(JmriMouseEvent event)

Specified by:

doMouseMoved in interface Positionable

doMouseEntered

public void doMouseEntered(JmriMouseEvent event)

Specified by:

doMouseEntered in interface Positionable

doMouseExited

public void doMouseExited(JmriMouseEvent event)

Specified by:

doMouseExited in interface Positionable

storeItem

public boolean storeItem()

Description copied from interface: Positionable

Check if a permanent copy of this Positionable should be stored.

Specified by:

storeItem in interface Positionable

Returns:

true if this Positionable should be stored; false otherwise

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 create 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()

Description copied from interface: Positionable

Utility to handle Margins, Borders and other common popup items

Specified by:

getPopupUtility in interface Positionable

Returns:

null if these item do not apply

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

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

rotateOrthogonal

protected void rotateOrthogonal()

setEditIconMenu

public boolean setEditIconMenu(JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setEditIconMenu in interface Positionable

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

makeIconEditorFrame

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

For item popups in Panel Editor.

Parameters:

pos - the container

name - the name

table - true if creating a table; false otherwise

editor - the associated editor

edit

protected void edit()

editIcon

protected void editIcon()

makePaletteFrame

public DisplayFrame makePaletteFrame(String title)

Create a palette window.

Parameters:

title - the name of the palette

Returns:

DisplayFrame for palette item

initPaletteFrame

public void initPaletteFrame(DisplayFrame paletteFrame,
 @Nonnull
 ItemPanel itemPanel)

finishItemUpdate

public void finishItemUpdate(DisplayFrame paletteFrame,
 @Nonnull
 ItemPanel itemPanel)

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

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

editIconItem

protected void editIconItem()

setEditTextItemMenu

public boolean setEditTextItemMenu(JPopupMenu popup)

editTextItem

protected void editTextItem()

updateTextItem

protected void updateTextItem()

setRotateMenu

public boolean setRotateMenu(@Nonnull
 JPopupMenu popup)

Rotate degrees return true if popup is set.

Specified by:

setRotateMenu in interface Positionable

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setScaleMenu

public boolean setScaleMenu(@Nonnull
 JPopupMenu popup)

Scale percentage form display.

Specified by:

setScaleMenu in interface Positionable

Parameters:

popup - the menu to add the menu items to

Returns:

true if popup is set

setTextEditMenu

public boolean setTextEditMenu(@Nonnull
 JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setTextEditMenu in interface Positionable

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setDisableControlMenu

public boolean setDisableControlMenu(@Nonnull
 JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setDisableControlMenu in interface Positionable

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setScale

public void setScale(double s)

Specified by:

setScale in interface Positionable

getScale

public double getScale()

Specified by:

getScale in interface Positionable

setIcon

public void setIcon(NamedIcon icon)

rotate

public void rotate(int deg)

Specified by:

rotate in interface Positionable

makeTextOverlaidIcon

protected NamedIcon makeTextOverlaidIcon(String text,
 @Nonnull
 NamedIcon ic)

Create an image of icon with overlaid text.

Parameters:

text - the text to overlay

ic - the icon containing the image

Returns:

the icon overlaying text on ic

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()

Check if the component is still displayed, and should be stored.

Returns:

true if active; false otherwise

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()

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

Specified by:

getNamedBean in interface Positionable

getLogixNG

public LogixNG getLogixNG()

Get the LogixNG of this InlineLogixNG.

Specified by:

getLogixNG in interface InlineLogixNG

Returns:

the LogixNG or null if it has no LogixNG

setLogixNG

public void setLogixNG(LogixNG logixNG)

Set the LogixNG of this InlineLogixNG.

Specified by:

setLogixNG in interface InlineLogixNG

Parameters:

logixNG - the LogixNG or null if remove the LogixNG from the InlineLogixNG

setLogixNG_SystemName

public void setLogixNG_SystemName(String systemName)

Set the system name for the LogixNG of this InlineLogixNG.

Specified by:

setLogixNG_SystemName in interface InlineLogixNG

Parameters:

systemName - the system name

setupLogixNG

public void setupLogixNG()

Setup the LogixNG of this InlineLogixNG.

Specified by:

setupLogixNG in interface InlineLogixNG