public class RMPage extends RMShape
RMDocument template = new RMDocument(aSource); RMPage page = template.getPage(0); RMTable table = page.getChildWithName("MyTable"); ...
Or you might use it briefly when adding pages to a document (which comes with one by default):
RMDocument template = new RMDocument(612, 792); template.getPage(0).addChild(new RMText(new RXString("Hello Page 1!", RMFont("Arial", 100)))); template.addPage(new RMPage()); template.getPage(1).addChild(new RMText(new RXString("Hello Page 2!", RMFont("Arial", 100))));
WRAP_TYPE_BOTH, WRAP_TYPE_NONE
Constructor and Description |
---|
RMPage()
Creates a plain empty page.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsChildren()
Editor method - indicates that page supports added children.
|
void |
addChild(RMShape child,
int index)
Add the given child at the given index (over-rides RMShape version to propogate to RMPageLayer).
|
void |
addLayerNamed(java.lang.String aString)
Creates a new layer with the given name and adds it to this page's layer list.
|
void |
bringShapesToFront(java.util.List shapes)
Overrides shape implementation to keep shapes in their proper layers.
|
java.lang.Object |
clone()
Standard clone method.
|
void |
copy(java.lang.Object anObj)
Copies the attributes from the given object.
|
boolean |
equals(java.lang.Object anObj)
Standard equals method.
|
java.lang.Object |
fromXML(RXArchiver anArchiver,
RXElement anElement)
XML unarchival.
|
RMAnimator |
getChildAnimator(boolean create)
Returns the child animator associated with this page, creating one if it doesn't exist (if requested).
|
java.util.List |
getChildrenWhoDraw()
Returns a list of children which should be drawn (since page layers can be configured to prevent chilren on
individual layers from being visible).
|
java.util.List |
getChildrenWhoHitTest()
Returns a list of children which should be checked during shape hit detection (since page layers can be configured
to prevent chilren on individual layers from being selected).
|
RMPageLayer |
getLayer(int index)
Returns the layer at the given index.
|
RMPageLayer |
getLayer(java.lang.String aString)
Returns the layer with the given name.
|
int |
getLayerCount()
Returns the number of layers associated with this page.
|
RMShape |
getPageShape()
Overrides shape implementation to return this page, since it is the page shape.
|
RMPageLayer |
getSelectedLayer()
Returns the selected layer.
|
int |
getSelectedLayerIndex()
Returns the index of the selected layer.
|
java.lang.Object |
initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.
|
void |
moveLayer(int fromIndex,
int toIndex)
Moves the layer at fromIndex to toIndex.
|
void |
moveToNewLayer(java.util.List shapes)
Creates a new layer and adds the shapes in the given list to it.
|
int |
page()
Returns the "Page" number of this page (used to resolve @Page@ key references).
|
int |
pageBreakMax()
Returns "PageBreakMax" (used to resolve PageBreakMax key references).
|
int |
pageBreakPageMax()
Returns "PageBreakPageMax" for all children on this page (used to resolve PageBreakPageMax key references).
|
int |
pageMax()
Returns the "PageMax" of the document associated with this page (used to resolve @PageMax@ key references).
|
void |
removeChild(int index)
Removes the child at the given index (over-rides RMShape version to propogate to RMPageLayer).
|
void |
removeLayer(RMPageLayer aLayer)
Removes the given layer (and dumps its children into the preceeding layer).
|
void |
resetLayers()
Resets this page's list of layers to a single, selecctable layer named "Layer 1".
|
RMShape |
rpgClone(ReportMill rm)
A custom version of the clone method, which returns a report generated clone.
|
void |
selectLayer(RMPageLayer aLayer)
Selects the given layer.
|
void |
selectLayer(java.lang.String aString)
Selects the layer with the given name.
|
void |
sendShapesToBack(java.util.List shapes)
Overrides shape implementation to keep shapes in their proper layers.
|
boolean |
superSelectable()
Editor method - indicates that pages can be super-selected.
|
RXElement |
toXML(RXArchiver anArchiver)
XML archival.
|
RMObject |
undoClone()
A custom version of the clone method, specific for undo tracking.
|
acceptsDragKeys, acceptsFormat, acceptsMouse, addChild, addChildBelowLastChild, bounds, boundsChanged, boundsChanged, canBeUngrouped, childrenSuperSelectImmediately, cloneDeep, 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, 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, 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, getPageCount, 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, put, putPropertyKey, reclaimChildren, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, 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, setParent, 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, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y
didUndo, getAnimAttribute, getClassNameShort
public int getLayerCount()
public RMPageLayer getLayer(int index)
public RMPageLayer getLayer(java.lang.String aString)
public void addLayerNamed(java.lang.String aString)
public void removeLayer(RMPageLayer aLayer)
public void moveLayer(int fromIndex, int toIndex)
public int getSelectedLayerIndex()
public RMPageLayer getSelectedLayer()
public void selectLayer(RMPageLayer aLayer)
public void selectLayer(java.lang.String aString)
public void resetLayers()
public void addChild(RMShape child, int index)
public void removeChild(int index)
removeChild
in class RMShape
public void bringShapesToFront(java.util.List shapes)
bringShapesToFront
in class RMShape
public void sendShapesToBack(java.util.List shapes)
sendShapesToBack
in class RMShape
public void moveToNewLayer(java.util.List shapes)
public java.util.List getChildrenWhoDraw()
getChildrenWhoDraw
in class RMShape
public java.util.List getChildrenWhoHitTest()
getChildrenWhoHitTest
in class RMShape
public RMShape getPageShape()
getPageShape
in class RMShape
public RMAnimator getChildAnimator(boolean create)
getChildAnimator
in class RMShape
public RMShape rpgClone(ReportMill rm)
public int page()
public int pageMax()
public int pageBreakMax()
pageBreakMax
in class RMShape
public int pageBreakPageMax()
pageBreakPageMax
in class RMShape
public RMObject undoClone()
public void copy(java.lang.Object anObj)
public boolean equals(java.lang.Object anObj)
public RXElement toXML(RXArchiver anArchiver)
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
initWithArchiver
in interface RMArchiver.Archiving
initWithArchiver
in class RMShape
public boolean acceptsChildren()
acceptsChildren
in class RMShape
public boolean superSelectable()
superSelectable
in class RMShape