Package jmri.jmrit.display

Interface Positionable

All Superinterfaces:

Cloneable, InlineLogixNG

All Known Subinterfaces:

IndicatorTrack

All Known Implementing Classes:

AnalogClock2Display, AudioIcon, BlockContentsIcon, BlockContentsIcon, GlobalVariableComboIcon, GlobalVariableIcon, GlobalVariableIcon, GlobalVariableInputIcon, GlobalVariableSpinnerIcon, IndicatorTrackIcon, IndicatorTurnoutIcon, LightIcon, LinkingLabel, LocoIcon, LocoLabel, LogixNGIcon, MemoryComboIcon, MemoryIcon, MemoryIcon, MemoryInputIcon, MemoryOrGVComboIcon, MemoryOrGVIcon, MemorySpinnerIcon, MultiSensorIcon, PortalIcon, PositionableCircle, PositionableEllipse, PositionableIcon, PositionableJComponent, PositionableJPanel, PositionableLabel, PositionablePolygon, PositionableRectangle, PositionableRoundRect, PositionableShape, ReporterIcon, RpsPositionIcon, SensorIcon, SignalHeadIcon, SignalMastIcon, SlipTurnoutIcon, TrainIcon, TurnoutIcon

public interface Positionable
extends Cloneable, InlineLogixNG

Defines display objects.

These are capable of:

• Being positioned by being dragged around on the screen. (See setPositionable(boolean))
• Being hidden. (See setHidden(boolean))
• Controlling the layout. (See setControlling(boolean))

These are manipulated externally, for example by a subclass of Editor. They are generally not stored directly as part of the state of the object, though they could be, but as part of the state of the external control.

Instead of the usual MouseEvent handling methods, e.g mouseClicked(...), Positionables have similar methods called doMouseClicked invoked by the Editor subclass that contains them, so the Editor can handle e.g. box selection, etc.

See Also:

• PositionableJComponent
• PositionableLabel

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Positionable.DuplicateIdException

Method Summary

Modifier and Type	Method	Description
void	addClass(String className)	Add a class name to this Positionable
boolean	contains(int x, int y)
Positionable	deepClone()	Make a deep copy of Positional object.
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.
Color	getBackground()
Rectangle	getBounds(Rectangle r)
Set<String>	getClasses()	Gets the class names of this Positionable
int	getDegrees()
int	getDisplayLevel()
Editor	getEditor()
default String	getEditorName()	Get the LogixNG of this InlineLogixNG.
Font	getFont()
Color	getForeground()
int	getHeight()
String	getId()	Gets the Id of this Positionable
Point	getLocation()
NamedBean	getNamedBean()
String	getNameString()	Get the name of the positional as a String.
Container	getParent()
PositionablePopupUtil	getPopupUtility()	Utility to handle Margins, Borders and other common popup items
Dimension	getPreferredSize()
double	getScale()
JComponent	getTextComponent()
ToolTip	getToolTip()
default String	getTypeName()	Get the type of item of this InlineLogixNG.
String	getTypeString()	Get the type of the positional as a String.
boolean	getViewCoordinates()
int	getWidth()
int	getX()	Get the X position of this InlineLogixNG.
int	getY()	Get the Y position of this InlineLogixNG.
void	invalidate()
boolean	isControlling()
boolean	isEditable()
boolean	isEmptyHidden()
boolean	isHidden()
boolean	isOpaque()
boolean	isPositionable()
boolean	isValueEditDisabled()
int	maxHeight()
int	maxWidth()
void	remove()
void	removeAllClasses()	Remove a class name to this Positionable
void	removeClass(String className)	Remove a class name to this Positionable
void	repaint()
boolean	requestFocusInWindow()
void	rotate(int deg)
void	setBackground(Color bg)
void	setBorder(Border border)
void	setControlling(boolean enabled)
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)
void	setEmptyHidden(boolean enabled)
void	setForeground(Color bg)
void	setHidden(boolean enabled)
void	setId(String id)	Sets the Id of this Positionable
void	setLocation(int x, int y)
void	setLocation(Point p)
void	setOpaque(boolean isOpaque)
void	setPopupUtility(PositionablePopupUtil tu)
void	setPositionable(boolean enabled)
boolean	setRotateMenu(JPopupMenu popup)	Add additional menu items to the menu.
boolean	setRotateOrthogonalMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setScale(double s)
boolean	setScaleMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setShowToolTip(boolean set)
void	setSize(int width, int height)
boolean	setTextEditMenu(JPopupMenu popup)	Add additional menu items to the menu.
void	setToolTip(ToolTip tip)
void	setValueEditDisabled(boolean disabled)
void	setViewCoordinates(boolean enabled)
void	setVisible(boolean b)
void	showHidden()
boolean	showPopUp(JPopupMenu popup)
boolean	showToolTip()
boolean	storeItem()	Check if a permanent copy of this Positionable should be stored.
void	updateSize()

Methods inherited from interface jmri.jmrit.logixng.InlineLogixNG

getLogixNG, setLogixNG, setLogixNG_SystemName, setupLogixNG

Method Details

setId

void setId(String id)
    throws Positionable.DuplicateIdException

Sets the Id of this Positionable

Parameters:

id - the id or null if no id

Throws:

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

getId

String getId()

Gets the Id of this Positionable

Returns:

the id or null if no id

addClass

void addClass(String className)

Add a class name to this Positionable

Parameters:

className - the class name

Throws:

IllegalArgumentException - className is null or has a comma

removeClass

void removeClass(String className)

Remove a class name to this Positionable

Parameters:

className - the class name

removeAllClasses

void removeAllClasses()

Remove a class name to this Positionable

getClasses

Set<String> getClasses()

Gets the class names of this Positionable

Returns:

the classes

setPositionable

void setPositionable(boolean enabled)

isPositionable

boolean isPositionable()

setEditable

void setEditable(boolean enabled)

isEditable

boolean isEditable()

setShowToolTip

void setShowToolTip(boolean set)

showToolTip

boolean showToolTip()

setToolTip

void setToolTip(ToolTip tip)

getToolTip

ToolTip getToolTip()

setViewCoordinates

void setViewCoordinates(boolean enabled)

getViewCoordinates

boolean getViewCoordinates()

setControlling

void setControlling(boolean enabled)

isControlling

boolean isControlling()

setHidden

void setHidden(boolean enabled)

isHidden

boolean isHidden()

showHidden

void showHidden()

setEmptyHidden

void setEmptyHidden(boolean enabled)

isEmptyHidden

boolean isEmptyHidden()

setValueEditDisabled

void setValueEditDisabled(boolean disabled)

isValueEditDisabled

boolean isValueEditDisabled()

getDisplayLevel

int getDisplayLevel()

setDisplayLevel

void setDisplayLevel(int l)

getEditor

Editor getEditor()

setEditor

void setEditor(Editor ed)

updateSize

void updateSize()

maxWidth

int maxWidth()

maxHeight

int maxHeight()

deepClone

Positionable deepClone()

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.

Returns:

the copy

getTypeString

String getTypeString()

Get the type of the positional as a String.

Returns:

the type to display

getNameString

String getNameString()

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

Returns:

the name to display

getTypeName

default String getTypeName()

Get the type of item of this InlineLogixNG.

Specified by:

getTypeName in interface InlineLogixNG

Returns:

the type

setRotateOrthogonalMenu

boolean setRotateOrthogonalMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setRotateMenu

boolean setRotateMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setScaleMenu

boolean setScaleMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setEditIconMenu

boolean setEditIconMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setEditItemMenu

boolean setEditItemMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setDisableControlMenu

boolean setDisableControlMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

setTextEditMenu

boolean setTextEditMenu(JPopupMenu popup)

Add additional menu items to the menu.

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

showPopUp

boolean showPopUp(JPopupMenu popup)

setScale

void setScale(double s)

getScale

double getScale()

rotate

void rotate(int deg)

getDegrees

int getDegrees()

getTextComponent

JComponent getTextComponent()

remove

void remove()

storeItem

boolean storeItem()

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

Returns:

true if this Positionable should be stored; false otherwise

doViemMenu

boolean doViemMenu()

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.

Returns:

true if Editor may add the standardpopup menu items

getPopupUtility

PositionablePopupUtil getPopupUtility()

Utility to handle Margins, Borders and other common popup items

Returns:

null if these item do not apply

setPopupUtility

void setPopupUtility(PositionablePopupUtil tu)

getNamedBean

NamedBean getNamedBean()

doMousePressed

void doMousePressed(JmriMouseEvent event)

doMouseReleased

void doMouseReleased(JmriMouseEvent event)

doMouseClicked

void doMouseClicked(JmriMouseEvent event)

doMouseDragged

void doMouseDragged(JmriMouseEvent event)

doMouseMoved

void doMouseMoved(JmriMouseEvent event)

doMouseEntered

void doMouseEntered(JmriMouseEvent event)

doMouseExited

void doMouseExited(JmriMouseEvent event)

getBounds

Rectangle getBounds(Rectangle r)

contains

boolean contains(int x,
 int y)

getX

int getX()

Description copied from interface: InlineLogixNG

Get the X position of this InlineLogixNG.

Specified by:

getX in interface InlineLogixNG

Returns:

the X position

getY

int getY()

Description copied from interface: InlineLogixNG

Get the Y position of this InlineLogixNG.

Specified by:

getY in interface InlineLogixNG

Returns:

the Y position

getLocation

Point getLocation()

setLocation

void setLocation(int x,
 int y)

setLocation

void setLocation(Point p)

setSize

void setSize(int width,
 int height)

setVisible

void setVisible(boolean b)

getWidth

int getWidth()

getHeight

int getHeight()

getParent

Container getParent()

setOpaque

void setOpaque(boolean isOpaque)

isOpaque

boolean isOpaque()

setBackground

void setBackground(Color bg)

getBackground

Color getBackground()

setForeground

void setForeground(Color bg)

getForeground

Color getForeground()

getFont

Font getFont()

setBorder

void setBorder(Border border)

getPreferredSize

Dimension getPreferredSize()

invalidate

void invalidate()

repaint

void repaint()

requestFocusInWindow

boolean requestFocusInWindow()

getEditorName

default String getEditorName()

Description copied from interface: InlineLogixNG

Get the LogixNG of this InlineLogixNG.

Specified by:

getEditorName in interface InlineLogixNG

Returns:

the LogixNG or null if it has no LogixNG