com.reportmill.shape

Class RMParentShape

java.lang.Object

SnapObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMParentShape

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

ReportOwner.ShapeList, RMAnimPathShape.RMAnimPathGroup, RMCrossTab, RMCrossTabFrame, RMDocument, RMFlowShape, RMGraph, RMGraphRPGBar.BarGraphShape2D, RMLabel, RMLabels, RMLineShape, RMNestedDoc, RMPage, RMPolygonShape, RMScene3D, RMSpringShape, RMSwitchShape, RMTable, RMTableGroup, RMTableRowRPG, RMTableRPG

public class RMParentShape
extends RMShape

A shape implementation that can have children.

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Constructor Summary

Constructors

Constructor and Description
RMParentShape()

Method Summary

Modifier and Type	Method and Description
void	addChild(RMShape aChild) Adds the given child to the end of this shape's children list.
void	addChild(RMShape aChild, int anIndex) Adds the given child to this shape's children list at the given index.
void	addChild(RMShape aChild, int anIndex, java.lang.Object theLayoutInfo) Adds the given child to this shape's children list at the given index.
void	addChild(RMShape aChild, java.lang.Object theConstr) Adds the given child with the given constraints.
void	bringShapesToFront(java.util.List<RMShape> shapes) Moves the subset of children in the given list to the front of the children list.
RMParentShape	clone() Standard implementation of Object clone.
RMParentShape	cloneDeep() Clones all attributes of this shape with complete clones of its children as well.
RMShape	divideShapeFromTop(double anAmount) Divides the shape by a given amount from the top.
RMShape	fromXML(XMLArchiver anArchiver, XMLElement anElement) XML unarchival generic - break fromXML into fromXMLShape and fromXMLShapeChildren.
RMRect	getBoundsOfChildren() Returns bounds of all children of this shape, which can sometimes differ from this shapes bounds.
RMShape	getChild(int anIndex) Returns the child at the given index.
RMShape[]	getChildArray() Returns a copy of the children as an array.
RMShape	getChildContaining(RMPoint aPoint) Returns the first (top) shape hit by the point given in this shape's coords.
int	getChildCount() Returns the number of children associated with this shape.
RMShape	getChildLast() Returns the last child of this shape.
java.util.List<RMShape>	getChildren() Returns the list of children associated with this shape.
java.util.List<RMShape>	getChildrenIntersecting(RMPath aPath) Returns the child shapes hit by the path given in this shape's coords.
<T extends RMShape> java.util.List<T>	getChildrenWithClass(java.lang.Class<T> aClass) Returns all the shapes in the shape hierarchy of a particular class.
<T extends RMShape> java.util.List<T>	getChildrenWithClass(java.util.List aList, java.lang.Class<T> aClass) Adds all the shapes in the shape hierarchy of a particular class to the list.
<T> T	getChildWithClass(java.lang.Class<T> aClass) Returns first child found with the given class (called recursively on children if not found at current level).
RMShape	getChildWithName(java.lang.String aName) Returns first child found with the given name (called recursively on children if not found at current level).
RMShapeLayout	getLayout() Returns the layout for this shape.
boolean	getNeedsLayout() Returns whether children need to be laid out.
WebURL	getSourceURL() Returns the Source URL.
int	indexOfChild(RMShape aChild) Returns the index of the given child in this shape's children list.
boolean	isSourceURLSet() Returns whether Source URL is set.
void	layout() Does immediate layout of this shape and children (if invalid).
void	relayout() Sets shape layout to invalid and requests deferred layout.
RMShape	removeChild(int anIndex) Remove's the child at the given index from this shape's children list.
int	removeChild(RMShape aChild) Removes the given child from this shape's children list.
void	removeChildren() Removes all children from this shape (in reverse order).
RMShape	rpgAll(ReportOwner anRptOwner, RMShape aParent) Generate report with report owner.
void	sendShapesToBack(java.util.List<RMShape> shapes) Moves the subset of children in the given list to the back of the children list.
void	setHeight(double aValue) Override to trigger layout.
void	setLayout(RMShapeLayout aLayout) Sets the layout for this shape.
void	setNeedsLayout(boolean aValue) Sets whether children need to be laid out.
void	setSourceURL(WebURL aURL) Sets the Source URL.
void	setWidth(double aValue) Override to trigger layout.
XMLElement	toXML(XMLArchiver anArchiver) XML Archival generic - break toXML into toXMLShape and toXMLShapeChildren.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getClipShape, getColor, getDatasetEntity, getDatasetKey, 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, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isUnderlined, 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, rpgBindings, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class java.lang.Object

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

Constructor Detail

RMParentShape

public RMParentShape()

Method Detail

getChildCount

public int getChildCount()

Returns the number of children associated with this shape.

Overrides:

getChildCount in class RMShape

getChild

public RMShape getChild(int anIndex)

Returns the child at the given index.

