Package jmri.jmrit.display.controlPanelEditor.shape

Class PositionableShape

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

jmri.jmrit.display.PositionableJComponent

jmri.jmrit.display.controlPanelEditor.shape.PositionableShape

All Implemented Interfaces:

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

Direct Known Subclasses:

PositionableCircle, PositionablePolygon, PositionableRectangle

public abstract class PositionableShape
extends PositionableJComponent
implements PropertyChangeListener

PositionableShape is item drawn by java.awt.Graphics2D.

See Also:

• Serialized Form

Nested Class Summary

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 DrawFrame	_editFrame
protected Color	_fillColor
protected int	_height
protected int	_hitIndex
protected int	_lastX
protected int	_lastY
protected Color	_lineColor
protected AffineTransform	_transform
protected int	_width
(package private) static final int	BOTTOM
(package private) static final int	LEFT
(package private) static final int	RIGHT
(package private) static final int	SIZE
(package private) static final int	TOP

Fields inherited from class jmri.jmrit.display.PositionableJComponent

_editor

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

Constructor Summary

Constructors

Constructor	Description
PositionableShape(Editor editor)
PositionableShape(Editor editor, Shape shape)

Method Summary

Modifier and Type	Method	Description
abstract Positionable	deepClone()	Make a deep copy of Positional object.
protected boolean	doHandleMove(JmriMouseEvent event)
void	doMousePressed(JmriMouseEvent event)
void	drawHandles()
protected Positionable	finishClone(PositionableShape pos)
int	getChangeLevel()
Sensor	getControlSensor()
NamedBeanHandle<Sensor>	getControlSensorHandle()
int	getDegrees()
protected DrawFrame	getEditFrame()
Color	getFillColor()
int	getHeight()
Point	getInversePoint(int x, int y)
Color	getLineColor()
int	getLineWidth()
PathIterator	getPathIterator(AffineTransform at)
protected String	getSensorName()
protected Shape	getShape()
Dimension	getSize(Dimension rv)
AffineTransform	getTransform()
int	getWidth()
protected void	invalidateShape()	Force the shape to be regenerated next time it is needed.
boolean	isHideOnSensor()
protected abstract DrawFrame	makeEditFrame(boolean create)
protected abstract Shape	makeShape()	Create the shape returned by getShape().
int	maxHeight()	The custom paint method paints a border outside of the bounds.
int	maxWidth()	The custom paint method paints a border outside of the bounds.
void	paint(Graphics g)
protected void	paintHandles(Graphics2D g2d)
void	propertyChange(PropertyChangeEvent evt)
void	removeHandles()
protected void	removeListener()
void	rotate(int deg)
void	setChangeLevel(int l)
String	setControlSensor(String pName)	Attach a named sensor to a PositionableShape.
void	setDisplayLevel(int l)
void	setFillColor(Color c)
void	setHeight(int h)
void	setHide(boolean h)
void	setLineColor(Color c)
void	setLineWidth(int w)
void	setListener()
boolean	setRotateMenu(JPopupMenu popup)	Add a rotation menu to the contextual menu for this PostionableShape.
boolean	setScaleMenu(JPopupMenu popup)	Add additional menu items to the menu.
protected void	setShape(Shape s)
void	setWidth(int w)
boolean	showPopUp(JPopupMenu popup)
void	updateSize()

Methods inherited from class jmri.jmrit.display.PositionableJComponent

addClass, displayState, doMouseClicked, doMouseDragged, doMouseEntered, doMouseExited, doMouseMoved, doMouseReleased, doViemMenu, finishClone, getClasses, getDisplayLevel, getEditor, getId, getLogixNG, getNamedBean, getNameString, getPopupUtility, getScale, getTextComponent, getToolTip, getTypeString, getViewCoordinates, isActive, isControlling, isEditable, isEmptyHidden, isHidden, isPositionable, isValueEditDisabled, remove, removeAllClasses, removeClass, setControlling, setDisableControlMenu, setEditable, setEditIconMenu, setEditItemMenu, setEditor, setEmptyHidden, setHidden, setId, setLevel, setLogixNG, setLogixNG_SystemName, setPopupUtility, setPositionable, setRotateOrthogonalMenu, setScale, setShowToolTip, setTextEditMenu, setToolTip, setupLogixNG, setValueEditDisabled, setViewCoordinates, showHidden, showToolTip, storeItem

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, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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, getAccessibleContext, 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, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, 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

_lineColor

protected Color _lineColor

_fillColor

protected Color _fillColor

_transform

protected AffineTransform _transform

_hitIndex

protected int _hitIndex

_lastX

protected int _lastX

_lastY

protected int _lastY

_width

protected int _width

_height

protected int _height

_editFrame

