RMShape (ReportMill 7.0 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

ReportMill 7.0 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.reportmill.shape
Class RMShape

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

All Implemented Interfaces:: java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

Direct Known Subclasses:: RMDocument, RMGraph, RMGraph.Content, RMLabel, RMLabels, RMLineSegment, RMOval, RMPage, RMPolygon, RMRectangle, RMSound, com.reportmill.shape.RMSplitShape, RMSwitchShape, RMTableGroup

public class RMShape
extends com.reportmill.foundation.RMObject

This class is the basis for all graphic elements in a ReportMill document. You'll rarely use this class directly, however, it encapsulates all the basic shape attributes and the most common methods used in template manipulation, like setX(), setY(), setWidth(), setColor(), etc. Here's an example of programatically adding a watermark to a document:

   RMFont font = RMFont.getFont("Arial Bold", 72);
   RMColor color = new RMColor(.9f, .9f, .9f);
   RMXString string = new RMXString("REPORTMILL", font, color);
   RMText shape = new RMText(string);
   myDocument.getPage(0).addChild(shape);
   shape.setBounds(36, 320, 540, 140);
   shape.setRoll(45);
   shape.setOpacity(.667f);

Field Summary
`static byte`	`HandleMaxXMaxY`
`static byte`	`HandleMaxXMidY`
`static byte`	`HandleMaxXMinY`
`static byte`	`HandleMidXMaxY`
`static byte`	`HandleMidXMinY`
`static byte`	`HandleMinXMaxY`
`static byte`	`HandleMinXMidY`
`static byte`	`HandleMinXMinY`
`static byte`	`HandleWidth` Handles

Constructor Summary
`RMShape()` Creates a plain shape.
`RMShape(RMShape aShape)` Creates a shape with the same basic attributes as the given shape.

Method Summary
`boolean`	`acceptsChildren()` Editor method.
`boolean`	`acceptsDragKeys()` Editor method.
`boolean`	`acceptsEvents()` Editor method.
`boolean`	`acceptsFirstEvent()` Editor method.
`boolean`	`acceptsFormat()` Returns whether the shape can accept a format.
`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`	`addChildBelowLastChild(RMShape aChild)` Adds the given child to the end of this shape's children list at a y position just below the previously last child.
`void`	`boundsChanged()` Notifies a shape and its parents that its bounds changed.
`void`	`boundsChanged(RMShape aShape)` Notifies this shape that a given shape's bounds have changed (presumably a descendant).
`void`	`bringShapesToFront(java.util.List shapes)` Moves the subset of children in the given list to the front of the children list.
`boolean`	`canBeUngrouped()` Editor method.
`RMShape`	`childHitByPoint(RMPoint point)` Returns the first (top) shape hit by the point given in this shape's coords.
`java.util.List`	`childrenHitByPath(RMPath aPath)` Returns the child shapes hit by the path given in this shape's coords.
`boolean`	`childrenSuperSelectImmediately()` Editor method.
`java.lang.Object`	`clone()` Standard implementation of Object clone.
`RMShape`	`cloneDeep()` Clones all attributes of this shape with complete clones of its children as well.
`RMPoint`	`convertedPointFromShape(RMPoint point, RMShape shape)`
`RMPoint`	`convertedPointToShape(RMPoint point, RMShape shape)`
`RMRect`	`convertedRectFromShape(RMRect rect, RMShape shape)`
`RMRect`	`convertedRectToShape(RMRect rect, RMShape shape)`
`RMSize`	`convertedSizeFromShape(RMSize size, RMShape shape)`
`RMSize`	`convertedSizeToShape(RMSize size, RMShape shape)`
`RMSize`	`convertedVectorFromShape(RMSize size, RMShape shape)`
`RMSize`	`convertedVectorToShape(RMSize size, RMShape shape)`
`void`	`convertFromShape(RMShape aShape)`
`RMPath`	`convertPathFromShape(RMPath aPath, RMShape shape)`
`RMPath`	`convertPathToShape(RMPath aPath, RMShape shape)`
`RMPoint`	`convertPointFromShape(RMPoint point, RMShape shape)` Converts the given point to the given shape's coords (returns it for convenience).
`RMPoint`	`convertPointToShape(RMPoint point, RMShape shape)` Converts the given point to the given shape's coords (returns it for convenience).
`RMRect`	`convertRectFromShape(RMRect rect, RMShape shape)` Converts the given rect from the given shape's coords (returns it for convenience).
`RMRect`	`convertRectToShape(RMRect rect, RMShape shape)` Converts the given rect to the given shape's coords (returns it for convenience).
`RMSize`	`convertSizeFromShape(RMSize size, RMShape shape)` Converts the given size from the given shape's coords (returns it for convenience).
`RMSize`	`convertSizeToShape(RMSize size, RMShape shape)` Converts the given size to the given shape's coords (returns it for convenience).
`void`	`convertToShape(RMShape aShape)`
`RMSize`	`convertVectorFromShape(RMSize size, RMShape shape)` Converts the given size (as a vector) from the given shape's coords (returns it for convenience).
`RMSize`	`convertVectorToShape(RMSize size, RMShape shape)` Converts the given size (as a vector) to the given shape's coords (returns it for convenience).
`void`	`copy(com.reportmill.foundation.RMObject anObj)` Copies applicable attributes from the given object.
`void`	`copyShape(RMShape aShape)` Copies basic shape attributes from given RMShape (location, size, fill, stroke, roll, scale, name, url, etc.).
`void`	`didChange(com.reportmill.foundation.RMObject oldObj)` Undo support.
`RMShape`	`divideShapeFromEdge(float amount, byte edge, RMShape newShape)` This method divides the shape by a given amount from the given edge.
`RMShape`	`divideShapeFromTop(float amount)` This method divides the shape by a given amount from the top.
`void`	`dragExit()` Editor method.
`void`	`dragKeyAtPoint(java.lang.String aKey, RMPoint aPoint)` Editor method.
`java.util.List`	`drawChildren()` Returns the subset of children that should be drawn.
`boolean`	`drawsFill()` Returns whether this shape should be filled.
`boolean`	`drawsStroke()` Returns whether this shape should be stroked.
`void`	`dropKeyAtPoint(java.lang.String aKey, RMPoint aPoint)` Editor method.
`boolean`	`equals(java.lang.Object anObj)` Standard implementation of Object equals.
`java.lang.Object`	`fromXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement)` XML unarchival.
`void`	`fromXMLDeep(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement)` XML unarchival for shape children
`java.lang.Object`	`get(java.lang.String aName)` Returns the Object associated with the given name for the shape.
`java.lang.String`	`getActionScript()` Sets the ActionScript for the shape.
`com.reportmill.shape.RMShapeAnim`	`getAnim()` Returns the collection of animation records for this shape.
`com.reportmill.shape.RMShapeAnim`	`getAnim(boolean create)` Returns the collection of animation records for this shape, with an option to create if absent.
`com.reportmill.graphics.RMAnimator`	`getAnimator()` Returns the animator that this shape registers changes with.
`com.reportmill.graphics.RMAnimator`	`getAnimator(boolean create)` Returns the animator that this shape registers changes with (creating, if requested and currently null).
`boolean`	`getAutosizeHeight()`
`java.lang.String`	`getAutosizing()`
`RMRect`	`getBounds()`
`RMRect`	`getBounds(RMShape aShape)`
`RMRect`	`getBoundsInside()`
`RMRect`	`getBoundsMarked()` This method returns the bounds of the path associated with this shape in parent coords, ajusted to account for the stroke width, if applicable.
`RMRect`	`getBoundsOfChildren()` This method returns the bounds of all the children of this shape, which can sometimes differ from this shapes bounds.
`RMRect`	`getBoundsOfChildren(java.util.List aList)` This method returns the bounds of a given subset of this shape's children.
`RMRect`	`getBoundsOfPath()` This method returns the bounds of the path associated with this shape in parent coords.
`RMPoint`	`getBoundsOrigin()`
`RMSize`	`getBoundsSize()`
`RMRect`	`getBoundsSuperSelected()` This method returns the bounds of the shape in parect coords when super selected.
`RMShape`	`getChild(int anIndex)` Returns the child at the given index.
`com.reportmill.graphics.RMAnimator`	`getChildAnimator()` Returns the animator that this shape's children use.
`com.reportmill.graphics.RMAnimator`	`getChildAnimator(boolean create)` Returns the animator that this shape's children use (creating, if requested and currently null).
`int`	`getChildCount()` Returns the number of children associated with this shape.
`RMShape`	`getChildLast()` Returns the last child of this shape.
`java.util.Vector`	`getChildren()` Returns the list of children associated with this shape.
`RMShape`	`getChildWithClass(java.lang.Class aClass)` Returns the first child found with the given class (called recursively on children if not found at current level).
`RMShape`	`getChildWithName(java.lang.String aName)` Returns the first child found with the given name (called recursively on children if not found at current level).
`RMColor`	`getColor()` Returns the color of the shape.
`RMShape`	`getCommonAncestor(RMShape aShape)` Returns the first ancestor that the given shape and this shape have in common.
`RMDocument`	`getDocument()` Returns the RMDocument ancestor of this shape (or null if not there).
`RMFill`	`getFill()` Returns the fill for this shape.
`RMFont`	`getFont()` Returns the font for the shape.
`RMFormat`	`getFormat()` Returns the format for the shape.
`RMShape`	`getGroupShape(java.util.List shapes)` Returns a newly created RMShape whose bounds has been set to the combined bounds of the subset of children in the given list.
`float`	`getHeight()` Returns the height of the shape.
`float`	`getHeightToFit()` This method returns the ideal height of this shape to accommodate its contents (just the current height for most shapes).
`com.reportmill.graphics.RMImageData`	`getImageData()` Returns the imageData for this shape (or null if fill isn't an RMImageFill).
`RMImageFill`	`getImageFill()` Returns the imageFill for this shape (or null, if fill isn't an RMImageFill).
`float`	`getLineWidth()` Returns the line width of the shape's stroke in printer points.
`java.lang.String`	`getListKey()` Returns the "List Key" associated with this shape.
`java.lang.String`	`getListKeyDeep()` Returns the combined list keys of this shape and its parents.
`RMShape`	`getListKeyShape()` Returns the real shape used to resolve the list key for this shape.
`java.lang.String`	`getName()` Returns the name for the shape.
`float`	`getOpacity()` Returns the opactiy of the shape (1 for opaque, 0 for transparent).
`float`	`getOpacityDeep()` Returns the combined opacity of this shape and its parent.
`RMPoint`	`getOrigin()`
`RMXString.Outline`	`getOutline()` Returns the outline for the shape.
`int`	`getPageCount()` Returns the number of pages associated with this shape.
`RMShape`	`getPageShape()` Returns the RMPage ancestor of this shape (or null if not there).
`RMShape`	`getParent()` Returns the parent of this shape.
`int`	`getParentCount()` Returns the number of ancestors (from this shape's parent up to the document).
`java.util.List`	`getParents()` Returns a list of this shape's parent, and that shape's parent, up to document.
`RMPath`	`getPath()`
`RMPath`	`getPathInBounds()`
`float`	`getRoll()` Returns the roll of the shape.
`RMShape`	`getRootShape()` Returns the top level shape (usually an RMDocument).
`float`	`getScaleX()` Returns the scale of the X axis of the shape.
`float`	`getScaleY()` Returns the scale of the Y axis of the shape.
`java.util.List`	`getShapesToAncestor(RMShape shape)` Returns a list of shapes from this shape to a given ancestor.
`java.util.List`	`getShapesToDescendant(RMShape aShape)` Returns a list of shape's from this shape to given desendant.
`java.util.List`	`getShapesToShape(RMShape aShape)` Returns a list of shapes from this shape to given shape.
`RMSize`	`getSize()`
`float`	`getSkewX()` Returns the skew of the X axis of the shape.
`float`	`getSkewY()` Returns the skew of the Y axis of the shape.
`com.reportmill.graphics.RMStroke`	`getStroke()` Returns the stroke for this shape.
`RMColor`	`getStrokeColor()` Returns the stroke color of the shape.
`RMColor`	`getTextColor()` Returns the text color for the shape.
`com.reportmill.graphics.RMTransform`	`getTransform()` Returns the transform to this shape from its parent.
`com.reportmill.graphics.RMTransform`	`getTransformFromShape(RMShape aShape)` Returns the transform from the given shape to this shape.
`com.reportmill.graphics.RMTransform`	`getTransformInverse()` Returns the transform from this shape to it's parent.
`com.reportmill.graphics.RMTransform`	`getTransformToShape(RMShape aShape)` Returns the transform from this shape to the given shape.
`com.reportmill.foundation.RMUndoer`	`getUndoer()` Returns the undoer for this shape (or null if not there).
`java.lang.String`	`getUrl()` Sets the URL for the shape.
`float`	`getWidth()` Returns the width of the shape.
`float`	`getWidthToFit()` This method returns the ideal width of this shape to accommodate its contents (just the current width for most shapes).
`float`	`getX()` Returns the X location of the shape.
`float`	`getY()` Returns the Y location of the shape.
`RMShape`	`groupShapes(java.util.List shapes, RMShape groupShape)` Adds the subset of children in the given list into a given group shape, which is then added back to the receiver.
`int`	`handleAtPoint(RMPoint point, boolean isSuperSelected)`
`int`	`handleCount()`
`RMPoint`	`handlePoint(int handle, boolean isSuperSelected)`
`RMRect`	`handleRect(int handle, boolean isSuperSelected)`
`boolean`	`hasPageBreaks()` Page number resolution.
`float`	`height()` Returns the raw height of the shape.
`boolean`	`hitByPath(RMPath aPath)` Returns whether this shape is hit by the path, given in this shape's parent's coords.
`boolean`	`hitByPoint(RMPoint aPoint)` Returns whether this shape is hit by the point, given in this shape's parent's coords.
`java.util.List`	`hitChildren()` Returns the subset of children that should be used for hit detection.
`int`	`indexOf()` Returns the index of this child in its parent.
`int`	`indexOf(RMShape aChild)` Returns the index of the given child in this shape's children list.
`java.lang.Object`	`initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)` Legacy unarchival.
`boolean`	`isAncestor(RMShape aShape)` Returns true if given shape is one of this shape's ancestors.
`boolean`	`isDescendant(RMShape aShape)` Returns true if given shape is one of this shape's descendants.
`boolean`	`isLocked()` Returns the locked state of the shape (really just to prevent location/size changes in the editor).
`boolean`	`isRoot()` Editor method - returns whether this shape is at the top level (usually RMPage).
`boolean`	`isUnderlined()` Returns whether the shape is underlined.
`float`	`maxX()`
`float`	`maxXInside()`
`float`	`maxY()`
`float`	`maxYInside()`
`float`	`midX()`
`float`	`midXInside()`
`float`	`midY()`
`float`	`midYInside()`
`float`	`minX()`
`float`	`minXInside()`
`float`	`minY()`
`float`	`minYInside()`
`void`	`moveHandleToPoint(int handle, RMPoint toPoint)`
`boolean`	`notRSS()` Returns whether the shape has been rotated, scaled or skewed (for efficientency).
`void`	`offsetChildrenXY(float dx, float dy)` Offsets this shape's children by the given dx, dy.
`void`	`offsetXY(float dx, float dy)` Offsets the X and Y location of the shape by the given dx & dy amount (convenience).
`int`	`opposingHandle(int handle)`
`int`	`page()` Page number resolution.
`int`	`pageBreakMax()` Page number resolution.
`int`	`pageBreakPageMax()` Page number resolution.
`int`	`pageMax()` Page number resolution.
`void`	`put(java.lang.String aName, java.lang.Object anObj)` Sets an Object to be associated with the given name for the shape.
`void`	`reclaimChildren()` Ensures that children associated with this shape know who's their daddy.
`void`	`removeChild(int anIndex)` Remove's the child at the given index from this shape's children list.
`void`	`removeChild(RMShape aChild)` Removes the given child from this shape's children list.
`void`	`removeChildren()` Removes all children from this shape.
`void`	`removeChildren(java.util.List l)` Removes the given list of children from this shape.
`void`	`removeFromParent()` Removes this shape from it's parent.
`void`	`resolvePageReferences(com.reportmill.foundation.ReportMill rm, java.lang.Object userInfo)` Replaces all @Page@ style keys with their actual values for this shape and it's children.
`RMShape`	`rpgClone(com.reportmill.foundation.ReportMill rm)` A clone implementation that copies this shape and its children, performing data substituion as well.
`java.lang.Object`	`rpgCloneBase()` An rpgClone hook to provide the basic rpgClone (default implementation just calls Object clone).
`void`	`rpgCloneChildren(com.reportmill.foundation.ReportMill rm, RMShape copy)` An rpgClone hook to rpgClone a shape's children.
`void`	`rpgCloneConclude(com.reportmill.foundation.ReportMill rm)` An rpgClone hook called by RMDocument after this shape's page is rpgCloned.
`void`	`rpgCloneNotification(com.reportmill.foundation.ReportMill rm, RMShape copy)` An rpgClone hook to call ReportMill's rpgClone notification, if shape is named.
`void`	`rpgClonePrepare(com.reportmill.foundation.ReportMill rm)` An rpgClone hook called by RMDocument before this shape's page is rpgCloned.
`void`	`rpgClonePreprocess(com.reportmill.foundation.ReportMill rm)` An rpgClone hook called by RMDocument on all children before anything else.
`void`	`rpgCloneUrl(com.reportmill.foundation.ReportMill rm, RMShape rpgClone)` An rpgClone hook to clone a shape's URL with data substitution.
`void`	`sendShapesToBack(java.util.List shapes)` Moves the subset of children in the given list to the back of the children list.
`void`	`setActionScript(java.lang.String aString)` Returns the ActionScript for the shape.
`void`	`setAnim(com.reportmill.shape.RMShapeAnim anAnim)` Sets the collection of animation records for this shape.
`void`	`setAutosizeHeight(boolean aValue)`
`void`	`setAutosizing(java.lang.String aVal)`
`void`	`setBounds(float x, float y, float w, float h)`
`void`	`setBounds(RMRect r)`
`void`	`setBoundsOrigin(float x, float y)`
`void`	`setBoundsOrigin(RMPoint p)`
`void`	`setBoundsOriginX(float x)`
`void`	`setBoundsOriginY(float y)`
`void`	`setBoundsSize(float w, float h)`
`void`	`setBoundsSize(RMSize size)`
`void`	`setChildAnimator(com.reportmill.graphics.RMAnimator anAnimator)` Sets the animator that this shape's children use.
`void`	`setChildren(java.util.Vector aList)` Sets the list of children associated with this shape.
`void`	`setColor(RMColor aColor)` Sets the color of the shape.
`void`	`setColor(RMColor aColor, boolean drawsFill)` Sets the color of the shape, with an option to turn on drawsFill.
`void`	`setDrawsFill(boolean aValue)` Sets whether this shape should be filled.
`void`	`setDrawsStroke(boolean aValue)` Sets whehter this shape should be filled.
`void`	`setEverythingStretches()`
`void`	`setFill(RMFill f)` Sets the fill for this shape.
`void`	`setFill(RMFill f, boolean drawsFill)` Sets the fill for this shape, with an option to turn on drawsFill.
`void`	`setFont(RMFont aFont)` Sets the font for the shape.
`void`	`setFormat(RMFormat aFormat)` Sets the format for the shape.
`void`	`setHeight(float aHeight)` Sets the height of the shape.
`void`	`setHeightDeep(float h)`
`void`	`setHeightDeep(float h, boolean c)`
`void`	`setHeightToFit()` This convenience method sets the shape to its getHeightToFit (which is just the current height for most shapes).
`void`	`setLineWidth(float value)` Sets the line width of the shape's stroke in printer points.
`void`	`setListKey(java.lang.String aKeyPath)` Sets the List Key associated with this shape.
`void`	`setLocked(boolean aValue)` Sets the locked state of the shape (really just to prevent location/size changes in the editor).
`void`	`setName(java.lang.String aName)` Sets the name for the shape.
`void`	`setNeedsRepaint()` Visual change notification - call before making changes that will require repaint.
`void`	`setNeedsRepaint(RMShape aShape)` Visual change notification - call before making changes that will require repaint.
`void`	`setOnlyBottomAndRightMarginStretches()`
`void`	`setOnlyTopAndRightMarginStretches()`
`void`	`setOnlyWidthAndHeightStretches()`
`void`	`setOpacity(float aValue)` Sets the opactiy of the shape (1 for opaque, 0 for transparent).
`void`	`setOrigin(float x, float y)`
`void`	`setOrigin(RMPoint p)`
`void`	`setOutline(RMXString.Outline anOutline)` Sets the outline for the shape.
`void`	`setParent(RMShape aShape)` Sets the parent of this shape (called automatically by addChild()).
`void`	`setRoll(float aValue)` Sets the roll of the shape.
`void`	`setScaleX(float aValue)` Sets the scale of the X axis of the shape.
`void`	`setScaleXY(float aValue)` Sets the scale of the X and Y axes (convenience).
`void`	`setScaleXY(float sx, float sy)` Sets the scale of the X and Y axis (convenience).
`void`	`setScaleY(float aValue)` Sets the scale of the Y axis of the shape.
`void`	`setSize(float w, float h)`
`void`	`setSize(RMSize size)`
`void`	`setSizeDeep(float aWidth, float aHeight)`
`void`	`setSizeDeep(RMSize aSize)`
`void`	`setSizeToFit()` This convenience method sets the shape to its ideal size from getWidthToFit and getHeightToFit.
`void`	`setSizeToFit(float maxWidth, float maxHeight)` This convenience method sets the shape to its ideal size from getWidthToFit and getHeightToFit, allowing you to additionally specify a maxWidth and maxHeight.
`void`	`setSkewX(float aValue)` Sets the skew of the X axis of the shape.
`void`	`setSkewXY(float aValue)` Sets the skew of the X and Y axis (convenience).
`void`	`setSkewXY(float skx, float sky)` Sets the skew of the X and Y axis (convenience).
`void`	`setSkewY(float aValue)` Sets the skew of the Y axis of the shape.
`void`	`setStroke(com.reportmill.graphics.RMStroke s)` Sets the stroke for this shape.
`void`	`setStroke(com.reportmill.graphics.RMStroke s, boolean drawsStroke)` Sets the stroke for this shape, with an option to turn on drawsStroke.
`void`	`setStrokeColor(RMColor aColor)` Sets the stroke color of the shape.
`void`	`setStrokeColor(RMColor aColor, boolean drawStroke)` Sets the stroke color of the shape, with an option to turn on drawsStroke.
`void`	`setTextColor(RMColor aColor)` Sets the text color for the shape.
`void`	`setTime(float aTime)` This method tells the shape's anim records to update the shape to the given time.
`void`	`setUnderlined(boolean aFlag)` Sets the shape to underline.
`void`	`setUrl(java.lang.String aUrl)` Returns the URL for the shape.
`void`	`setWidth(float aWidth)` Sets the width of the shape.
`void`	`setWidthDeep(float w)`
`void`	`setWidthDeep(float w, boolean c)`
`void`	`setWidthToFit()` This convenience method sets the shape to its getWidthToFit (which is just the current width for most shapes).
`void`	`setX(float x)` Sets the X location of the shape.
`void`	`setXY(float x, float y)` Sets the X and Y location of the shape to the given point (convenience).
`void`	`setXY(RMPoint p)` Sets the X and Y location of the shape to the given point (convenience).
`void`	`setXYWidthHeight(float x, float y, float w, float h)` Sets the X, Y, Width and Height of this shape (convenience).
`void`	`setY(float y)` Sets the Y location of the shape.
`boolean`	`sizesToFitChildren()` Editor method.
`boolean`	`superSelectable()` Editor method.
`boolean`	`superSelectImmediately(RMPoint p)` Editor method.
`java.lang.String`	`toString()` Standard to string implementation (prints class name and shape bounds).
`com.ribs.RXElement`	`toXML(com.ribs.RXArchiver anArchiver)` XML Archival.
`com.reportmill.foundation.RMObject`	`undoClone()` Undo support.
`void`	`undoCopy(com.reportmill.foundation.RMObject anObj)` Undo support.
`boolean`	`undoEquals(com.reportmill.foundation.RMObject anObj)` Undo support.
`void`	`undoerAddDirtyObject(com.reportmill.foundation.RMObject anObj)` Undoer convenience - tells undoer to add a dirty object.
`void`	`undoerDisable()` Undoer convenience - disable the undoer.
`void`	`undoerEnable()` Undoer convenience - enables the undoer.
`void`	`undoerSetUndoTitle(java.lang.String aTitle)` Undoer convenience - sets title of next registered undo.
`float`	`width()` Returns the raw width of the shape.
`void`	`willChange()` Change notification - call before making attribute changes (provides hook for undo support).
`void`	`willChange(RMShape s)` Change notification - call before making attribute changes (provides hook for undo support).
`float`	`x()` Returns the raw x location of the shape.
`float`	`y()` Returns the raw y location of the shape.

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

HandleWidth

public static final byte HandleWidth

Handles

See Also:: Constant Field Values

HandleMinXMinY

public static final byte HandleMinXMinY

See Also:: Constant Field Values

HandleMaxXMinY

public static final byte HandleMaxXMinY

See Also:: Constant Field Values

HandleMinXMaxY

public static final byte HandleMinXMaxY

See Also:: Constant Field Values

HandleMaxXMaxY

public static final byte HandleMaxXMaxY

See Also:: Constant Field Values

HandleMinXMidY

public static final byte HandleMinXMidY

See Also:: Constant Field Values

HandleMaxXMidY

public static final byte HandleMaxXMidY

See Also:: Constant Field Values

HandleMidXMinY

public static final byte HandleMidXMinY

See Also:: Constant Field Values

HandleMidXMaxY

public static final byte HandleMidXMaxY

See Also:: Constant Field Values

Constructor Detail

RMShape

public RMShape()

Creates a plain shape.

RMShape

public RMShape(RMShape aShape)

Creates a shape with the same basic attributes as the given shape.

Method Detail

x

public float x()

Returns the raw x location of the shape. Developers should use the more common getX, which is adjusted to present only positive sizes.

y

public float y()

Returns the raw y location of the shape. Developers should use the more common getY, which is adjusted to present only positive sizes.

width

public float width()

Returns the raw width of the shape. Developers should use the more common getWidth, which is adjusted to present only positive sizes.

height

public float height()

Returns the raw height of the shape. Developers should use the more common getX, which is adjusted to present only positive sizes.

getX

public float getX()

Returns the X location of the shape.

setX

public void setX(float x)

Sets the X location of the shape.

getY

public float getY()

Returns the Y location of the shape.

setY

public void setY(float y)

Sets the Y location of the shape.

getWidth

public float getWidth()

Returns the width of the shape.

setWidth

public void setWidth(float aWidth)

Sets the width of the shape.

getHeight

public float getHeight()

Returns the height of the shape.

setHeight

public void setHeight(float aHeight)

Sets the height of the shape.

setXY

public void setXY(RMPoint p)

Sets the X and Y location of the shape to the given point (convenience).

setXY

public void setXY(float x,
                  float y)

Sets the X and Y location of the shape to the given point (convenience).

offsetXY

public void offsetXY(float dx,
                     float dy)

Offsets the X and Y location of the shape by the given dx & dy amount (convenience).

setXYWidthHeight

public void setXYWidthHeight(float x,
                             float y,
                             float w,
                             float h)

Sets the X, Y, Width and Height of this shape (convenience).

isLocked

public boolean isLocked()

Returns the locked state of the shape (really just to prevent location/size changes in the editor).

setLocked

public void setLocked(boolean aValue)

Sets the locked state of the shape (really just to prevent location/size changes in the editor).

getRoll

public float getRoll()

Returns the roll of the shape.

setRoll

public void setRoll(float aValue)

Sets the roll of the shape.

getScaleX

public float getScaleX()

Returns the scale of the X axis of the shape.

setScaleX

public void setScaleX(float aValue)

Sets the scale of the X axis of the shape.

getScaleY

public float getScaleY()

Returns the scale of the Y axis of the shape.

setScaleY

public void setScaleY(float aValue)

Sets the scale of the Y axis of the shape.

getSkewX

public float getSkewX()

Returns the skew of the X axis of the shape.

setSkewX

public void setSkewX(float aValue)

Sets the skew of the X axis of the shape.

getSkewY

public float getSkewY()

Returns the skew of the Y axis of the shape.

setSkewY

public void setSkewY(float aValue)

Sets the skew of the Y axis of the shape.

setScaleXY

public void setScaleXY(float aValue)

Sets the scale of the X and Y axes (convenience).

setScaleXY

public void setScaleXY(float sx,
                       float sy)

Sets the scale of the X and Y axis (convenience).

setSkewXY

public void setSkewXY(float aValue)

Sets the skew of the X and Y axis (convenience).

setSkewXY

public void setSkewXY(float skx,
                      float sky)

Sets the skew of the X and Y axis (convenience).

notRSS

public boolean notRSS()

Returns whether the shape has been rotated, scaled or skewed (for efficientency).

getColor

public RMColor getColor()

Returns the color of the shape.

setColor

public void setColor(RMColor aColor)

Sets the color of the shape. Turns on drawsFill as a side effect.

setColor

public void setColor(RMColor aColor,
                     boolean drawsFill)

Sets the color of the shape, with an option to turn on drawsFill.

getStrokeColor

public RMColor getStrokeColor()

Returns the stroke color of the shape.

setStrokeColor

public void setStrokeColor(RMColor aColor)

Sets the stroke color of the shape. Turns on drawsStroke as a side effect.

setStrokeColor

public void setStrokeColor(RMColor aColor,
                           boolean drawStroke)

Sets the stroke color of the shape, with an option to turn on drawsStroke.

getLineWidth

public float getLineWidth()

Returns the line width of the shape's stroke in printer points.

setLineWidth

public void setLineWidth(float value)

Sets the line width of the shape's stroke in printer points.

getOpacity

public float getOpacity()

Returns the opactiy of the shape (1 for opaque, 0 for transparent).

setOpacity

public void setOpacity(float aValue)

Sets the opactiy of the shape (1 for opaque, 0 for transparent).

getOpacityDeep

public float getOpacityDeep()

Returns the combined opacity of this shape and its parent.

getFill

public RMFill getFill()

Returns the fill for this shape.

setFill

public void setFill(RMFill f)

Sets the fill for this shape. Turns on drawsFill as a side effect.

setFill

public void setFill(RMFill f,
                    boolean drawsFill)

Sets the fill for this shape, with an option to turn on drawsFill.

getImageFill

public RMImageFill getImageFill()

Returns the imageFill for this shape (or null, if fill isn't an RMImageFill).

getImageData

public com.reportmill.graphics.RMImageData getImageData()

Returns the imageData for this shape (or null if fill isn't an RMImageFill).

getStroke

public com.reportmill.graphics.RMStroke getStroke()

Returns the stroke for this shape.

setStroke

public void setStroke(com.reportmill.graphics.RMStroke s)

Sets the stroke for this shape. Turns on drawsStroke as a side effect.

setStroke

public void setStroke(com.reportmill.graphics.RMStroke s,
                      boolean drawsStroke)

Sets the stroke for this shape, with an option to turn on drawsStroke.

drawsFill

public boolean drawsFill()

Returns whether this shape should be filled.

setDrawsFill

public void setDrawsFill(boolean aValue)

Sets whether this shape should be filled.

drawsStroke

public boolean drawsStroke()

Returns whether this shape should be stroked.

setDrawsStroke

public void setDrawsStroke(boolean aValue)

Sets whehter this shape should be filled.

getTextColor

public RMColor getTextColor()

Returns the text color for the shape.

setTextColor

public void setTextColor(RMColor aColor)

Sets the text color for the shape.

getName

public java.lang.String getName()

Returns the name for the shape.

setName

public void setName(java.lang.String aName)

Sets the name for the shape.

getUrl

public java.lang.String getUrl()

Sets the URL for the shape.

setUrl

public void setUrl(java.lang.String aUrl)

Returns the URL for the shape.

getAnim

public com.reportmill.shape.RMShapeAnim getAnim()

Returns the collection of animation records for this shape.

getAnim

public com.reportmill.shape.RMShapeAnim getAnim(boolean create)

Returns the collection of animation records for this shape, with an option to create if absent.

setAnim

public void setAnim(com.reportmill.shape.RMShapeAnim anAnim)

Sets the collection of animation records for this shape.

setTime

public void setTime(float aTime)

This method tells the shape's anim records to update the shape to the given time. Recurses to shape children.

getActionScript

public java.lang.String getActionScript()

Sets the ActionScript for the shape.

setActionScript

public void setActionScript(java.lang.String aString)

Returns the ActionScript for the shape.

get

public java.lang.Object get(java.lang.String aName)

Returns the Object associated with the given name for the shape.

put

public void put(java.lang.String aName,
                java.lang.Object anObj)

Sets an Object to be associated with the given name for the shape.

getFont

public RMFont getFont()

Returns the font for the shape.

setFont

public void setFont(RMFont aFont)

Sets the font for the shape.

isUnderlined

public boolean isUnderlined()

Returns whether the shape is underlined.

setUnderlined

public void setUnderlined(boolean aFlag)

Sets the shape to underline.

getOutline

public RMXString.Outline getOutline()

Returns the outline for the shape.

setOutline

public void setOutline(RMXString.Outline anOutline)

Sets the outline for the shape.

getFormat

public RMFormat getFormat()

Returns the format for the shape.

setFormat

public void setFormat(RMFormat aFormat)

Sets the format for the shape.

acceptsFormat

public boolean acceptsFormat()

Returns whether the shape can accept a format.

getAutosizing

public java.lang.String getAutosizing()

setAutosizing

public void setAutosizing(java.lang.String aVal)

setOnlyWidthAndHeightStretches

public void setOnlyWidthAndHeightStretches()

setOnlyTopAndRightMarginStretches

public void setOnlyTopAndRightMarginStretches()

setOnlyBottomAndRightMarginStretches

public void setOnlyBottomAndRightMarginStretches()

setEverythingStretches

public void setEverythingStretches()

getAutosizeHeight

public boolean getAutosizeHeight()

setAutosizeHeight

public void setAutosizeHeight(boolean aValue)

getPath

public RMPath getPath()

getPathInBounds

public RMPath getPathInBounds()

minXInside

public float minXInside()

minYInside

public float minYInside()

maxXInside

public float maxXInside()

maxYInside

public float maxYInside()

midXInside

public float midXInside()

midYInside

public float midYInside()

minX

public float minX()

minY

public float minY()

maxX

public float maxX()

maxY

public float maxY()

midX

public float midX()

midY

public float midY()

getOrigin

public RMPoint getOrigin()

setOrigin

public void setOrigin(RMPoint p)

setOrigin

public void setOrigin(float x,
                      float y)

getSize

public RMSize getSize()

setSize

public void setSize(RMSize size)

setSize

public void setSize(float w,
                    float h)

getBounds

public RMRect getBounds()

getBounds

public RMRect getBounds(RMShape aShape)

getBoundsInside

public RMRect getBoundsInside()

setBounds

public void setBounds(RMRect r)

setBounds

public void setBounds(float x,
                      float y,
                      float w,
                      float h)

getBoundsOrigin

public RMPoint getBoundsOrigin()

setBoundsOrigin

public void setBoundsOrigin(RMPoint p)

setBoundsOriginX

public void setBoundsOriginX(float x)

setBoundsOriginY

public void setBoundsOriginY(float y)

setBoundsOrigin

public void setBoundsOrigin(float x,
                            float y)

getBoundsSize

public RMSize getBoundsSize()

setBoundsSize

public void setBoundsSize(RMSize size)

setBoundsSize

public void setBoundsSize(float w,
                          float h)

setWidthDeep

public void setWidthDeep(float w)

setHeightDeep

public void setHeightDeep(float h)

setWidthDeep

public void setWidthDeep(float w,
                         boolean c)

setHeightDeep

public void setHeightDeep(float h,
                          boolean c)

setSizeDeep

public void setSizeDeep(RMSize aSize)

setSizeDeep

public void setSizeDeep(float aWidth,
                        float aHeight)

getBoundsOfChildren

public RMRect getBoundsOfChildren()

This method returns the bounds of all the children of this shape, which can sometimes differ from this shapes bounds.

getBoundsOfChildren

public RMRect getBoundsOfChildren(java.util.List aList)

This method returns the bounds of a given subset of this shape's children.

getBoundsSuperSelected

public RMRect getBoundsSuperSelected()

This method returns the bounds of the shape in parect coords when super selected. This is just getBoundsMarked by default.

getBoundsMarked

public RMRect getBoundsMarked()

This method returns the bounds of the path associated with this shape in parent coords, ajusted to account for the stroke width, if applicable.

getBoundsOfPath

public RMRect getBoundsOfPath()

This method returns the bounds of the path associated with this shape in parent coords.

getParent

public RMShape getParent()

Returns the parent of this shape.

setParent

public void setParent(RMShape aShape)

Sets the parent of this shape (called automatically by addChild()).

getParents

public java.util.List getParents()

Returns a list of this shape's parent, and that shape's parent, up to document.

getParentCount

public int getParentCount()

Returns the number of ancestors (from this shape's parent up to the document).

getChildCount

public int getChildCount()

Returns the number of children associated with this shape.

getChild

public RMShape getChild(int anIndex)

Returns the child at the given index.

getChildLast

public RMShape getChildLast()

Returns the last child of this shape.

getChildren

public java.util.Vector getChildren()

Returns the list of children associated with this shape.

setChildren

public void setChildren(java.util.Vector aList)

Sets the list of children associated with this shape.

reclaimChildren

public void reclaimChildren()

Ensures that children associated with this shape know who's their daddy.

indexOf

public int indexOf()

Returns the index of this child in its parent.

indexOf

public int indexOf(RMShape aChild)

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

addChild

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

addChildBelowLastChild

public void addChildBelowLastChild(RMShape aChild)

Adds the given child to the end of this shape's children list at a y position just below the previously last child.

removeChild

public void removeChild(RMShape aChild)

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

removeChild

public void removeChild(int anIndex)

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

removeChildren

public void removeChildren()

Removes all children from this shape.

removeChildren

public void removeChildren(java.util.List l)

Removes the given list of children from this shape.

removeFromParent

public void removeFromParent()

Removes this shape from it's parent.

getChildWithName

public RMShape getChildWithName(java.lang.String aName)

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

getChildWithClass

public RMShape getChildWithClass(java.lang.Class aClass)

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

offsetChildrenXY

public void offsetChildrenXY(float dx,
                             float dy)

Offsets this shape's children by the given dx, dy.

getRootShape

public RMShape getRootShape()

Returns the top level shape (usually an RMDocument).

getDocument

public RMDocument getDocument()

Returns the RMDocument ancestor of this shape (or null if not there).

getPageShape

public RMShape getPageShape()

Returns the RMPage ancestor of this shape (or null if not there).

getUndoer

public com.reportmill.foundation.RMUndoer getUndoer()

Returns the undoer for this shape (or null if not there).

undoerSetUndoTitle

public void undoerSetUndoTitle(java.lang.String aTitle)

Undoer convenience - sets title of next registered undo.

undoerDisable

public void undoerDisable()

Undoer convenience - disable the undoer.

undoerEnable

public void undoerEnable()

Undoer convenience - enables the undoer.

undoerAddDirtyObject

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

Undoer convenience - tells undoer to add a dirty object.

isRoot

public boolean isRoot()

Editor method - returns whether this shape is at the top level (usually RMPage).

isAncestor

public boolean isAncestor(RMShape aShape)

Returns true if given shape is one of this shape's ancestors.

isDescendant

public boolean isDescendant(RMShape aShape)

Returns true if given shape is one of this shape's descendants.

getCommonAncestor

public RMShape getCommonAncestor(RMShape aShape)

Returns the first ancestor that the given shape and this shape have in common.

getShapesToDescendant

public java.util.List getShapesToDescendant(RMShape aShape)

Returns a list of shape's from this shape to given desendant.

getShapesToAncestor

public java.util.List getShapesToAncestor(RMShape shape)

Returns a list of shapes from this shape to a given ancestor.

getShapesToShape

public java.util.List getShapesToShape(RMShape aShape)

Returns a list of shapes from this shape to given shape.

getTransform

public com.reportmill.graphics.RMTransform getTransform()

Returns the transform to this shape from its parent.

getTransformInverse

public com.reportmill.graphics.RMTransform getTransformInverse()

Returns the transform from this shape to it's parent.

getTransformToShape

public com.reportmill.graphics.RMTransform getTransformToShape(RMShape aShape)

Returns the transform from this shape to the given shape.

getTransformFromShape

public com.reportmill.graphics.RMTransform getTransformFromShape(RMShape aShape)

Returns the transform from the given shape to this shape.

convertPointToShape

public RMPoint convertPointToShape(RMPoint point,
                                   RMShape shape)

Converts the given point to the given shape's coords (returns it for convenience).

convertPointFromShape

public RMPoint convertPointFromShape(RMPoint point,
                                     RMShape shape)

Converts the given point to the given shape's coords (returns it for convenience).

convertVectorToShape

public RMSize convertVectorToShape(RMSize size,
                                   RMShape shape)

Converts the given size (as a vector) to the given shape's coords (returns it for convenience).

convertVectorFromShape

public RMSize convertVectorFromShape(RMSize size,
                                     RMShape shape)

Converts the given size (as a vector) from the given shape's coords (returns it for convenience).

convertSizeToShape

public RMSize convertSizeToShape(RMSize size,
                                 RMShape shape)

Converts the given size to the given shape's coords (returns it for convenience).

convertSizeFromShape

public RMSize convertSizeFromShape(RMSize size,
                                   RMShape shape)

Converts the given size from the given shape's coords (returns it for convenience).

convertRectToShape

public RMRect convertRectToShape(RMRect rect,
                                 RMShape shape)

Converts the given rect to the given shape's coords (returns it for convenience).

convertRectFromShape

public RMRect convertRectFromShape(RMRect rect,
                                   RMShape shape)

Converts the given rect from the given shape's coords (returns it for convenience).

convertedPointToShape

public RMPoint convertedPointToShape(RMPoint point,
                                     RMShape shape)

convertedPointFromShape

public RMPoint convertedPointFromShape(RMPoint point,
                                       RMShape shape)

convertedVectorToShape

public RMSize convertedVectorToShape(RMSize size,
                                     RMShape shape)

convertedVectorFromShape

public RMSize convertedVectorFromShape(RMSize size,
                                       RMShape shape)

convertedSizeToShape

public RMSize convertedSizeToShape(RMSize size,
                                   RMShape shape)

convertedSizeFromShape

public RMSize convertedSizeFromShape(RMSize size,
                                     RMShape shape)

convertedRectToShape

public RMRect convertedRectToShape(RMRect rect,
                                   RMShape shape)

convertedRectFromShape

public RMRect convertedRectFromShape(RMRect rect,
                                     RMShape shape)

convertPathToShape

public RMPath convertPathToShape(RMPath aPath,
                                 RMShape shape)

convertPathFromShape

public RMPath convertPathFromShape(RMPath aPath,
                                   RMShape shape)

convertToShape

public void convertToShape(RMShape aShape)

convertFromShape

public void convertFromShape(RMShape aShape)

getWidthToFit

public float getWidthToFit()

This method returns the ideal width of this shape to accommodate its contents (just the current width for most shapes).

setWidthToFit

public void setWidthToFit()

This convenience method sets the shape to its getWidthToFit (which is just the current width for most shapes).

getHeightToFit

public float getHeightToFit()

This method returns the ideal height of this shape to accommodate its contents (just the current height for most shapes).

setHeightToFit

public void setHeightToFit()

This convenience method sets the shape to its getHeightToFit (which is just the current height for most shapes).

setSizeToFit

public void setSizeToFit()

This convenience method sets the shape to its ideal size from getWidthToFit and getHeightToFit.

setSizeToFit

public void setSizeToFit(float maxWidth,
                         float maxHeight)

This convenience method sets the shape to its ideal size from getWidthToFit and getHeightToFit, allowing you to additionally specify a maxWidth and maxHeight.

divideShapeFromEdge

public RMShape divideShapeFromEdge(float amount,
                                   byte edge,
                                   RMShape newShape)

This method divides the shape by a given amount from the given edge. Returns newShape (or, if null, a clone) whose bounds have been set to the remainder.

divideShapeFromTop

public RMShape divideShapeFromTop(float amount)

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

getAnimator

public com.reportmill.graphics.RMAnimator getAnimator()

Returns the animator that this shape registers changes with.

getAnimator

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

Returns the animator that this shape registers changes with (creating, if requested and currently null).

getChildAnimator

public com.reportmill.graphics.RMAnimator getChildAnimator()

Returns the animator that this shape's children use.

getChildAnimator

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

Returns the animator that this shape's children use (creating, if requested and currently null). The base implementation passes request onto ancestors, but some subclasses create and manage one (RMPage, RMSwitchShape).

setChildAnimator

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

Sets the animator that this shape's children use.

rpgClone

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

A clone implementation that copies this shape and its children, performing data substituion as well.

rpgCloneBase

public java.lang.Object rpgCloneBase()

An rpgClone hook to provide the basic rpgClone (default implementation just calls Object clone).

rpgCloneUrl

public void rpgCloneUrl(com.reportmill.foundation.ReportMill rm,
                        RMShape rpgClone)

An rpgClone hook to clone a shape's URL with data substitution.

rpgCloneChildren

public void rpgCloneChildren(com.reportmill.foundation.ReportMill rm,
                             RMShape copy)

An rpgClone hook to rpgClone a shape's children.

rpgCloneNotification

public void rpgCloneNotification(com.reportmill.foundation.ReportMill rm,
                                 RMShape copy)

An rpgClone hook to call ReportMill's rpgClone notification, if shape is named.

rpgClonePreprocess

public void rpgClonePreprocess(com.reportmill.foundation.ReportMill rm)

An rpgClone hook called by RMDocument on all children before anything else.

rpgClonePrepare

public void rpgClonePrepare(com.reportmill.foundation.ReportMill rm)

An rpgClone hook called by RMDocument before this shape's page is rpgCloned.

rpgCloneConclude

public void rpgCloneConclude(com.reportmill.foundation.ReportMill rm)

An rpgClone hook called by RMDocument after this shape's page is rpgCloned.

resolvePageReferences

public void resolvePageReferences(com.reportmill.foundation.ReportMill rm,
                                  java.lang.Object userInfo)

Replaces all @Page@ style keys with their actual values for this shape and it's children.

getPageCount

public int getPageCount()

Returns the number of pages associated with this shape. This is generally zero, except for RMDocument's implementation. Additionally, transient RPG objects use this to declare if they have paginated themselves over multiple pages during rpgCloning.

getListKey

public java.lang.String getListKey()

Returns the "List Key" associated with this shape. A List Key is a key path that specifies a specific list of objects in the document's datasource.

setListKey

public void setListKey(java.lang.String aKeyPath)

Sets the List Key associated with this shape. Not all shapes support this (only List Key shapes, like table, graph, crosstab and labels). In fact this default implementation does nothing.

getListKeyDeep

public java.lang.String getListKeyDeep()

Returns the combined list keys of this shape and its parents. Useful for nested list key shapes, like table group.

getListKeyShape

public RMShape getListKeyShape()

Returns the real shape used to resolve the list key for this shape. This seems bogus - might go soon.

hitByPoint

public boolean hitByPoint(RMPoint aPoint)

Returns whether this shape is hit by the point, given in this shape's parent's coords.

hitByPath

public boolean hitByPath(RMPath aPath)

Returns whether this shape is hit by the path, given in this shape's parent's coords.

childHitByPoint

public RMShape childHitByPoint(RMPoint point)

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

childrenHitByPath

public java.util.List childrenHitByPath(RMPath aPath)

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

bringShapesToFront

public void bringShapesToFront(java.util.List shapes)

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

sendShapesToBack

public void sendShapesToBack(java.util.List shapes)

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

groupShapes

public RMShape groupShapes(java.util.List shapes,
                           RMShape groupShape)

Adds the subset of children in the given list into a given group shape, which is then added back to the receiver.

getGroupShape

public RMShape getGroupShape(java.util.List shapes)

Returns a newly created RMShape whose bounds has been set to the combined bounds of the subset of children in the given list.

hitChildren

public java.util.List hitChildren()

Returns the subset of children that should be used for hit detection. This is useful for implementing page layering.

drawChildren

public java.util.List drawChildren()

Returns the subset of children that should be drawn. This is useful for implementing page layering.

handleCount

public int handleCount()

handlePoint

public RMPoint handlePoint(int handle,
                           boolean isSuperSelected)

handleRect

public RMRect handleRect(int handle,
                         boolean isSuperSelected)

handleAtPoint

public int handleAtPoint(RMPoint point,
                         boolean isSuperSelected)

opposingHandle

public int opposingHandle(int handle)

moveHandleToPoint

public void moveHandleToPoint(int handle,
                              RMPoint toPoint)

clone

public java.lang.Object clone()

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

cloneDeep

public RMShape cloneDeep()

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

equals

public boolean equals(java.lang.Object anObj)

Standard implementation of Object equals.

copy

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

Copies applicable attributes from the given object.

copyShape

public void copyShape(RMShape aShape)

Copies basic shape attributes from given RMShape (location, size, fill, stroke, roll, scale, name, url, etc.).

initWithArchiver

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

Legacy unarchival.

toXML

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

XML Archival.

fromXML

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

XML unarchival.

fromXMLDeep

public void fromXMLDeep(com.ribs.RXArchiver anArchiver,
                        com.ribs.RXElement anElement)

XML unarchival for shape children

willChange

public void willChange()

Change notification - call before making attribute changes (provides hook for undo support).

willChange

public void willChange(RMShape s)

Change notification - call before making attribute changes (provides hook for undo support).

setNeedsRepaint

public void setNeedsRepaint()

Visual change notification - call before making changes that will require repaint.

setNeedsRepaint

public void setNeedsRepaint(RMShape aShape)

Visual change notification - call before making changes that will require repaint.

boundsChanged

public void boundsChanged()

Notifies a shape and its parents that its bounds changed.

boundsChanged

public void boundsChanged(RMShape aShape)

Notifies this shape that a given shape's bounds have changed (presumably a descendant).

superSelectable

public boolean superSelectable()

Editor method.

canBeUngrouped

public boolean canBeUngrouped()

Editor method.

acceptsChildren

public boolean acceptsChildren()

Editor method.

sizesToFitChildren

public boolean sizesToFitChildren()

Editor method.

superSelectImmediately

public boolean superSelectImmediately(RMPoint p)

Editor method.

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

Editor method.

acceptsEvents

public boolean acceptsEvents()

Editor method.

acceptsFirstEvent

public boolean acceptsFirstEvent()

Editor method.

acceptsDragKeys

public boolean acceptsDragKeys()

Editor method.

dragKeyAtPoint

public void dragKeyAtPoint(java.lang.String aKey,
                           RMPoint aPoint)

Editor method.

dropKeyAtPoint

public void dropKeyAtPoint(java.lang.String aKey,
                           RMPoint aPoint)

Editor method.

dragExit

public void dragExit()

Editor method.

toString

public java.lang.String toString()

Standard to string implementation (prints class name and shape bounds).

page

public int page()

Page number resolution.

pageMax

public int pageMax()

Page number resolution.

pageBreakMax

public int pageBreakMax()

Page number resolution.

pageBreakPageMax

public int pageBreakPageMax()

Page number resolution.

hasPageBreaks

public boolean hasPageBreaks()

Page number resolution.

undoEquals

public boolean undoEquals(com.reportmill.foundation.RMObject anObj)

Undo support.

undoClone

public com.reportmill.foundation.RMObject undoClone()

Undo support.

undoCopy

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

Undo support.

didChange

public void didChange(com.reportmill.foundation.RMObject oldObj)

Undo support.

Overview

Package

Class

Tree

Deprecated

Index

Help

ReportMill 7.0 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.reportmill.shape Class RMShape

HandleWidth

HandleMinXMinY

HandleMaxXMinY

HandleMinXMaxY

HandleMaxXMaxY

HandleMinXMidY

HandleMaxXMidY

HandleMidXMinY

HandleMidXMaxY

RMShape

RMShape

x

y

width

height

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

setXY

setXY

offsetXY

setXYWidthHeight

isLocked

setLocked

getRoll

setRoll

getScaleX

setScaleX

getScaleY

setScaleY

getSkewX

setSkewX

getSkewY

setSkewY

setScaleXY

setScaleXY

setSkewXY

setSkewXY

notRSS

getColor

setColor

setColor

getStrokeColor

setStrokeColor

setStrokeColor

getLineWidth

setLineWidth

getOpacity

setOpacity

getOpacityDeep

getFill

setFill

setFill

getImageFill

getImageData

getStroke

setStroke

setStroke

drawsFill

setDrawsFill

drawsStroke

setDrawsStroke

getTextColor

setTextColor

getName

setName

getUrl

setUrl

getAnim

getAnim

setAnim

setTime

getActionScript

setActionScript

com.reportmill.shape
Class RMShape