Package com.inductiveautomation.rm.shape

Class RMNestedDoc

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.shape.RMNestedDoc

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, RMAnimator.Listener, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMNestedDoc
extends RMParentShape
implements RMAnimator.Listener

This class represents a shape for a document inside a page of another document.

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

Method Summary

Modifier and Type	Method	Description
void	animatorStarted(RMAnimator anAnimator)	Animator Listener method.
void	animatorStopped(RMAnimator anAnimator)	Animator listener method.
void	animatorUpdated(RMAnimator anAnimator)	Animator Listener method.
RMAnimator	getChildAnimator(boolean doCreate)	Returns the child animator associated with this page, creating one if it doesn't exist (if requested).
float	getDelay()	Returns the number of seconds the nested doc animation time lags the master document.
float	getGapDelay()	Returns the number of seconds the nested doc animation will wait between loops.
RMDocument	getNestedDoc()	Returns the nested document.
float	getScaleFactor()	Returns the relative speed of the nested docs animation relative to the master document.
RMPage	getSelectedPage()	Returns the selected page.
int	getSelectedPageIndex()	Returns the selected page index.
protected void	setChildAnimator(RMAnimator anAnimator)	Sets the child animator associated with this page.
void	setDelay(float aValue)	Sets the number of seconds the nested doc animation time lags the master document.
void	setGapDelay(float aValue)	Sets the number of seconds the nested doc animation will wait between loops.
void	setNestedDoc(RMDocument aDoc)	Sets the nested document.
void	setParent(RMParentShape aParent)	Overrides shape method to register this with animator listener, so nested doc can update child timeline.
void	setScaleFactor(float aValue)	Sets the relative speed of the nested docs animation relative to the master document.
void	setSelectedPageIndex(int anIndex)	Sets the selected page index for the nested doc.
boolean	superSelectable()	Editor method - indicates that nested doc is super-selectable.

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

addChild, addChild, addChild, addChild, addLayoutChild, bringShapesToFront, clone, cloneDeep, computePrefHeight, computePrefWidth, divideShapeFromTop, fromXML, fromXMLChildren, fromXMLShape, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isHittable, isShowing, isSourceURLSet, layout, layoutChildren, relayout, removeChild, removeChild, removeChildren, removeLayoutChild, rpgAll, rpgChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, 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, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, 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, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShape, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgBindings, rpgShape, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setX, setXY, setXY, setXYP, setY, shapeHidden, shapeShown, 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 Detail

RMNestedDoc

public RMNestedDoc()

Method Detail

getNestedDoc

public RMDocument getNestedDoc()

Returns the nested document.

setNestedDoc

public void setNestedDoc(RMDocument aDoc)

Sets the nested document.

getSelectedPageIndex

public int getSelectedPageIndex()

Returns the selected page index.

setSelectedPageIndex

public void setSelectedPageIndex(int anIndex)

Sets the selected page index for the nested doc.

getSelectedPage

public RMPage getSelectedPage()

Returns the selected page.

getDelay

public float getDelay()

Returns the number of seconds the nested doc animation time lags the master document.

setDelay

public void setDelay(float aValue)

Sets the number of seconds the nested doc animation time lags the master document.

getScaleFactor

public float getScaleFactor()

Returns the relative speed of the nested docs animation relative to the master document.

setScaleFactor

public void setScaleFactor(float aValue)

Sets the relative speed of the nested docs animation relative to the master document.

getGapDelay

public float getGapDelay()

Returns the number of seconds the nested doc animation will wait between loops.

setGapDelay

public void setGapDelay(float aValue)

Sets the number of seconds the nested doc animation will wait between loops.

setParent

public void setParent(RMParentShape aParent)

Overrides shape method to register this with animator listener, so nested doc can update child timeline.

Overrides:

setParent in class RMShape

getChildAnimator

public RMAnimator getChildAnimator(boolean doCreate)

Returns the child animator associated with this page, creating one if it doesn't exist (if requested).

Overrides:

getChildAnimator in class RMShape

setChildAnimator

protected void setChildAnimator(RMAnimator anAnimator)

Sets the child animator associated with this page.

animatorStarted

public void animatorStarted(RMAnimator anAnimator)

Animator Listener method.

Specified by:

animatorStarted in interface RMAnimator.Listener

animatorStopped

public void animatorStopped(RMAnimator anAnimator)

Animator listener method.

Specified by:

animatorStopped in interface RMAnimator.Listener

animatorUpdated

public void animatorUpdated(RMAnimator anAnimator)

Animator Listener method.

Specified by:

animatorUpdated in interface RMAnimator.Listener

superSelectable

public boolean superSelectable()

Editor method - indicates that nested doc is super-selectable.

Overrides:

superSelectable in class RMShape