protected DrawFrame _editFrame

TOP

static final int TOP

See Also:

• Constant Field Values

RIGHT

static final int RIGHT

See Also:

• Constant Field Values

BOTTOM

static final int BOTTOM

See Also:

• Constant Field Values

LEFT

static final int LEFT

See Also:

• Constant Field Values

SIZE

static final int SIZE

See Also:

• Constant Field Values

Constructor Details

PositionableShape

public PositionableShape(Editor editor)

PositionableShape

public PositionableShape(Editor editor,
 @Nonnull
 Shape shape)

Method Details

getPathIterator

public PathIterator getPathIterator(AffineTransform at)

setShape

protected void setShape(@Nonnull
 Shape s)

getShape

@Nonnull
protected Shape getShape()

getTransform

public AffineTransform getTransform()

setWidth

public void setWidth(int w)

setHeight

public void setHeight(int h)

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

makeShape

@Nonnull
protected abstract Shape makeShape()

Create the shape returned by getShape().

Returns:

the created shape

invalidateShape

protected void invalidateShape()

Force the shape to be regenerated next time it is needed.

setLineColor

public void setLineColor(Color c)

getLineColor

public Color getLineColor()

setFillColor

public void setFillColor(Color c)

getFillColor

public Color getFillColor()

setLineWidth

public void setLineWidth(int w)

getLineWidth

public int getLineWidth()

rotate

public void rotate(int deg)

Specified by:

rotate in interface Positionable

Overrides:

rotate in class PositionableJComponent

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

paintHandles

protected void paintHandles(Graphics2D g2d)

deepClone

public abstract 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 PositionableJComponent

Returns:

the copy

finishClone

protected Positionable finishClone(PositionableShape pos)

getSize

public Dimension getSize(Dimension rv)

Overrides:

getSize in class JComponent

updateSize

public void updateSize()

Specified by:

updateSize in interface Positionable

Overrides:

updateSize in class PositionableJComponent

maxWidth

public int maxWidth()

The custom paint method paints a border outside of the bounds.

Specified by:

maxWidth in interface Positionable

Overrides:

maxWidth in class PositionableJComponent

maxHeight

public int maxHeight()

The custom paint method paints a border outside of the bounds.

Specified by:

maxHeight in interface Positionable

Overrides:

maxHeight in class PositionableJComponent

showPopUp

public boolean showPopUp(JPopupMenu popup)

Specified by:

showPopUp in interface Positionable

Overrides:

showPopUp in class PositionableJComponent

setRotateMenu

public boolean setRotateMenu(JPopupMenu popup)

Add a rotation menu to the contextual menu for this PostionableShape.

Specified by:

setRotateMenu in interface Positionable

Overrides:

setRotateMenu in class PositionableJComponent

Parameters:

popup - the menu to add a rotation menu to

Returns:

true if rotation menu is added; false otherwise

setScaleMenu

public boolean setScaleMenu(JPopupMenu popup)

Description copied from interface: Positionable

Add additional menu items to the menu.

Specified by:

setScaleMenu in interface Positionable

Overrides:

setScaleMenu in class PositionableJComponent

Parameters:

popup - the menu to add the menu items to

Returns:

true if adding items; false otherwise

getDegrees

public int getDegrees()

Specified by:

getDegrees in interface Positionable

Overrides:

getDegrees in class PositionableJComponent

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

setDisplayLevel

public void setDisplayLevel(int l)

Specified by:

setDisplayLevel in interface Positionable

Overrides:

setDisplayLevel in class PositionableJComponent

setControlSensor

public String setControlSensor(String pName)

Attach a named sensor to a PositionableShape.

Parameters:

pName - Used as a system/user name to lookup the sensor object

Returns:

errror message or null

getControlSensor

public Sensor getControlSensor()

getSensorName

protected String getSensorName()

getControlSensorHandle

public NamedBeanHandle<Sensor> getControlSensorHandle()

isHideOnSensor

public boolean isHideOnSensor()

setHide

public void setHide(boolean h)

getChangeLevel

public int getChangeLevel()

setChangeLevel

public void setChangeLevel(int l)

setListener

public void setListener()

removeListener

protected void removeListener()

makeEditFrame

protected abstract DrawFrame makeEditFrame(boolean create)

getEditFrame

protected DrawFrame getEditFrame()

removeHandles

public void removeHandles()

drawHandles

public void drawHandles()

getInversePoint

public Point getInversePoint(int x,
 int y)
                      throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

doMousePressed

public void doMousePressed(JmriMouseEvent event)

Specified by:

doMousePressed in interface Positionable

Overrides:

doMousePressed in class PositionableJComponent

doHandleMove

protected boolean doHandleMove(JmriMouseEvent event)