com.reportmill.shape
Class RMTableGroup

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMTableGroup

All Implemented Interfaces:

java.lang.Cloneable

public class RMTableGroup
extends RMShape

This class manages a heirarchy of tables so that multiple tables can be configured to display in the same area of a given page. Each table will pick up exactly where the previous table ended.

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

RMTableGroup()
Creates a basic (empty) table group.

Method Summary

boolean	acceptsChildren() Editor method - inidcates that table group doesn't accept children.
void	addChildTable(RMTable aTable) Adds the given table as a child to the main table.
void	addChildTable(RMTable aTable, RMTable aParentTable) Adds the given table as a child of the given parent table.
void	addChildTable(RMTable aTable, RMTable aParentTable, RMTable afterThisTable) Adds the given table table as a child of the parent table (after the third given table).
void	addPeerTable(RMTable aTable) Adds the given table to the main table's list of peers.
void	addPeerTable(RMTable aTable, RMTable afterThisTable) Adds the given table as a peer, and just after, the second given table.
boolean	canBeUngrouped() Editor method - indicates that table group can't be ungrouped.
boolean	childrenSuperSelectImmediately() Edtior method - indicates that table group children (tables) super select immediately.
java.lang.Object	clone() Standard clone implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
void	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, RMTable aParentTable) XML archival to recursively unarchive table group hierarchy.
RMTable	getChildTable(int anIndex) Returns the top level table at the given index for this table group.
RMTable	getChildTable(java.lang.Object aTable, int anIndex) Returns the specific child table of the given table at the given index.
int	getChildTableCount() Returns the number of top level tables in this table group.
int	getChildTableCount(java.lang.Object aTable) Returns the number of child tables for the given parent table.
java.util.List	getChildTables() Returns the list of top level tables for this table group.
java.util.List	getChildTables(java.lang.Object aTable) Returns the list of child tables for the given table.
java.util.List	getChildTables(java.lang.Object aTable, boolean create) Returns the list of child tables for the given table, creating the list if requested.
RMShape	getDatasetKeyShape() Returns the main table.
java.lang.String	getListKey() Returns the complete list key for the current main table (pre-pending list keys of parents).
RMTable	getMainTable() Returns the currently selected table.
RMTable	getParentTable(RMTable aTable) Returns the parent of the given table.
RMTable	getPeerTableNext(RMTable aTable) Returns the next peer table of the given table.
RMTable	getPeerTablePrevious(RMTable aTable) Returns the previous peer table of the given table.
java.util.List	getPeerTables(RMTable aTable) Returns the list of peer tables for a given table.
int	indexOf(RMTable aTable) Returns the index of the given table in its parent's child tables list.
void	makeTableChildOfTable(RMTable aTable, java.lang.Object newParent) This method moves a table to a new parent (used for Move In and Move Out menus).
void	moveTable(RMTable aTable, int interval) This method moves a given table up or down in its peer list (used for Move Up & Move Down menus).
void	removeTable(RMTable aTable) This method removes a table from the table group.
RMShape	rpgClone(com.reportmill.base.ReportMill aReportMill) Report generation method.
void	rpgClonePreprocess(com.reportmill.base.ReportMill aReportMill) Report generation method.
void	setMainTable(RMTable aTable) Sets the currently selected table.
boolean	superSelectable() Editor method - indicates that table group is super selectable.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML archival.
void	toXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, RMTable aParentTable) XML archival to recursively archive table group hierarchy.
void	toXMLDeep(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML archival - override to suppress archival of children.

Methods inherited from class com.reportmill.shape.RMShape

acceptsMouse, addChild, addChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copy, copyShape, createLayout, delete, didChange, divideShapeFromEdge, divideShapeFromTop, doLayout, equals, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDatasetKey, getDatasetKeyDeep, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, 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, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, revalidate, rpgCloneBase, rpgCloneChildren, rpgCloneNotification, 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, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, toString, undoClone, undoCopy, 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

Constructor Detail

RMTableGroup

public RMTableGroup()

Creates a basic (empty) table group.

Method Detail

getMainTable

public RMTable getMainTable()

Returns the currently selected table.

setMainTable

public void setMainTable(RMTable aTable)

Sets the currently selected table.

getParentTable

public RMTable getParentTable(RMTable aTable)

Returns the parent of the given table.

indexOf

public int indexOf(RMTable aTable)

Returns the index of the given table in its parent's child tables list.

getPeerTables

public java.util.List getPeerTables(RMTable aTable)

Returns the list of peer tables for a given table.

getPeerTablePrevious

public RMTable getPeerTablePrevious(RMTable aTable)

Returns the previous peer table of the given table.

getPeerTableNext

public RMTable getPeerTableNext(RMTable aTable)

Returns the next peer table of the given table.

getChildTableCount

public int getChildTableCount()

Returns the number of top level tables in this table group.

getChildTable

public RMTable getChildTable(int anIndex)

Returns the top level table at the given index for this table group.

getChildTables

public java.util.List getChildTables()

Returns the list of top level tables for this table group.

getChildTableCount

public int getChildTableCount(java.lang.Object aTable)

Returns the number of child tables for the given parent table.

getChildTable

public RMTable getChildTable(java.lang.Object aTable,
                             int anIndex)

Returns the specific child table of the given table at the given index.

getChildTables

public java.util.List getChildTables(java.lang.Object aTable)

Returns the list of child tables for the given table.

getChildTables

public java.util.List getChildTables(java.lang.Object aTable,
                                     boolean create)

Returns the list of child tables for the given table, creating the list if requested.

getListKey

public java.lang.String getListKey()

Returns the complete list key for the current main table (pre-pending list keys of parents).

Overrides:

getListKey in class RMShape

getDatasetKeyShape

public RMShape getDatasetKeyShape()

Returns the main table.

Overrides:

getDatasetKeyShape in class RMShape

addPeerTable

public void addPeerTable(RMTable aTable)

Adds the given table to the main table's list of peers.

addPeerTable

public void addPeerTable(RMTable aTable,
                         RMTable afterThisTable)

Adds the given table as a peer, and just after, the second given table.

addChildTable

public void addChildTable(RMTable aTable)

Adds the given table as a child to the main table.

addChildTable

public void addChildTable(RMTable aTable,
                          RMTable aParentTable)

Adds the given table as a child of the given parent table.

addChildTable

public void addChildTable(RMTable aTable,
                          RMTable aParentTable,
                          RMTable afterThisTable)

Adds the given table table as a child of the parent table (after the third given table).

moveTable

public void moveTable(RMTable aTable,
                      int interval)

This method moves a given table up or down in its peer list (used for Move Up & Move Down menus).

makeTableChildOfTable

public void makeTableChildOfTable(RMTable aTable,
                                  java.lang.Object newParent)

This method moves a table to a new parent (used for Move In and Move Out menus).

removeTable

public void removeTable(RMTable aTable)

This method removes a table from the table group.

rpgClonePreprocess

public void rpgClonePreprocess(com.reportmill.base.ReportMill aReportMill)

Report generation method.

Overrides:

rpgClonePreprocess in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill aReportMill)

Report generation method.

Overrides:

rpgClone in class RMShape

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class RMShape

toXML

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

XML archival.

Overrides:

toXML in class RMShape

toXMLDeep

public void toXMLDeep(com.reportmill.archiver.RXArchiver anArchiver,
                      com.reportmill.archiver.RXElement anElement)

XML archival - override to suppress archival of children.

Overrides:

toXMLDeep in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape

toXML

public void toXML(com.reportmill.archiver.RXArchiver anArchiver,
                  com.reportmill.archiver.RXElement anElement,
                  RMTable aParentTable)

XML archival to recursively archive table group hierarchy.

fromXML

public void fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                    com.reportmill.archiver.RXElement anElement,
                    RMTable aParentTable)

XML archival to recursively unarchive table group hierarchy.

superSelectable

public boolean superSelectable()

Editor method - indicates that table group is super selectable.

Overrides:

superSelectable in class RMShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

Edtior method - indicates that table group children (tables) super select immediately.

Overrides:

childrenSuperSelectImmediately in class RMShape

canBeUngrouped

public boolean canBeUngrouped()

Editor method - indicates that table group can't be ungrouped.

Overrides:

canBeUngrouped in class RMShape

acceptsChildren

public boolean acceptsChildren()

Editor method - inidcates that table group doesn't accept children.

Overrides:

acceptsChildren in class RMShape