com.reportmill.shape

Class RMTableGroup

java.lang.Object

com.reportmill.base.RMListenerList

com.reportmill.base.RMObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMTableGroup

All Implemented Interfaces:

DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMTableGroup
extends RMShape

This class manages a hierarchy 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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
RMTableGroup() Creates a basic (empty) table group.

Method Summary

Methods

Modifier and Type	Method and Description
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	childrenSuperSelectImmediately() Editor method - indicates that table group children (tables) super select immediately.
RMTableGroup	clone() Standard clone implementation.
RMTableGroup	cloneDeep() Clones all attributes of this shape with complete clones of its children as well.
RMShapeLayout	createLayout() Override to return a frame layout, so child tables are always exactly in bounds.
RMShape	createPartClone() Creates a new clone of this shape to hold multi-part children.
void	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, RMTable aParentTable) XML archival to recursively unarchive table group hierarchy.
java.lang.Object	fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
void	fromXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival - overridden to unarchive all child tables, recursively.
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<RMTable>	getChildTables() Returns the list of top level tables for this table group.
java.util.List<RMTable>	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.
java.lang.String	getDatasetKey() Returns the complete dataset key for the current main table (pre-pending dataset 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<RMTable>	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	paintShapeOver(java.awt.Graphics2D aGraphics) Paints table group button after child table has been drawn.
void	removeTable(RMTable aTable) This method removes a table from the table group.
void	setMainTable(RMTable aTable) Sets the currently selected table.
void	setReportMill(ReportMill aReportMill) Report generation method.
void	toXMLChildTables(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, RMTable aParentTable) XML archival to recursively archive table group hierarchy.
com.reportmill.archiver.RXElement	toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.
void	toXMLShapeChildren(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML archival - override to archive all child tables (not just visible one), recursively.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addAction, addActions, addBinding, addChild, addChild, addChild, addChild, addDeepChangeListener, addListener, addMouseListener, animUpdate, bounds, bringShapesToFront, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, divideShapeFromTop, doLayout, equals, fromXML, fromXMLShapeLayout, get, get, getAction, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestSize, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getImageFill, getLayout, getLayout, getLayoutInfo, getLineWidth, getMaskPath, getMaximumSize, getMaximumSizeProperty, getMaxX, getMaxY, getMinimumSize, getMinimumSizeProperty, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getPreferredSize, getPreferredSize, getPreferredSizeProperty, getPropertyNameMapped, getPropertyNames, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isHittable, isHittableChild, isLocked, isMaximumSizeSet, isMinimumSizeSet, isRoot, isRSS, isShowing, isUnderlined, isViewing, isVisible, isVisibleChild, layoutReset, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShape, paintShapeAll, paintShapeChildren, propertyChange, put, removeAction, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBestSize, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHover, setLayout, setLayoutInfo, setLineWidth, setLocked, setMaximumSize, setMinimumSize, setName, setOpacity, setOutline, setParent, setPreferredSize, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setShowing, setSize, setSize, setSizeP, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, superSelectable, toString, toXML, toXMLShapeLayout, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from class com.reportmill.base.RMListenerList

getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

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

getDatasetKey

public java.lang.String getDatasetKey()

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

Overrides:

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

paintShapeOver

public void paintShapeOver(java.awt.Graphics2D aGraphics)

Paints table group button after child table has been drawn.

Overrides:

paintShapeOver in class RMShape

createLayout

public RMShapeLayout createLayout()

Override to return a frame layout, so child tables are always exactly in bounds.

setReportMill

public void setReportMill(ReportMill aReportMill)

Report generation method.

Overrides:

setReportMill in class RMShape

createPartClone

public RMShape createPartClone()

Creates a new clone of this shape to hold multi-part children.

Overrides:

createPartClone in class RMShape

clone

public RMTableGroup clone()

Standard clone implementation.

Overrides:

clone in class RMShape

cloneDeep

public RMTableGroup cloneDeep()

Clones all attributes of this shape with complete clones of its children as well.

Overrides:

cloneDeep in class RMShape

toXMLShape

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

XML archival.

Overrides:

toXMLShape in class RMShape

toXMLShapeChildren

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

XML archival - override to archive all child tables (not just visible one), recursively.

Overrides:

toXMLShapeChildren in class RMShape

toXMLChildTables

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

XML archival to recursively archive table group hierarchy.

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 RMShape

fromXMLShapeChildren

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

XML unarchival - overridden to unarchive all child tables, recursively.

Overrides:

fromXMLShapeChildren in class RMShape

fromXML

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

XML archival to recursively unarchive table group hierarchy.

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

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

Overrides:

childrenSuperSelectImmediately in class RMShape