|
ReportMill 11 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.reportmill.base.RMObject
com.reportmill.shape.RMShape
com.reportmill.shape.RMSwitchShape
public class RMSwitchShape
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 | |
---|---|
RMSwitchShape()
Creates a plain switch shape. |
Method Summary | |
---|---|
boolean |
acceptsChildren()
Editor method - specifies that switch shape accepts children. |
boolean |
acceptsMouse()
Viewer method. |
RMSwitchShape |
clone()
Standard clone implementation. |
RMShape |
cloneDeep()
Standard clone deep implementation. |
boolean |
equals(java.lang.Object anObj)
Standard equals implementation. |
java.lang.Object |
fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
com.reportmill.archiver.RXElement anElement,
java.lang.Object anOwner)
XML unarchival. |
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 create)
Returns the map used to hold alternate versions. |
com.reportmill.graphics.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<java.lang.String> |
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. |
void |
paintShape(com.reportmill.shape.RMShapePainter aPainter,
java.awt.Graphics2D g)
Paints switch shape. |
void |
removeVersion(java.lang.String aString)
Removes the version shape associated with the given name from the alternates map. |
void |
setAlternates(java.util.Map aMap)
Sets the map used to hold alternate versions. |
void |
setReportMill(com.reportmill.base.ReportMill aReportMill)
Report generation. |
void |
setReportMill(com.reportmill.base.ReportMill aReportMill,
java.lang.String aVersion)
Report generation. |
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 |
setWidth(float aWidth)
Overrides standard shape method to resize alternates. |
void |
shapeHidden()
Overrides shape implementation to stop animator if it should be playing. |
void |
shapeShown()
Overrides shape implementation to start animator if it should be playing. |
boolean |
superSelectable()
Editor method - specifies that switch shape is super selectable. |
com.reportmill.archiver.RXElement |
toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
java.lang.Object anOwner)
XML archival. |
void |
toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver,
com.reportmill.archiver.RXElement anElement,
java.lang.Object anOwner)
XML child archival - override to archive alternates. |
Methods inherited from class com.reportmill.base.RMObject |
---|
addListener, addPropertyChangeListener, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RMSwitchShape()
Method Detail |
---|
public java.lang.String getVersion()
public void setVersion(java.lang.String aName)
public RMSwitchShape getVersion(java.lang.String aName)
public void setVersion(java.lang.String aString, RMSwitchShape aShape, boolean makeActive)
public void removeVersion(java.lang.String aString)
public java.lang.String getVersionKey()
public void setVersionKey(java.lang.String aVersionKey)
public java.util.Map<java.lang.String,RMSwitchShape> getAlternates()
public java.util.Map<java.lang.String,RMSwitchShape> getAlternates(boolean create)
public void setAlternates(java.util.Map aMap)
public boolean hasVersion(java.lang.String aString)
public boolean hasAlternateVersions()
public boolean hasMouseVersions()
public java.util.List<java.lang.String> getVersionNames()
public java.lang.String getDefaultVersionName()
public com.reportmill.graphics.RMAnimator getChildAnimator(boolean create)
getChildAnimator
in class RMShape
public void setWidth(float aWidth)
setWidth
in class RMShape
public void paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g)
paintShape
in class RMShape
public void shapeShown()
shapeShown
in class RMShape
public void shapeHidden()
shapeHidden
in class RMShape
public void setReportMill(com.reportmill.base.ReportMill aReportMill)
setReportMill
in class RMShape
public void setReportMill(com.reportmill.base.ReportMill aReportMill, java.lang.String aVersion)
public boolean equals(java.lang.Object anObj)
equals
in class RMShape
public RMSwitchShape clone()
clone
in class RMShape
public RMShape cloneDeep()
cloneDeep
in class RMShape
public boolean acceptsMouse()
acceptsMouse
in class RMShape
public boolean superSelectable()
superSelectable
in class RMShape
public boolean acceptsChildren()
acceptsChildren
in class RMShape
public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner)
toXMLShape
in class RMShape
public void toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)
toXMLShapeChildren
in class RMShape
public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)
fromXMLShape
in class RMShape
|
ReportMill 11 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |