com.reportmill.shape

Class RMSwitchShape

java.lang.Object

com.reportmill.base.RMObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMSwitchShape

All Implemented Interfaces:

RMArchiver.Archiving, java.lang.Cloneable

Direct Known Subclasses:

RMGraph.BarLabel, RMTableRow, RMTableRowRPG

public class RMSwitchShape
extends RMShape

This class represents a sophisticated shape that can maintain multiple versions of itself. For example, a shape can have a "Standard" version and a "Mouse Over" version (to define the attributes of this shape when the mouse hovers over it).

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
RMSwitchShape() Creates a plain switch shape.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsChildren() Editor method - specifies that switch shape accepts children.
boolean	acceptsMouse() Viewer method.
RMSwitchShape	alternateShapeInstance() Creates a new switch shape of this same class.
java.lang.Object	clone() Standard clone implementation.
RMShape	cloneDeep() Standard clone deep implementation.
void	copy(java.lang.Object anObj) Standard copy implementation.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
java.util.Map	getAlternates() Returns the map used to hold alternate versions.
RMAnimator	getChildAnimator(boolean create) Returns the child animator of the switch shape (creating it if absent and requested).
java.lang.String	getDefaultVersionName() Returns the default version name.
java.lang.String	getVersion() Returns the currently selected version string for the switch shape.
RMSwitchShape	getVersion(java.lang.String aName) Returns the switch shape associated with the given version name.
java.lang.String	getVersionKey() Returns the version key used to get the version used in a report.
java.util.List	getVersionNames() Returns a sorted list of all version names contained in the switch shape.
boolean	hasAlternateVersions() Returns whether switch shape has version(s) other than the default.
boolean	hasMouseVersions() Returns whether switch shape has any mouse versions ("Mouse Over" or "Mouse Down").
boolean	hasVersion(java.lang.String aString) Returns whether switch shape has a version with the given name.
java.lang.Object	initWithArchiver(RMArchiver anArchiver) Legacy unarchival.
void	mouseEntered(RMViewer aViewer, java.awt.event.MouseEvent anEvent) Viewer method.
void	mouseExited(RMViewer aViewer, java.awt.event.MouseEvent anEvent) Viewer method.
void	removeVersion(java.lang.String aString) Removes the version shape associated with the given name from the alternates map.
RMShape	rpgClone(ReportMill aReportMill) Standard RPG clone method.
RMShape	rpgClone(ReportMill aReportMill, java.lang.String aVersion) RPG clone with specified version.
void	setAlternates(java.util.Map aMap) Sets the map used to hold alternate versions.
void	setVersion(java.lang.String aName) Sets the currently selected version of the switch shape to given version name.
void	setVersion(java.lang.String aString, RMSwitchShape aShape, boolean makeActive) Sets given shape to be the version for the given name.
void	setVersionKey(java.lang.String aVersionKey) Sets the version key used to get the version used in a report.
void	setWidthDeep(float width, boolean constrain) Overrides standard shape method to resize alternates.
boolean	superSelectable() Editor method - specifies that switch shape is super selectable.
RXElement	toXML(RXArchiver anArchiver) XML archival.
protected void	transferAttributes(RMSwitchShape toShape) This method is used by setVersion to transfers attributes to/from alternate versions.

Methods inherited from class com.reportmill.shape.RMShape

acceptsDragKeys, acceptsFormat, addChild, addChild, addChildBelowLastChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childrenSuperSelectImmediately, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, delete, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, dropKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWhoDraw, getChildrenWhoHitTest, getChildSortedByX, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getToolClassName, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getXY, getXYP, getY, groupShapes, hasPageBreaks, height, indexOf, indexOf, intersects, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, mouseDragged, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageBreakMax, pageBreakPageMax, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOpacity, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y

Methods inherited from class com.reportmill.base.RMObject

didUndo, getAnimAttribute, getClassNameShort

Methods inherited from class java.lang.Object

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

Constructor Detail

