Package com.reportmill.shape
Class RMTableRow
- java.lang.Object
-
- com.reportmill.base.RMObject
-
- com.reportmill.shape.RMShape
-
- com.reportmill.shape.RMSwitchShape
-
- com.reportmill.shape.RMTableRow
-
- All Implemented Interfaces:
RMArchiver.Archiving
,java.lang.Cloneable
public class RMTableRow extends RMSwitchShape
This class models a table row in a table.
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(RMShape aChild, int anIndex)
Overrides standard shape method to turn off structuring if child isn't text.void
arrange()
Recalcs column widths to fill table row width.void
arrangeWithShape(RMShape aShape)
Recalcs column widths to fill table row width.void
boundsChanged(RMShape shape)
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(RXArchiver anArchiver, 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.java.lang.String
getTitle()
Returns the title for this table row in it's parent table.java.lang.Object
initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.boolean
isStructured()
Returns whether this table row is structured.RMShape
rpgClone(ReportMill rm, RMGroup group, java.lang.String suggestedVersion)
This rpgClone method hands things off to RMTableRowRPG.java.lang.Object
rpgCloneBase()
This rpgCloneBase over-ride is used to substitute RMTableRowRPG as the class for the rpgClone.void
rpgCloneNotification(ReportMill rm, RMShape copy)
Overrides shape method 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
setStructured(boolean aFlag, boolean fixColumns)
Sets whether this table row should be structured, with an option to re-layout children.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.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.RXElement
toXML(RXArchiver anArchiver)
XML archival.protected void
transferAttributes(RMSwitchShape toShape)
Overrides switch shape method to specify additional attributes to be transferred when setVersion is called.-
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, rpgClone, setAlternates, setVersion, setVersion, setVersionKey, setWidthDeep, superSelectable
-
Methods inherited from class com.reportmill.shape.RMShape
acceptsDragKeys, acceptsFormat, addChild, addChildBelowLastChild, 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, 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, rpgCloneChildren, rpgCloneConclude, 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, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y
-
Methods inherited from class com.reportmill.base.RMObject
didUndo, getAnimAttribute, getClassNameShort
-
-
-
-
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
-
-
Method Detail
-
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.
-
setStructured
public void setStructured(boolean aFlag, boolean fixColumns)
Sets whether this table row should be structured, with an option to re-layout children.
-
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()
Recalcs column widths to fill table row width.
-
arrangeWithShape
public void arrangeWithShape(RMShape aShape)
Recalcs column widths to fill table row width.
-
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.
-
transferAttributes
protected void transferAttributes(RMSwitchShape toShape)
Overrides switch shape method to specify additional attributes to be transferred when setVersion is called.- Overrides:
transferAttributes
in classRMSwitchShape
-
rpgCloneBase
public java.lang.Object rpgCloneBase()
This rpgCloneBase over-ride is used to substitute RMTableRowRPG as the class for the rpgClone.- Overrides:
rpgCloneBase
in classRMShape
-
rpgClone
public RMShape rpgClone(ReportMill rm, RMGroup group, java.lang.String suggestedVersion)
This rpgClone method hands things off to RMTableRowRPG.
-
rpgCloneNotification
public void rpgCloneNotification(ReportMill rm, RMShape copy)
Overrides shape method to suppress normal notification (will send after table row's version).- Overrides:
rpgCloneNotification
in classRMShape
-
equals
public boolean equals(java.lang.Object anObj)
Standard equals implementation.- Overrides:
equals
in classRMSwitchShape
-
copy
public void copy(java.lang.Object anObj)
Standard copy implementation.- Overrides:
copy
in classRMSwitchShape
-
canBeUngrouped
public boolean canBeUngrouped()
Editor method - states that this shape can't be ungrouped.- Overrides:
canBeUngrouped
in classRMShape
-
childrenSuperSelectImmediately
public boolean childrenSuperSelectImmediately()
Editor method - states that children super-select immediately when table row is structured.- Overrides:
childrenSuperSelectImmediately
in classRMShape
-
sizesToFitChildren
public boolean sizesToFitChildren()
Editor method.- Overrides:
sizesToFitChildren
in classRMShape
-
boundsChanged
public void boundsChanged(RMShape shape)
Notification method - relays out children when bounds are changed.- Overrides:
boundsChanged
in classRMShape
-
toXML
public RXElement toXML(RXArchiver anArchiver)
XML archival.- Overrides:
toXML
in classRMSwitchShape
-
fromXML
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
XML unarchival.- Overrides:
fromXML
in classRMSwitchShape
-
initWithArchiver
public java.lang.Object initWithArchiver(RMArchiver anArchiver)
Legacy unarchival.- Specified by:
initWithArchiver
in interfaceRMArchiver.Archiving
- Overrides:
initWithArchiver
in classRMSwitchShape
-
-