ReportMill 10 API

com.reportmill.shape
Class RMTableRow

java.lang.Object
  extended by com.reportmill.base.RMObject
      extended by com.reportmill.shape.RMShape
          extended by com.reportmill.shape.RMSwitchShape
              extended by com.reportmill.shape.RMTableRow
All Implemented Interfaces:
java.lang.Cloneable

public class RMTableRow
extends RMSwitchShape

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.shape.RMShape
addChild, bounds, boundsChanged, bringShapesToFront, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createLayout, delete, didChange, divideShapeFromEdge, divideShapeFromTop, doLayout, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDatasetKey, getDatasetKeyDeep, getDatasetKeyShape, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getListKey, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, 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, height, indexOf, indexOf, intersects, invalidate, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, isValid, layoutReset, mouseDragged, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, revalidate, rpgCloneChildren, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, 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, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, toXMLDeep, undoClone, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, willChange, willChange, x, y
 
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

VersionStandard

public static final java.lang.String VersionStandard
See Also:
Constant Field Values

VersionFirstOnly

public static final java.lang.String VersionFirstOnly
See Also:
Constant Field Values

VersionReprint

public static final java.lang.String VersionReprint
See Also:
Constant Field Values

VersionAlternate

public static final java.lang.String VersionAlternate
See Also:
Constant Field Values

VersionTopNOthers

public static final java.lang.String VersionTopNOthers
See Also:
Constant Field Values

VersionSplitHeader

public static final java.lang.String VersionSplitHeader
See Also:
Constant Field Values

_moveHandle

public static int _moveHandle
Constructor Detail

RMTableRow

public RMTableRow()
Creates a plain, unstructured table row.


RMTableRow

public RMTableRow(boolean isStructured)
Creates a table row allowing the user to specify whether it should be structured.

Method Detail

getTable

public RMTable getTable()
Returns the parent of this table row.


getTitle

public java.lang.String getTitle()
Returns the title for this table row in it's parent table.


isStructured

public boolean isStructured()
Returns whether this table row is structured.


setStructured

public void setStructured(boolean aFlag)
Sets whether this table row should be structured.


getSyncStructureWithRowAbove

public boolean getSyncStructureWithRowAbove()
Returns whether table row should synchronize the column widths of the row immediately above it.


setSyncStructureWithRowAbove

public void setSyncStructureWithRowAbove(boolean aFlag)
Sets whether table row should synchronize the column widths of the row immediately above it.


getSyncStructureWithAlternates

public boolean getSyncStructureWithAlternates()
Returns whether table row should synchronize the column widths of alternate versions.


setSyncStructureWithAlternates

public void setSyncStructureWithAlternates(boolean aFlag)
Sets whether table row should synchronize the column widths of alternate versions.


getColumn

public RMText getColumn(int anIndex)
Returns the column at the given index (assumes row is structured and column is RMText).


getNumberOfColumns

public int getNumberOfColumns()
Returns the number of columns in this table row (really just child count).


setNumberOfColumns

public void setNumberOfColumns(int count)
Sets the number of columns in this table row.


getNumberOfChildrenToStayWith

public int getNumberOfChildrenToStayWith()
Returns the number of children this table row needs to be accompanied by, if some children run off page bottom.


setNumberOfChildrenToStayWith

public void setNumberOfChildrenToStayWith(int aValue)
Sets the number of children this table row needs to be accompanied by, if some children run off page bottom.


getReprintWhenWrapped

public boolean getReprintWhenWrapped()
Returns whether this row is reprinted on a new page when it's children cross a page boundary.


setReprintWhenWrapped

public void setReprintWhenWrapped(boolean aFlag)
Sets whether this row is reprinted on a new page when it's children cross a page boundary.


getPrintEvenIfGroupIsEmpty

public boolean getPrintEvenIfGroupIsEmpty()
Returns whether this row should print even if it has no children (assumed to be a header/summary row).


setPrintEvenIfGroupIsEmpty

public void setPrintEvenIfGroupIsEmpty(boolean aFlag)
Returns whether this row should print even if it has no children (assumed to be a header/summary row).


getMoveToBottom

public boolean getMoveToBottom()
Returns whether this row should be moved to the bottom of the table during report generation.


setMoveToBottom

public void setMoveToBottom(boolean aFlag)
Sets whether this row should be moved to the bottom of the table during report generation.


getMinSplitHeight

public float getMinSplitHeight()
Returns the minimum distance in points from the top of the row that this row can split.


setMinSplitHeight

public void setMinSplitHeight(float aValue)
Sets the minimum distance in points from the top of the row that this row can split.


getMinSplitRemainderHeight

public float getMinSplitRemainderHeight()
Returns the minimum distance in points from the bottom of the row that this row can split.


setMinSplitRemainderHeight

public void setMinSplitRemainderHeight(float aValue)
Sets the minimum distance in points from the top of the row that this row can split.


arrange

public void arrange()
Tells table to do layout (obsolete).


getTableRowLayout

public com.reportmill.shape.RMTableRowLayout getTableRowLayout()
Returns the table row shape layout as a table row layout.


syncStructureWithShape

public void syncStructureWithShape(RMShape aShape)
The syncStructureWithShape() method sync's the column widths of receiver to those of given shape.


getRowAbove

public RMTableRow getRowAbove()
Returns the row above this one in the template.


addChild

public void addChild(RMShape aChild,
                     int anIndex)
Overrides standard shape method to turn off structuring if child isn't text.

Overrides:
addChild in class RMShape

setVersion

public void setVersion(java.lang.String aName)
Overrides switch shape version to do layout on parent table.

Overrides:
setVersion in class RMSwitchShape

canBeUngrouped

public boolean canBeUngrouped()
Editor method - states that this shape can't be ungrouped.

Overrides:
canBeUngrouped in class RMShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()
Editor method - states that children super-select immediately when table row is structured.

Overrides:
childrenSuperSelectImmediately in class RMShape

sizesToFitChildren

public boolean sizesToFitChildren()
Editor method.

Overrides:
sizesToFitChildren in class RMShape

boundsChanged

public void boundsChanged(RMShape aShape)
Notification method - relays out children when bounds are changed.

Overrides:
boundsChanged in class RMShape

equals

public boolean equals(java.lang.Object anObj)
Standard equals implementation.

Overrides:
equals in class RMSwitchShape

copy

public void copy(java.lang.Object anObj)
Standard copy implementation.

Overrides:
copy in class RMSwitchShape

undoCopy

public void undoCopy(java.lang.Object anObj)
Undo copy to perform table layout after undo.

Overrides:
undoCopy in class RMShape

rpgCloneBase

public java.lang.Object rpgCloneBase()
Override shape implementation to substitute RMTableRowRPG as the class for the rpgClone.

Overrides:
rpgCloneBase in class RMShape

rpgClone

public 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.


rpgCloneNotification

public void rpgCloneNotification(com.reportmill.base.ReportMill rm,
                                 RMShape copy)
Overrides shape implementation to suppress normal notification (will send after table row's version).

Overrides:
rpgCloneNotification in class RMShape

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
XML archival.

Overrides:
toXML in class RMSwitchShape

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)
XML unarchival.

Overrides:
fromXML in class RMSwitchShape

toString

public java.lang.String toString()
Returns a string description of the table row.

Overrides:
toString in class RMShape

ReportMill 10 API