ReportMill 7.0 API

com.reportmill.shape
Class RMSwitchShape

java.lang.Object
  extended bycom.reportmill.foundation.RMObject
      extended bycom.reportmill.shape.RMShape
          extended bycom.reportmill.shape.RMSwitchShape
All Implemented Interfaces:
java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving
Direct Known Subclasses:
RMGraph.BarLabel, RMTableRow

public class RMSwitchShape
extends RMShape


Field Summary
 
Fields inherited from class com.reportmill.shape.RMShape
HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth
 
Constructor Summary
RMSwitchShape()
           
RMSwitchShape(RMShape aShape)
           
 
Method Summary
 boolean acceptsChildren()
          Editor method.
 void addVersionWithShape(java.lang.String aString, RMShape aShape)
           
 java.util.Map alternates()
           
 RMSwitchShape alternateShapeInstance()
           
 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.
 void copy(com.reportmill.foundation.RMObject anObj)
          Copies applicable attributes from the given object.
 java.lang.String defaultVersion()
           
 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.
 com.reportmill.graphics.RMAnimator getChildAnimator(boolean create)
          Returns the animator that this shape's children use (creating, if requested and currently null).
 RMSwitchShape getVersion(java.lang.String aVersionString)
           
 boolean hasAlternateVersions()
           
 boolean hasMouseVersions()
           
 boolean hasVersion(java.lang.String aString)
           
 java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)
          Legacy unarchival.
 void removeVersion(java.lang.String aString)
           
 RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill)
          A clone implementation that copies this shape and its children, performing data substituion as well.
 RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill, java.lang.String aVersion)
           
 void setAlternates(java.util.Map aMap)
           
 void setChildAnimator(com.reportmill.graphics.RMAnimator anAnimator)
          Sets the animator that this shape's children use.
 void setVersion(java.lang.String aString)
           
 void setVersionForKey(RMShape aShape, java.lang.String aKey)
           
 void setVersionKey(java.lang.String aVersionKey)
           
 void setWidthDeep(float width, boolean constrain)
           
 boolean superSelectable()
          Editor method.
 com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)
          XML archival.
 java.lang.String version()
           
 java.lang.String versionKey()
           
 java.util.List versions()
           
 
Methods inherited from class com.reportmill.shape.RMShape
acceptsDragKeys, acceptsEvents, acceptsFirstEvent, acceptsFormat, addChild, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childHitByPoint, childrenHitByPath, childrenSuperSelectImmediately, 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, drawChildren, 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, getDocument, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getPageShape, 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, handleAtPoint, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, hitChildren, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, page, pageBreakMax, pageBreakPageMax, pageMax, put, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, 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, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectImmediately, toString, undoClone, 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
 

Constructor Detail

RMSwitchShape

public RMSwitchShape()

RMSwitchShape

public RMSwitchShape(RMShape aShape)
Method Detail

version

public java.lang.String version()

setVersion

public void setVersion(java.lang.String aString)

versionKey

public java.lang.String versionKey()

setVersionKey

public void setVersionKey(java.lang.String aVersionKey)

alternates

public java.util.Map alternates()

setAlternates

public void setAlternates(java.util.Map aMap)

hasVersion

public boolean hasVersion(java.lang.String aString)

hasAlternateVersions

public boolean hasAlternateVersions()

setVersionForKey

public void setVersionForKey(RMShape aShape,
                             java.lang.String aKey)

addVersionWithShape

public void addVersionWithShape(java.lang.String aString,
                                RMShape aShape)

removeVersion

public void removeVersion(java.lang.String aString)

versions

public java.util.List versions()

defaultVersion

public java.lang.String defaultVersion()

getVersion

public RMSwitchShape getVersion(java.lang.String aVersionString)

hasMouseVersions

public boolean hasMouseVersions()

getChildAnimator

public com.reportmill.graphics.RMAnimator getChildAnimator(boolean create)
Description copied from class: RMShape
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).

Overrides:
getChildAnimator in class RMShape

setChildAnimator

public void setChildAnimator(com.reportmill.graphics.RMAnimator anAnimator)
Description copied from class: RMShape
Sets the animator that this shape's children use.

Overrides:
setChildAnimator in class RMShape

alternateShapeInstance

public RMSwitchShape alternateShapeInstance()

rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill)
Description copied from class: RMShape
A clone implementation that copies this shape and its children, performing data substituion as well.

Overrides:
rpgClone in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill,
                        java.lang.String aVersion)

setWidthDeep

public void setWidthDeep(float width,
                         boolean constrain)
Overrides:
setWidthDeep in class RMShape

clone

public java.lang.Object clone()
Description copied from class: RMShape
Standard implementation of Object clone. Null's out shape's parent and children.

Overrides:
clone in class RMShape

equals

public boolean equals(java.lang.Object anObj)
Description copied from class: RMShape
Standard implementation of Object equals.

Overrides:
equals in class RMShape

copy

public void copy(com.reportmill.foundation.RMObject anObj)
Description copied from class: RMShape
Copies applicable attributes from the given object.

Overrides:
copy in class RMShape

cloneDeep

public RMShape cloneDeep()
Description copied from class: RMShape
Clones all attributes of this shape with complete clones of its children as well.

Overrides:
cloneDeep in class RMShape

superSelectable

public boolean superSelectable()
Description copied from class: RMShape
Editor method.

Overrides:
superSelectable in class RMShape

acceptsChildren

public boolean acceptsChildren()
Description copied from class: RMShape
Editor method.

Overrides:
acceptsChildren 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

ReportMill 7.0 API