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:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

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	childrenSuperSelectImmediately() Editor method - states that children super-select immediately when table row is structured.
RMShape	cloneDeep(java.lang.String aVersion) A clone deep implementation that only clones the given version.
com.reportmill.shape.RMShapeLayout	createLayout() Override to provide custom layout.
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.
com.reportmill.shape.RMTableRPGAdder	getAdder() Returns the adder for this table row.
RMText	getColumn(int anIndex) Returns the column at the given index (assumes row is structured and column is RMText).
com.reportmill.base.RMGroup	getGroup() Returns the group for this table row.
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.
RMTableRow	getTemplate() Returns the template row for this table row rpg.
java.lang.String	getTitle() Returns the title for this table row in it's parent table.
boolean	isDetails() Returns whether this table row rpg is a details.
boolean	isHeader() Returns whether this table row rpg is a header.
boolean	isStructured() Returns whether this table row is structured.
boolean	isSummary() Returns whether this table row rpg is a summary.
void	paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g) Paints table row.
RMShape	rpgClone(com.reportmill.shape.RMTableRPGAdder anAdder, com.reportmill.base.RMGroup aGroup, java.lang.String suggestedVersion) RPG Clone (Version priorities: TopNOthers, suggested, custom, standard/alternate).
void	setHeightToFit() Overrides shape version to add performance optimization for structured table row.
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	toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.

Methods inherited from class com.reportmill.shape.RMSwitchShape

acceptsChildren, acceptsMouse, clone, cloneDeep, getAlternates, getAlternates, getChildAnimator, getDefaultVersionName, getVersion, getVersion, getVersionKey, getVersionNames, hasAlternateVersions, hasMouseVersions, hasVersion, removeVersion, setAlternates, setReportMill, setReportMill, setVersion, setVersionKey, setWidth, shapeHidden, shapeShown, superSelectable, toXMLShapeChildren

Methods inherited from class com.reportmill.shape.RMShape

addBinding, addChild, animUpdate, bounds, boundsChanged, bringShapesToFront, checkBindings, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, createPartClone, divideShapeFromEdge, divideShapeFromTop, doLayout, firePropertyChange, fromXML, fromXMLShapeChildren, get, getAction, getAncestor, getAncestorCount, getAncestorInCommon, getAnim, getAnim, getAnimator, getAnimator, getAspectMapped, getAspects, getAutosizeHeight, getAutosizing, getBinder, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDatasetKey, getDocument, getEffect, getFill, getFill, getFillCount, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getMaskPath, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getWidthToFit, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isLocked, isMouseDown, isMouseOver, isRoot, isShowing, isUnderlined, isValid, isViewing, isVisible, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeFromParent, repaint, repaint, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setOpacity, setOutline, setParent, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setVisible, setWidthToFit, setX, setXY, setXY, setXYP, setY, toXML, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

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

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

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

paintShape

public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
                       java.awt.Graphics2D g)

Paints table row.

Overrides:

paintShape in class RMSwitchShape

getAdder

public com.reportmill.shape.RMTableRPGAdder getAdder()

Returns the adder for this table row.

getGroup

public com.reportmill.base.RMGroup getGroup()

Returns the group for this table row.

getTemplate

public RMTableRow getTemplate()

Returns the template row for this table row rpg.

isHeader

public boolean isHeader()

Returns whether this table row rpg is a header.

isDetails

public boolean isDetails()

Returns whether this table row rpg is a details.

isSummary

public boolean isSummary()

Returns whether this table row rpg is a summary.

rpgClone

public RMShape rpgClone(com.reportmill.shape.RMTableRPGAdder anAdder,
                        com.reportmill.base.RMGroup aGroup,
                        java.lang.String suggestedVersion)

RPG Clone (Version priorities: TopNOthers, suggested, custom, standard/alternate).

setHeightToFit

public void setHeightToFit()

Overrides shape version to add performance optimization for structured table row.

Overrides:

setHeightToFit in class RMShape

createLayout

public com.reportmill.shape.RMShapeLayout createLayout()

Override to provide custom layout.

Overrides:

createLayout in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMSwitchShape

cloneDeep

public RMShape cloneDeep(java.lang.String aVersion)

A clone deep implementation that only clones the given version.

toXMLShape

public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                                    java.lang.Object anOwner)

XML archival.

Overrides:

toXMLShape in class RMSwitchShape

fromXMLShape

public java.lang.Object fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                     com.reportmill.archiver.RXElement anElement,
                                     java.lang.Object anOwner)

XML unarchival.

Overrides:

fromXMLShape in class RMSwitchShape

toString

public java.lang.String toString()

Returns a string description of the table row.

Overrides:

toString in class RMShape