com.reportmill.shape
Class RMPage

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

All Implemented Interfaces:

java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

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

com.reportmill.graphics.RMAnimator	_childAnimator
java.util.List	_layers

Fields inherited from class com.reportmill.shape.RMShape

HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth

Constructor Summary

RMPage()
Creates a plain empty page.

Method Summary

boolean	acceptsChildren() This RMEditor support method tells the editor 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) Brings the shapes in the given list to the front of the children list.
java.lang.Object	clone() Standard clone method.
void	copy(com.reportmill.foundation.RMObject anObj) Copies the attributes from the given object.
java.util.List	drawChildren() Returns a list of children which should be drawn (since page layers can be configured to prevent chilren on individual layers from being visible).
boolean	equals(java.lang.Object anObj) Standard equals method.
java.lang.Object	fromXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement) XML unarchival.
com.reportmill.graphics.RMAnimator	getChildAnimator(boolean create) Over-rides the RMShape implementation to return the child animator that is associated with this page, creating one if it doesn't exist (if requested).
RMDocument	getDocument() Returns the document that this page is associated with.
com.reportmill.shape.RMPageLayer	getLayer(int index) Returns the layer at the given index.
int	getLayerCount() Returns the number of layers associated with this page.
com.reportmill.shape.RMPageLayer	getLayerNamed(java.lang.String aString) Returns the layer with the given name.
RMShape	getPageShape() This method over-rides the RMShape implementation to return the receiver, indicating that it it is a page shape.
com.reportmill.shape.RMPageLayer	getSelectedLayer() Returns the selected layer.
int	getSelectedLayerIndex() Returns the index of the selected layer.
int	handleAtPoint(RMPoint point, boolean isSuperSelected) This RMEditor support method tells the editor that page's resize handles don't exist.
java.util.List	hitChildren() 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).
java.lang.Object	initWithArchiver(com.reportmill.foundation.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 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(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.foundation.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	selectLayerNamed(java.lang.String aString) Selects the layer with the given name.
void	sendShapesToBack(java.util.List shapes) Sends the shapes in the given list to the back of the children list.
void	setChildAnimator(com.reportmill.graphics.RMAnimator anAnimator) Over-rides the RMShape implementation to set the child animator associated with this page.
boolean	superSelectable() This RMEditor support method tells the editor that pages can be super-selected.
com.ribs.RXElement	toXML(com.ribs.RXArchiver anArchiver) XML archival.
com.reportmill.foundation.RMObject	undoClone() A custom version of the clone method, specific for undo tracking.

Methods inherited from class com.reportmill.shape.RMShape

acceptsDragKeys, acceptsEvents, acceptsFirstEvent, acceptsFormat, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, canBeUngrouped, childHitByPoint, childrenHitByPath, childrenSuperSelectImmediately, cloneDeep, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, drawsFill, drawsStroke, dropKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsOfPath, getBoundsOrigin, getBoundsSize, getBoundsSuperSelected, getChild, getChildAnimator, getChildCount, getChildLast, getChildren, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getParent, getParentCount, getParents, getPath, getPathInBounds, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getY, groupShapes, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, put, reclaimChildren, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setBoundsOrigin, setBoundsOrigin, setBoundsOriginX, setBoundsOriginY, setBoundsSize, setBoundsSize, setChildren, setColor, setColor, setDrawsFill, setDrawsStroke, setEverythingStretches, setFill, setFill, setFont, setFormat, setHeight, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOnlyBottomAndRightMarginStretches, setOnlyTopAndRightMarginStretches, setOnlyWidthAndHeightStretches, setOpacity, setOrigin, setOrigin, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeDeep, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewXY, setSkewY, setStroke, setStroke, setStrokeColor, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectImmediately, toString, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.foundation.RMObject

archiverClassName, didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

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

Field Detail

_layers

public java.util.List _layers

_childAnimator

public com.reportmill.graphics.RMAnimator _childAnimator

Constructor Detail

RMPage

public RMPage()

Creates a plain empty page.

Method Detail

getDocument

public RMDocument getDocument()

Returns the document that this page is associated with.

Overrides:

getDocument in class RMShape

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.

getLayerNamed

public com.reportmill.shape.RMPageLayer getLayerNamed(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.

selectLayerNamed

public void selectLayerNamed(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 index)

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)

Brings the shapes in the given list to the front of the children list. This over-rides the RMShape implementation to keep shapes in their proper layers.

Overrides:

bringShapesToFront in class RMShape

sendShapesToBack

public void sendShapesToBack(java.util.List shapes)

Sends the shapes in the given list to the back of the children list. This over-rides the RMShape 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.

drawChildren

public java.util.List drawChildren()

Returns a list of children which should be drawn (since page layers can be configured to prevent chilren on individual layers from being visible).

Overrides:

drawChildren in class RMShape

hitChildren

public java.util.List hitChildren()

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

Overrides:

hitChildren in class RMShape

getPageShape

public RMShape getPageShape()

This method over-rides the RMShape implementation to return the receiver, indicating that it it is a page shape.

Overrides:

getPageShape in class RMShape

getChildAnimator

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

Over-rides the RMShape implementation to return the child animator that is associated with this page, creating one if it doesn't exist (if requested).

Overrides:

getChildAnimator in class RMShape

setChildAnimator

public void setChildAnimator(com.reportmill.graphics.RMAnimator anAnimator)

Over-rides the RMShape implementation to set the child animator associated with this page.

Overrides:

setChildAnimator in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.foundation.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 the document associated with this page (used to resolve @PageMax@ key references).

Overrides:

pageMax in class RMShape

pageBreakMax

public int pageBreakMax()

Returns "PageBreakMax" (used to resolve PageBreakMax key references).

Overrides:

pageBreakMax in class RMShape

pageBreakPageMax

public int pageBreakPageMax()

Returns "PageBreakPageMax" for all children on this page (used to resolve PageBreakPageMax key references).

Overrides:

pageBreakPageMax in class RMShape

clone

public java.lang.Object clone()

Standard clone method.

Overrides:

clone in class RMShape

undoClone

public com.reportmill.foundation.RMObject undoClone()

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

Overrides:

undoClone in class RMShape

copy

public void copy(com.reportmill.foundation.RMObject anObj)

Copies the attributes from the given object.

Overrides:

copy in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals method.

Overrides:

equals in class RMShape

initWithArchiver

public java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)

Legacy unarchival.

Specified by:

initWithArchiver in interface com.reportmill.foundation.RMArchiver.Archiving

Overrides:

initWithArchiver in class RMShape

toXML

public com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape

acceptsChildren

public boolean acceptsChildren()

This RMEditor support method tells the editor that page supports added children.

Overrides:

acceptsChildren in class RMShape

superSelectable

public boolean superSelectable()

This RMEditor support method tells the editor that pages can be super-selected.

Overrides:

superSelectable in class RMShape

handleAtPoint

public int handleAtPoint(RMPoint point,
                         boolean isSuperSelected)

This RMEditor support method tells the editor that page's resize handles don't exist.

Overrides:

handleAtPoint in class RMShape