Overrides:

getChild in class RMShape

getChildren

public java.util.List<RMShape> getChildren()

Returns the list of children associated with this shape.

Overrides:

getChildren in class RMShape

addChild

public final void addChild(RMShape aChild)

Adds the given child to the end of this shape's children list.

addChild

public void addChild(RMShape aChild,
                     int anIndex)

Adds the given child to this shape's children list at the given index.

addChild

public final void addChild(RMShape aChild,
                           java.lang.Object theConstr)

Adds the given child with the given constraints.

addChild

public final void addChild(RMShape aChild,
                           int anIndex,
                           java.lang.Object theLayoutInfo)

Adds the given child to this shape's children list at the given index.

removeChild

public RMShape removeChild(int anIndex)

Remove's the child at the given index from this shape's children list.

removeChild

public int removeChild(RMShape aChild)

Removes the given child from this shape's children list.

indexOfChild

public int indexOfChild(RMShape aChild)

Returns the index of the given child in this shape's children list.

getChildLast

public RMShape getChildLast()

Returns the last child of this shape.

getChildArray

public RMShape[] getChildArray()

Returns a copy of the children as an array.

removeChildren

public void removeChildren()

Removes all children from this shape (in reverse order).

getBoundsOfChildren

public RMRect getBoundsOfChildren()

Returns bounds of all children of this shape, which can sometimes differ from this shapes bounds.

getChildWithName

public RMShape getChildWithName(java.lang.String aName)

Returns first child found with the given name (called recursively on children if not found at current level).

getChildWithClass

public <T> T getChildWithClass(java.lang.Class<T> aClass)

Returns first child found with the given class (called recursively on children if not found at current level).

getChildrenWithClass

public <T extends RMShape> java.util.List<T> getChildrenWithClass(java.lang.Class<T> aClass)

Returns all the shapes in the shape hierarchy of a particular class.

getChildrenWithClass

public <T extends RMShape> java.util.List<T> getChildrenWithClass(java.util.List aList,
                                                                  java.lang.Class<T> aClass)

Adds all the shapes in the shape hierarchy of a particular class to the list. Returns the list as a convenience.

getLayout

public RMShapeLayout getLayout()

Returns the layout for this shape.

setLayout

public void setLayout(RMShapeLayout aLayout)

Sets the layout for this shape.

isSourceURLSet

public boolean isSourceURLSet()

Returns whether Source URL is set.

getSourceURL

public WebURL getSourceURL()

Returns the Source URL.

setSourceURL

public void setSourceURL(WebURL aURL)

Sets the Source URL.

getNeedsLayout

public boolean getNeedsLayout()

Returns whether children need to be laid out.

setNeedsLayout

public void setNeedsLayout(boolean aValue)

Sets whether children need to be laid out.

relayout

public void relayout()

Sets shape layout to invalid and requests deferred layout.

layout

public void layout()

Does immediate layout of this shape and children (if invalid).

setWidth

public void setWidth(double aValue)

Override to trigger layout.

Overrides:

setWidth in class RMShape

setHeight

public void setHeight(double aValue)

Override to trigger layout.

Overrides:

setHeight in class RMShape

getChildContaining

public RMShape getChildContaining(RMPoint aPoint)

Returns the first (top) shape hit by the point given in this shape's coords.

getChildrenIntersecting

public java.util.List<RMShape> getChildrenIntersecting(RMPath aPath)

Returns the child shapes hit by the path given in this shape's coords.

divideShapeFromTop

public RMShape divideShapeFromTop(double anAmount)

Divides the shape by a given amount from the top. Returns a clone of the given shape with bounds set to the remainder. Divides children among the two shapes (recursively calling divide shape for those straddling).

Overrides:

divideShapeFromTop in class RMShape

bringShapesToFront

public void bringShapesToFront(java.util.List<RMShape> shapes)

Moves the subset of children in the given list to the front of the children list.

sendShapesToBack

public void sendShapesToBack(java.util.List<RMShape> shapes)

Moves the subset of children in the given list to the back of the children list.

rpgAll

public RMShape rpgAll(ReportOwner anRptOwner,
                      RMShape aParent)

Generate report with report owner.

Overrides:

rpgAll in class RMShape

clone

public RMParentShape clone()

Standard implementation of Object clone. Null's out shape's parent and children.

Overrides:

clone in class RMShape

cloneDeep

public RMParentShape cloneDeep()

Clones all attributes of this shape with complete clones of its children as well.

Overrides:

cloneDeep in class RMShape

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML Archival generic - break toXML into toXMLShape and toXMLShapeChildren.

Overrides:

toXML in class RMShape

fromXML

public RMShape fromXML(XMLArchiver anArchiver,
                       XMLElement anElement)

XML unarchival generic - break fromXML into fromXMLShape and fromXMLShapeChildren.

Overrides:

fromXML in class RMShape