com.reportmill.shape
Class RMPage

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMPage

All Implemented Interfaces:

java.lang.Cloneable

public class RMPage
extends RMShape

The RMPage class represents an individual page in an RMDocument. For the most part, it's like every other RMShape, except that it has the ability to break children into "layers" for more convenient editing. Layers are sub-ranges of children that can be set to be invisible or locked. An RMPage also has its own child animator. It's not common for developers to use much or RMPage's unique functionality programmatically, however, you might use it briefly when disecting a template like this:

   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))));
 

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

RMPage()
Creates a plain empty page.

Method Summary

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(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
com.reportmill.graphics.RMAnimator	getChildAnimator(boolean create) Returns the child animator associated with this page, creating one if it doesn't exist (if requested).
int	getChildCountHitable() Returns a count of all children in hitable layers.
int	getChildCountVisible() Returns a count of all children in visible layers.
RMShape	getChildHitable(int anIndex) Returns the hitable child at the given index.
RMShape	getChildVisible(int anIndex) Returns the visible child at the given index.
com.reportmill.shape.RMPageLayer	getLayer(int index) Returns the layer at the given index.
com.reportmill.shape.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.
com.reportmill.shape.RMPageLayer	getSelectedLayer() Returns the selected layer.
int	getSelectedLayerIndex() Returns the index of the selected layer.
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	pageMax() Returns the "PageMax" of the document associated with this page (used to resolve @PageMax@ key references).
void	removeChild(int anIndex) Removes the child at the given index (over-rides RMShape version to propogate to RMPageLayer).
void	removeLayer(com.reportmill.shape.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(com.reportmill.base.ReportMill rm) A custom version of the clone method, which returns a report generated clone.
void	selectLayer(com.reportmill.shape.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.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML archival.
com.reportmill.base.RMObject	undoClone() A custom version of the clone method, specific for undo tracking.

Methods inherited from class com.reportmill.shape.RMShape

acceptsMouse, addChild, 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, createLayout, delete, didChange, divideShapeFromEdge, divideShapeFromTop, doLayout, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildContaining, getChildCount, getChildCountLayout, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDatasetKey, getDatasetKeyDeep, getDatasetKeyShape, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getListKey, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, 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, height, indexOf, indexOf, intersects, invalidate, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, isValid, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, put, putPropertyKey, reclaimChildren, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, revalidate, rpgCloneBase, rpgCloneChildren, rpgCloneNotification, rpgClonePreprocess, rpgCloneUrl, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, 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, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, toString, toXMLDeep, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.base.RMObject

didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMPage

public RMPage()

Creates a plain empty page.

Method Detail

getLayerCount

public int getLayerCount()

Returns the number of layers associated with this page.

getLayer

public com.reportmill.shape.RMPageLayer getLayer(int index)

Returns the layer at the given index.

getLayer

public com.reportmill.shape.RMPageLayer getLayer(java.lang.String aString)

Returns the layer with the given name.

addLayerNamed

public void addLayerNamed(java.lang.String aString)

Creates a new layer with the given name and adds it to this page's layer list.

removeLayer

public void removeLayer(com.reportmill.shape.RMPageLayer aLayer)

Removes the given layer (and dumps its children into the preceeding layer).

moveLayer

public void moveLayer(int fromIndex,
                      int toIndex)

Moves the layer at fromIndex to toIndex.

getSelectedLayerIndex

public int getSelectedLayerIndex()

Returns the index of the selected layer.

getSelectedLayer

public com.reportmill.shape.RMPageLayer getSelectedLayer()

Returns the selected layer.

selectLayer

public void selectLayer(com.reportmill.shape.RMPageLayer aLayer)

Selects the given layer.

selectLayer

public void selectLayer(java.lang.String aString)

Selects the layer with the given name.

resetLayers

public void resetLayers()

Resets this page's list of layers to a single, selecctable layer named "Layer 1".

addChild

public void addChild(RMShape child,
                     int index)

Add the given child at the given index (over-rides RMShape version to propogate to RMPageLayer).

Overrides:

addChild in class RMShape

removeChild

public void removeChild(int anIndex)

Removes the child at the given index (over-rides RMShape version to propogate to RMPageLayer).

Overrides:

removeChild in class RMShape

bringShapesToFront

public void bringShapesToFront(java.util.List shapes)

Overrides shape implementation to keep shapes in their proper layers.

Overrides:

bringShapesToFront in class RMShape

sendShapesToBack

public void sendShapesToBack(java.util.List shapes)

Overrides shape implementation to keep shapes in their proper layers.

Overrides:

sendShapesToBack in class RMShape

moveToNewLayer

public void moveToNewLayer(java.util.List shapes)

Creates a new layer and adds the shapes in the given list to it.

getChildCountVisible

public int getChildCountVisible()

Returns a count of all children in visible layers.

Overrides:

getChildCountVisible in class RMShape

getChildVisible

public RMShape getChildVisible(int anIndex)

Returns the visible child at the given index.

Overrides:

getChildVisible in class RMShape

getChildCountHitable

public int getChildCountHitable()

Returns a count of all children in hitable layers.

Overrides:

getChildCountHitable in class RMShape

getChildHitable

public RMShape getChildHitable(int anIndex)

Returns the hitable child at the given index.

Overrides:

getChildHitable in class RMShape

getPageShape

public RMShape getPageShape()

Overrides shape implementation to return this page, since it is the page shape.

Overrides:

getPageShape in class RMShape

getChildAnimator

public com.reportmill.graphics.RMAnimator getChildAnimator(boolean create)

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

Overrides:

getChildAnimator in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill rm)

A custom version of the clone method, which returns a report generated clone.

Overrides:

rpgClone in class RMShape

page

public int page()

Returns the "Page" number of this page (used to resolve @Page@ key references).

Overrides:

page in class RMShape

pageMax

public int pageMax()

Returns the "PageMax" of the document associated with this page (used to resolve @PageMax@ key references).

Overrides:

pageMax in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals method.

Overrides:

equals in class RMShape

clone

public java.lang.Object clone()

Standard clone method.

Overrides:

clone in class RMShape

undoClone

public com.reportmill.base.RMObject undoClone()

A custom version of the clone method, specific for undo tracking.

Overrides:

undoClone in class RMShape

copy

public void copy(java.lang.Object anObj)

Copies the attributes from the given object.

Overrides:

copy in class RMShape

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)

XML unarchival.

Overrides:

fromXML in class RMShape

acceptsChildren

public boolean acceptsChildren()

Editor method - indicates that page supports added children.

Overrides:

acceptsChildren in class RMShape

superSelectable

public boolean superSelectable()

Editor method - indicates that pages can be super-selected.

Overrides:

superSelectable in class RMShape