RMSwitchShape

public RMSwitchShape()

Creates a plain switch shape.

Method Detail

getVersion

public java.lang.String getVersion()

Returns the currently selected version string for the switch shape.

setVersion

public void setVersion(java.lang.String aName)

Sets the currently selected version of the switch shape to given version name. If the specified version name doesn't yet exist, this method creates a new version for it.

getVersion

public RMSwitchShape getVersion(java.lang.String aName)

Returns the switch shape associated with the given version name.

setVersion

public void setVersion(java.lang.String aString,
                       RMSwitchShape aShape,
                       boolean makeActive)

Sets given shape to be the version for the given name. If makeActive, then it makes given version active as well.

removeVersion

public void removeVersion(java.lang.String aString)

Removes the version shape associated with the given name from the alternates map.

getVersionKey

public java.lang.String getVersionKey()

Returns the version key used to get the version used in a report.

setVersionKey

public void setVersionKey(java.lang.String aVersionKey)

Sets the version key used to get the version used in a report.

getAlternates

public java.util.Map getAlternates()

Returns the map used to hold alternate versions.

setAlternates

public void setAlternates(java.util.Map aMap)

Sets the map used to hold alternate versions.

transferAttributes

protected void transferAttributes(RMSwitchShape toShape)

This method is used by setVersion to transfers attributes to/from alternate versions.

hasVersion

public boolean hasVersion(java.lang.String aString)

Returns whether switch shape has a version with the given name.

hasAlternateVersions

public boolean hasAlternateVersions()

Returns whether switch shape has version(s) other than the default.

hasMouseVersions

public boolean hasMouseVersions()

Returns whether switch shape has any mouse versions ("Mouse Over" or "Mouse Down").

getVersionNames

public java.util.List getVersionNames()

Returns a sorted list of all version names contained in the switch shape.

getDefaultVersionName

public java.lang.String getDefaultVersionName()

Returns the default version name.

getChildAnimator

public RMAnimator getChildAnimator(boolean create)

Returns the child animator of the switch shape (creating it if absent and requested).

Overrides:

getChildAnimator in class RMShape

alternateShapeInstance

public RMSwitchShape alternateShapeInstance()

Creates a new switch shape of this same class.

rpgClone

public RMShape rpgClone(ReportMill aReportMill)

Standard RPG clone method.

Overrides:

rpgClone in class RMShape

rpgClone

public RMShape rpgClone(ReportMill aReportMill,
                        java.lang.String aVersion)

RPG clone with specified version.

setWidthDeep

public void setWidthDeep(float width,
                         boolean constrain)

Overrides standard shape method to resize alternates.

Overrides:

setWidthDeep in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

copy

public void copy(java.lang.Object anObj)

Standard copy implementation.

Overrides:

copy in class RMShape

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class RMShape

cloneDeep

public RMShape cloneDeep()

Standard clone deep implementation.

Overrides:

cloneDeep in class RMShape

acceptsMouse

public boolean acceptsMouse()

Viewer method.

Overrides:

acceptsMouse in class RMShape

mouseEntered

public void mouseEntered(RMViewer aViewer,
                         java.awt.event.MouseEvent anEvent)

Viewer method.

Overrides:

mouseEntered in class RMShape

mouseExited

public void mouseExited(RMViewer aViewer,
                        java.awt.event.MouseEvent anEvent)

Viewer method.

Overrides:

mouseExited in class RMShape

superSelectable

public boolean superSelectable()

Editor method - specifies that switch shape is super selectable.

Overrides:

superSelectable in class RMShape

acceptsChildren

public boolean acceptsChildren()

Editor method - specifies that switch shape accepts children.

Overrides:

acceptsChildren in class RMShape

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape

initWithArchiver

public java.lang.Object initWithArchiver(RMArchiver anArchiver)

Legacy unarchival.

Specified by:

initWithArchiver in interface RMArchiver.Archiving

Overrides:

initWithArchiver in class RMShape