com.reportmill.shape

Class RMSwitchShape

java.lang.Object

SnapObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMParentShape

com.reportmill.shape.RMSwitchShape

All Implemented Interfaces:

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

Direct Known Subclasses:

RMTableRow

public class RMSwitchShape
extends RMParentShape

This class represents a sophisticated shape that can maintain multiple versions of itself. For example, a shape can have a "Standard" version and an "Alternate" version (for alternating TableRows).

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
RMSwitchShape()

Method Summary

Modifier and Type	Method and Description
boolean	acceptsChildren() Editor method - specifies that switch shape accepts children.
RMSwitchShape	clone() Standard clone implementation.
RMSwitchShape	cloneDeep() Standard clone deep implementation.
java.util.Map<java.lang.String,RMSwitchShape>	getAlternates() Returns the map used to hold alternate versions.
java.util.Map<java.lang.String,RMSwitchShape>	getAlternates(boolean doCreate) Returns the map used to hold alternate versions.
RMAnimator	getChildAnimator(boolean doCreate) 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<java.lang.String>	getVersionNames() Returns a sorted list of all version names contained in the switch shape.
boolean	hasVersion(java.lang.String aString) Returns whether switch shape has a version with the given name.
void	paintShape(RMShapePainter aPntr) Paints switch shape.
void	removeVersion(java.lang.String aString) Removes the version shape associated with the given name from the alternates map.
RMShape	rpgAll(ReportOwner anRptOwner, RMShape aParent) Report generation.
void	setVersion(java.lang.String aName) Sets the currently selected version of the switch shape to given version name.
void	setVersionKey(java.lang.String aVersionKey) Sets the version key used to get the version used in a report.
void	setWidth(double aWidth) Overrides standard shape method to resize alternates.
boolean	superSelectable() Editor method - specifies that switch shape is super selectable.
XMLElement	toXML(XMLArchiver anArchiver) XML Archival generic - break toXML into toXMLShape and toXMLShapeChildren.

Methods inherited from class com.reportmill.shape.RMParentShape

addChild, addChild, addChild, addChild, bringShapesToFront, divideShapeFromTop, fromXML, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isSourceURLSet, layout, relayout, removeChild, removeChild, removeChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL

Methods inherited from class com.reportmill.shape.RMShape

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, 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, 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, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class java.lang.Object

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

Constructor Detail

RMSwitchShape

public RMSwitchShape()

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.

removeVersion

public void removeVersion(java.lang.String aString)

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

getAlternates

public java.util.Map<java.lang.String,RMSwitchShape> getAlternates()

Returns the map used to hold alternate versions.

getAlternates

public java.util.Map<java.lang.String,RMSwitchShape> getAlternates(boolean doCreate)

Returns the map used to hold alternate versions.

hasVersion

public boolean hasVersion(java.lang.String aString)

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

getVersionNames

public java.util.List<java.lang.String> 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.

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.

getChildAnimator

public RMAnimator getChildAnimator(boolean doCreate)

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

Overrides:

getChildAnimator in class RMShape

setWidth

public void setWidth(double aWidth)

Overrides standard shape method to resize alternates.

Overrides:

setWidth in class RMParentShape

paintShape

public void paintShape(RMShapePainter aPntr)

Paints switch shape.

Overrides:

paintShape in class RMShape

rpgAll

public RMShape rpgAll(ReportOwner anRptOwner,
                      RMShape aParent)

Report generation.

Overrides:

rpgAll in class RMParentShape

clone

public RMSwitchShape clone()

Standard clone implementation.

Overrides:

clone in class RMParentShape

cloneDeep

public RMSwitchShape cloneDeep()

Standard clone deep implementation.

Overrides:

cloneDeep in class RMParentShape

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 XMLElement toXML(XMLArchiver anArchiver)

XML Archival generic - break toXML into toXMLShape and toXMLShapeChildren.

Overrides:

toXML in class RMParentShape