|
ReportMill 10 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
com.reportmill.shape.RMTableRow
public class RMTableRow
This class models a table row in a table.
Field Summary | |
---|---|
static int |
_moveHandle
|
static java.lang.String |
VersionAlternate
|
static java.lang.String |
VersionFirstOnly
|
static java.lang.String |
VersionReprint
|
static java.lang.String |
VersionSplitHeader
|
static java.lang.String |
VersionStandard
|
static java.lang.String |
VersionTopNOthers
|
Fields inherited from class com.reportmill.shape.RMShape |
---|
WRAP_TYPE_BOTH, WRAP_TYPE_NONE |
Constructor Summary | |
---|---|
RMTableRow()
Creates a plain, unstructured table row. |
|
RMTableRow(boolean isStructured)
Creates a table row allowing the user to specify whether it should be structured. |
Method Summary | |
---|---|
void |
addChild(RMShape aChild,
int anIndex)
Overrides standard shape method to turn off structuring if child isn't text. |
void |
arrange()
Tells table to do layout (obsolete). |
void |
boundsChanged(RMShape aShape)
Notification method - relays out children when bounds are changed. |
boolean |
canBeUngrouped()
Editor method - states that this shape can't be ungrouped. |
boolean |
childrenSuperSelectImmediately()
Editor method - states that children super-select immediately when table row is structured. |
void |
copy(java.lang.Object anObj)
Standard copy implementation. |
boolean |
equals(java.lang.Object anObj)
Standard equals implementation. |
java.lang.Object |
fromXML(com.reportmill.archiver.RXArchiver anArchiver,
com.reportmill.archiver.RXElement anElement)
XML unarchival. |
RMText |
getColumn(int anIndex)
Returns the column at the given index (assumes row is structured and column is RMText). |
float |
getMinSplitHeight()
Returns the minimum distance in points from the top of the row that this row can split. |
float |
getMinSplitRemainderHeight()
Returns the minimum distance in points from the bottom of the row that this row can split. |
boolean |
getMoveToBottom()
Returns whether this row should be moved to the bottom of the table during report generation. |
int |
getNumberOfChildrenToStayWith()
Returns the number of children this table row needs to be accompanied by, if some children run off page bottom. |
int |
getNumberOfColumns()
Returns the number of columns in this table row (really just child count). |
boolean |
getPrintEvenIfGroupIsEmpty()
Returns whether this row should print even if it has no children (assumed to be a header/summary row). |
boolean |
getReprintWhenWrapped()
Returns whether this row is reprinted on a new page when it's children cross a page boundary. |
RMTableRow |
getRowAbove()
Returns the row above this one in the template. |
boolean |
getSyncStructureWithAlternates()
Returns whether table row should synchronize the column widths of alternate versions. |
boolean |
getSyncStructureWithRowAbove()
Returns whether table row should synchronize the column widths of the row immediately above it. |
RMTable |
getTable()
Returns the parent of this table row. |
com.reportmill.shape.RMTableRowLayout |
getTableRowLayout()
Returns the table row shape layout as a table row layout. |
java.lang.String |
getTitle()
Returns the title for this table row in it's parent table. |
boolean |
isStructured()
Returns whether this table row is structured. |
RMShape |
rpgClone(com.reportmill.shape.RMTableRPGAdder anAdder,
com.reportmill.base.RMGroup group,
java.lang.String suggestedVersion)
Override shape implementation to hand things off to RMTableRowRPG. |
java.lang.Object |
rpgCloneBase()
Override shape implementation to substitute RMTableRowRPG as the class for the rpgClone. |
void |
rpgCloneNotification(com.reportmill.base.ReportMill rm,
RMShape copy)
Overrides shape implementation to suppress normal notification (will send after table row's version). |
void |
setMinSplitHeight(float aValue)
Sets the minimum distance in points from the top of the row that this row can split. |
void |
setMinSplitRemainderHeight(float aValue)
Sets the minimum distance in points from the top of the row that this row can split. |
void |
setMoveToBottom(boolean aFlag)
Sets whether this row should be moved to the bottom of the table during report generation. |
void |
setNumberOfChildrenToStayWith(int aValue)
Sets the number of children this table row needs to be accompanied by, if some children run off page bottom. |
void |
setNumberOfColumns(int count)
Sets the number of columns in this table row. |
void |
setPrintEvenIfGroupIsEmpty(boolean aFlag)
Returns whether this row should print even if it has no children (assumed to be a header/summary row). |
void |
setReprintWhenWrapped(boolean aFlag)
Sets whether this row is reprinted on a new page when it's children cross a page boundary. |
void |
setStructured(boolean aFlag)
Sets whether this table row should be structured. |
void |
setSyncStructureWithAlternates(boolean aFlag)
Sets whether table row should synchronize the column widths of alternate versions. |
void |
setSyncStructureWithRowAbove(boolean aFlag)
Sets whether table row should synchronize the column widths of the row immediately above it. |
void |
setVersion(java.lang.String aName)
Overrides switch shape version to do layout on parent table. |
boolean |
sizesToFitChildren()
Editor method. |
void |
syncStructureWithShape(RMShape aShape)
The syncStructureWithShape() method sync's the column widths of receiver to those of given shape. |
java.lang.String |
toString()
Returns a string description of the table row. |
com.reportmill.archiver.RXElement |
toXML(com.reportmill.archiver.RXArchiver anArchiver)
XML archival. |
void |
undoCopy(java.lang.Object anObj)
Undo copy to perform table layout after undo. |
Methods inherited from class com.reportmill.shape.RMSwitchShape |
---|
acceptsChildren, acceptsMouse, alternateShapeInstance, clone, cloneDeep, getAlternates, getChildAnimator, getDefaultVersionName, getVersion, getVersion, getVersionKey, getVersionNames, hasAlternateVersions, hasMouseVersions, hasVersion, mouseEntered, mouseExited, removeVersion, rpgClone_super, rpgClone, rpgClone, setAlternates, setVersion, setVersionKey, setWidth, superSelectable |
Methods inherited from class com.reportmill.base.RMObject |
---|
didUndo, getAnimAttribute, getClassNameShort |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VersionStandard
public static final java.lang.String VersionFirstOnly
public static final java.lang.String VersionReprint
public static final java.lang.String VersionAlternate
public static final java.lang.String VersionTopNOthers
public static final java.lang.String VersionSplitHeader
public static int _moveHandle
Constructor Detail |
---|
public RMTableRow()
public RMTableRow(boolean isStructured)
Method Detail |
---|
public RMTable getTable()
public java.lang.String getTitle()
public boolean isStructured()
public void setStructured(boolean aFlag)
public boolean getSyncStructureWithRowAbove()
public void setSyncStructureWithRowAbove(boolean aFlag)
public boolean getSyncStructureWithAlternates()
public void setSyncStructureWithAlternates(boolean aFlag)
public RMText getColumn(int anIndex)
public int getNumberOfColumns()
public void setNumberOfColumns(int count)
public int getNumberOfChildrenToStayWith()
public void setNumberOfChildrenToStayWith(int aValue)
public boolean getReprintWhenWrapped()
public void setReprintWhenWrapped(boolean aFlag)
public boolean getPrintEvenIfGroupIsEmpty()
public void setPrintEvenIfGroupIsEmpty(boolean aFlag)
public boolean getMoveToBottom()
public void setMoveToBottom(boolean aFlag)
public float getMinSplitHeight()
public void setMinSplitHeight(float aValue)
public float getMinSplitRemainderHeight()
public void setMinSplitRemainderHeight(float aValue)
public void arrange()
public com.reportmill.shape.RMTableRowLayout getTableRowLayout()
public void syncStructureWithShape(RMShape aShape)
public RMTableRow getRowAbove()
public void addChild(RMShape aChild, int anIndex)
addChild
in class RMShape
public void setVersion(java.lang.String aName)
setVersion
in class RMSwitchShape
public boolean canBeUngrouped()
canBeUngrouped
in class RMShape
public boolean childrenSuperSelectImmediately()
childrenSuperSelectImmediately
in class RMShape
public boolean sizesToFitChildren()
sizesToFitChildren
in class RMShape
public void boundsChanged(RMShape aShape)
boundsChanged
in class RMShape
public boolean equals(java.lang.Object anObj)
equals
in class RMSwitchShape
public void copy(java.lang.Object anObj)
copy
in class RMSwitchShape
public void undoCopy(java.lang.Object anObj)
undoCopy
in class RMShape
public java.lang.Object rpgCloneBase()
rpgCloneBase
in class RMShape
public RMShape rpgClone(com.reportmill.shape.RMTableRPGAdder anAdder, com.reportmill.base.RMGroup group, java.lang.String suggestedVersion)
public void rpgCloneNotification(com.reportmill.base.ReportMill rm, RMShape copy)
rpgCloneNotification
in class RMShape
public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
toXML
in class RMSwitchShape
public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement)
fromXML
in class RMSwitchShape
public java.lang.String toString()
toString
in class RMShape
|
ReportMill 10 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |