jmri.jmrit.display
Interface Positionable

All Superinterfaces:

Cloneable

All Known Subinterfaces:

IndicatorTrack

All Known Implementing Classes:

AnalogClock2Display, IndicatorTrackIcon, IndicatorTurnoutIcon, LightIcon, LocoIcon, MemoryIcon, MemoryIcon, MemoryInputIcon, MemorySpinnerIcon, MultiSensorIcon, PortalIcon, PositionableIcon, PositionableJComponent, PositionableJPanel, PositionableLabel, ReporterIcon, RpsPositionIcon, SecurityElementIcon, SensorIcon, SignalHeadIcon, SignalMastIcon, SlipTurnoutIcon, TrainIcon, TurnoutIcon

public interface Positionable
extends Cloneable

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.

  Author:

  Bob Jacobsen Copyright (c) 2002, Pete Cressman Copyright (c) 2010

  See Also:

  PositionableJComponent, PositionableLabel

  Method Summary

  boolean	contains(int x, int y)
  Positionable	deepClone() Make a deep copy of Positional object.
  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.
  Positionable	finishClone(Positionable p) Finsh the deep Copy of a Positional object.
  Color	getBackground()
  Rectangle	getBounds(Rectangle r)
  int	getDegrees()
  int	getDisplayLevel()
  Editor	getEditor()
  Font	getFont()
  Color	getForeground()
  int	getHeight()
  Point	getLocation()
  String	getNameString() Methods to add popup menu items return true if a popup item is set
  Container	getParent()
  PositionablePopupUtil	getPopupUtility()
  Dimension	getPreferredSize()
  double	getScale()
  ToolTip	getTooltip()
  boolean	getViewCoordinates()
  int	getWidth()
  int	getX()
  int	getY()
  void	invalidate()
  boolean	isControlling()
  boolean	isEditable()
  boolean	isHidden()
  boolean	isOpaque()
  boolean	isPositionable()
  int	maxHeight()
  int	maxWidth()
  void	remove()
  void	repaint()
  void	rotate(int deg)
  void	setBackground(Color bg)
  void	setBorder(Border border)
  void	setControlling(boolean enabled)
  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	setForeground(Color bg)
  void	setHidden(boolean enabled)
  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)
  boolean	setRotateOrthogonalMenu(JPopupMenu popup)
  void	setScale(double s)
  boolean	setScaleMenu(JPopupMenu popup)
  void	setShowTooltip(boolean set)
  void	setSize(int width, int height)
  boolean	setTextEditMenu(JPopupMenu popup)
  void	setTooltip(ToolTip tip)
  void	setViewCoordinates(boolean enabled)
  void	setVisible(boolean b)
  void	showHidden()
  boolean	showPopUp(JPopupMenu popup)
  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	updateSize()

  Method Detail

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

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

  finishClone

  Positionable finishClone(Positionable p)

  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.

  getNameString

  String getNameString()

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

  setRotateOrthogonalMenu

  boolean setRotateOrthogonalMenu(JPopupMenu popup)

  setRotateMenu

  boolean setRotateMenu(JPopupMenu popup)

  setScaleMenu

  boolean setScaleMenu(JPopupMenu popup)

  setEditIconMenu

  boolean setEditIconMenu(JPopupMenu popup)

  setEditItemMenu

  boolean setEditItemMenu(JPopupMenu popup)

  setDisableControlMenu

  boolean setDisableControlMenu(JPopupMenu popup)

  setTextEditMenu

  boolean setTextEditMenu(JPopupMenu popup)

  showPopUp

  boolean showPopUp(JPopupMenu popup)

  setScale

  void setScale(double s)

  getScale

  double getScale()

  rotate

  void rotate(int deg)

  getDegrees

  int getDegrees()

  remove

  void remove()

  storeItem

  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.

  Returns:

  true if the Editor should store this in the configuration file

  doViemMenu

  boolean doViemMenu()

  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.

  Returns:

  true if Editor may add the standardpopup menu items

  getPopupUtility

  PositionablePopupUtil getPopupUtility()

  setPopupUtility

  void setPopupUtility(PositionablePopupUtil tu)

  doMousePressed

  void doMousePressed(MouseEvent event)

  doMouseReleased

  void doMouseReleased(MouseEvent event)

  doMouseClicked

  void doMouseClicked(MouseEvent event)

  doMouseDragged

  void doMouseDragged(MouseEvent event)

  doMouseMoved

  void doMouseMoved(MouseEvent event)

  doMouseEntered

  void doMouseEntered(MouseEvent event)

  doMouseExited

  void doMouseExited(MouseEvent event)

  getBounds

  Rectangle getBounds(Rectangle r)

  contains

  boolean contains(int x,
                   int y)

  getX

  int getX()

  getY

  int getY()

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