RMNestedDoc

java.lang.Object
- com.reportmill.base.RMObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMNestedDoc

All Implemented Interfaces:

RMArchiver.Archiving, RMAnimator.Listener, java.lang.Cloneable
```
public class RMNestedDoc
extends RMShape
implements RMAnimator.Listener
```
This class represents a shape for a document inside a page of another document.

Field Summary
- Fields inherited from class com.reportmill.shape.RMShape
  WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors
Constructor and Description

RMNestedDoc()
Creates an unitialized nested doc.

RMNestedDoc(RMDocument aDocument)
Creates a new nested doc for given doc.

Constructors
Constructor and Description
`RMNestedDoc()` Creates an unitialized nested doc.
`RMNestedDoc(RMDocument aDocument)` Creates a new nested doc for given doc.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsChildren()` Editor method - indicates that nested doc can't accept children.
`void`	`animatorDidStop(RMAnimator anAnimator)` Animator listener callback.
`void`	`animatorDidUpdate(RMAnimator anAnimator)` Animator listener callback.
`boolean`	`childrenSuperSelectImmediately()` Editor method - indicates that children super-select immediately.
`RMShape`	`cloneDeep()` Clone deep implemenation.
`void`	`copy(java.lang.Object anObj)` Standard copy implementation.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementaion.
`RMAnimator`	`getChildAnimator(boolean create)` Returns the child animator for the nested doc (creating if absent and requested).
`java.util.List`	`getChildrenWhoHitTest()` Editor method - indicates that children aren't selectable.
`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.
`int`	`getPageCount()` Returns the number of pages in nested doc.
`float`	`getScaleFactor()` Returns the relative speed of the nested docs animation relative to the master document.
`java.lang.Object`	`initWithArchiver(RMArchiver anArchiver)` Legacy unarchival.
`RMShape`	`rpgClone(ReportMill reportMill)` RPG clone - returns a specific page.
`void`	`rpgClonePreprocess(ReportMill reportMill)` RPG cline - does work of nested doc.
`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`	`setParent(RMShape 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-selctable.

Methods inherited from class com.reportmill.shape.RMShape
acceptsDragKeys, acceptsFormat, acceptsMouse, addChild, addChild, addChildBelowLastChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, clone, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, delete, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, dropKeyAtPoint, fromXML, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWhoDraw, getChildSortedByX, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getToolClassName, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getXY, getXYP, getY, groupShapes, hasPageBreaks, height, indexOf, indexOf, intersects, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageBreakMax, pageBreakPageMax, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOpacity, setOutline, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, toString, toXML, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.base.RMObject
didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RMNestedDoc
```
public RMNestedDoc()
```
    Creates an unitialized nested doc.
  - RMNestedDoc
```
public RMNestedDoc(RMDocument aDocument)
```
    Creates a new nested doc for given doc.
- Method Detail
  - 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.
  - setSelectedPageIndex
```
public void setSelectedPageIndex(int anIndex)
```
    Sets the selected page index for the nested doc.
  - getChildAnimator
```
public RMAnimator getChildAnimator(boolean create)
```
    Returns the child animator for the nested doc (creating if absent and requested).
    
    Overrides:
    
    getChildAnimator in class RMShape
  - setParent
```
public void setParent(RMShape aParent)
```
    Overrides shape method to register this with animator listener, so nested doc can update child timeline.
    
    Overrides:
    
    setParent in class RMShape
  - animatorDidUpdate
```
public void animatorDidUpdate(RMAnimator anAnimator)
```
    Animator listener callback.
    
    Specified by:
    
    animatorDidUpdate in interface RMAnimator.Listener
  - animatorDidStop
```
public void animatorDidStop(RMAnimator anAnimator)
```
    Animator listener callback.
    
    Specified by:
    
    animatorDidStop in interface RMAnimator.Listener
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in nested doc.
    
    Overrides:
    
    getPageCount in class RMShape
  - rpgClonePreprocess
```
public void rpgClonePreprocess(ReportMill reportMill)
```
    RPG cline - does work of nested doc.
    
    Overrides:
    
    rpgClonePreprocess in class RMShape
  - rpgClone
```
public RMShape rpgClone(ReportMill reportMill)
```
    RPG clone - returns a specific page.
    
    Overrides:
    
    rpgClone in class RMShape
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementaion.
    
    Overrides:
    
    equals in class RMShape
  - copy
```
public void copy(java.lang.Object anObj)
```
    Standard copy implementation.
    
    Overrides:
    
    copy in class RMShape
  - cloneDeep
```
public RMShape cloneDeep()
```
    Clone deep implemenation.
    
    Overrides:
    
    cloneDeep in class RMShape
  - initWithArchiver
```
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
```
    Legacy unarchival.
    
    Specified by:
    
    initWithArchiver in interface RMArchiver.Archiving
    
    Overrides:
    
    initWithArchiver in class RMShape
  - superSelectable
```
public boolean superSelectable()
```
    Editor method - indicates that nested doc is super-selctable.
    
    Overrides:
    
    superSelectable in class RMShape
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Editor method - indicates that children super-select immediately.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape
  - acceptsChildren
```
public boolean acceptsChildren()
```
    Editor method - indicates that nested doc can't accept children.
    
    Overrides:
    
    acceptsChildren in class RMShape
  - getChildrenWhoHitTest
```
public java.util.List getChildrenWhoHitTest()
```
    Editor method - indicates that children aren't selectable.
    
    Overrides:
    
    getChildrenWhoHitTest in class RMShape

Class RMNestedDoc

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class com.reportmill.base.RMObject

Methods inherited from class java.lang.Object

Constructor Detail

RMNestedDoc

RMNestedDoc

Method Detail

getDelay

setDelay

getScaleFactor

setScaleFactor

getGapDelay

setGapDelay

setSelectedPageIndex

getChildAnimator

setParent

animatorDidUpdate

animatorDidStop

getPageCount

rpgClonePreprocess

rpgClone

equals

copy

cloneDeep

initWithArchiver

superSelectable

childrenSuperSelectImmediately

acceptsChildren

getChildrenWhoHitTest