Package com.inductiveautomation.rm.editor

Class RMEditorShape

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMParentShape

com.inductiveautomation.rm.viewer.RMViewerShape

com.inductiveautomation.rm.editor.RMEditorShape

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, PropertyChangeListener, Cloneable, EventListener

public class RMEditorShape
extends RMViewerShape

The root shape for RMEditor.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

Constructor Summary

Constructors

Constructor	Description
RMEditorShape(RMEditor anEditor)	Creates a new editor shape.

Method Summary

Modifier and Type	Method	Description
RMColor	getColor()	Returns the color of the shape.
RMEditor	getEditor()	Returns the editor.
double	getGridSpacing()	Returns the content grid spacing.
float	getOpacity()	Returns the opacity of the shape (1 for opaque, 0 for transparent).
boolean	getSnapGrid()	Returns whether content snaps to grid.
boolean	getSnapMargin()	Returns whether content snaps to margin.
RMStroke	getStroke()	Returns the stroke for this shape.
int	getStrokeStyle()
RMUndoer	getUndoer()	Returns the undoer.
boolean	isUseFill()	useFill etc exist only to make the background of the page act like selecting the page itself.
void	setColor(RMColor aColor)	Sets the color of the shape.
void	setContent(RMParentShape aShape)	Override to do stuff for editor shape.
void	setOpacity(float aValue)	Sets the opacity of the shape (1 for opaque, 0 for transparent).
void	setStroke(RMStroke aStroke)	Sets the stroke for this shape, with an option to turn on drawsStroke.
void	setStrokeStyle(int style)
void	setUseFill(boolean useFill)

Methods inherited from class com.inductiveautomation.rm.viewer.RMViewerShape

computePrefHeight, computePrefWidth, getChildAnimator, getContent, getContent, getContentBytes, getContentXML, getDocument, getPage, getPageCount, getSelectedPage, getSelectedPageIndex, getSourceURL, getViewer, isEditing, isViewing, layoutChildren, paint, repaint, setSelectedPageIndex, setSourceURL

Methods inherited from class com.inductiveautomation.rm.shape.RMParentShape

addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, clone, cloneDeep, divideShapeFromTop, fromXML, fromXMLChildren, fromXMLShape, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setWidth, toXML, toXMLChildren, toXMLShape

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildClipShape, getClipShape, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getPropertyNames, getRoll, getRootShape, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseStroke, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paintShape, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, resolvePageReferences, rpgBindings, rpgShape, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStrokeColor, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RMEditorShape

public RMEditorShape(RMEditor anEditor)

Creates a new editor shape.

Method Details

getEditor

public RMEditor getEditor()

Returns the editor.

setContent

public void setContent(RMParentShape aShape)

Override to do stuff for editor shape.

Overrides:

setContent in class RMViewerShape

getSnapGrid

public boolean getSnapGrid()

Returns whether content snaps to grid.

getGridSpacing

public double getGridSpacing()

Returns the content grid spacing.

getSnapMargin

public boolean getSnapMargin()

Returns whether content snaps to margin.

getUndoer

public RMUndoer getUndoer()

Returns the undoer.

Overrides:

getUndoer in class RMShape

isUseFill

public boolean isUseFill()

useFill etc exist only to make the background of the page act like selecting the page itself. That way, when users edit properties they see when selecting the background, the behavior is something they expect.

Overrides:

isUseFill in class RMShape

setUseFill

public void setUseFill(boolean useFill)

Overrides:

setUseFill in class RMShape

getColor

public RMColor getColor()

Description copied from class: RMShape

Returns the color of the shape.

Overrides:

getColor in class RMShape

setColor

public void setColor(RMColor aColor)

Description copied from class: RMShape

Sets the color of the shape.

Overrides:

setColor in class RMShape

getOpacity

public float getOpacity()

Description copied from class: RMShape

Returns the opacity of the shape (1 for opaque, 0 for transparent).

Overrides:

getOpacity in class RMShape

setOpacity

public void setOpacity(float aValue)

Description copied from class: RMShape

Sets the opacity of the shape (1 for opaque, 0 for transparent).

Overrides:

setOpacity in class RMShape

getStrokeStyle

public int getStrokeStyle()

Overrides:

getStrokeStyle in class RMShape

setStrokeStyle

public void setStrokeStyle(int style)

Overrides:

setStrokeStyle in class RMShape

getStroke

public RMStroke getStroke()

Description copied from class: RMShape

Returns the stroke for this shape.

Overrides:

getStroke in class RMShape

setStroke

public void setStroke(RMStroke aStroke)

Sets the stroke for this shape, with an option to turn on drawsStroke.

Overrides:

setStroke in class RMShape