com.reportmill.shape

Class RMTableGroup

java.lang.Object

SnapObject

com.reportmill.shape.RMShape

com.reportmill.shape.RMParentShape

com.reportmill.shape.RMTableGroup

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener

public class RMTableGroup
extends RMParentShape

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.Align, RMTypes.AlignX, RMTypes.AlignY

Constructor Summary

Constructors

Constructor and Description
RMTableGroup()

Method Summary

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() Override to clone child tables.
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.
boolean	getStrokeOnTop() Override to paint table stroke on top.
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(RMShapePainter aPntr) Paints table group button after child table has been drawn.
void	removeTable(RMTable aTable) This method removes a table from the table group.
RMShape	rpgAll(ReportOwner anRptOwner, RMShape aParent) Override to set main table to first child table.
void	setMainTable(RMTable aTable) Sets the currently selected table.

Methods inherited from class com.reportmill.shape.RMParentShape

addChild, addChild, addChild, addChild, bringShapesToFront, divideShapeFromTop, fromXML, getBoundsOfChildren, getChild, getChildArray, getChildContaining, getChildCount, getChildLast, getChildren, getChildrenIntersecting, getChildrenWithClass, getChildrenWithClass, getChildWithClass, getChildWithName, getLayout, getNeedsLayout, getSourceURL, indexOfChild, isSourceURLSet, layout, relayout, removeChild, removeChild, removeChildren, sendShapesToBack, setHeight, setLayout, setNeedsLayout, setSourceURL, setWidth, toXML

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChildAnimator, getChildAnimator, getClipShape, getColor, getDatasetEntity, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPath, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isUnderlined, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShape, paintShapeAll, paintShapeChildren, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, rpgBindings, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMTableGroup

public RMTableGroup()

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(RMShapePainter aPntr)

Paints table group button after child table has been drawn.

Overrides:

paintShapeOver in class RMShape

getStrokeOnTop

public boolean getStrokeOnTop()

Override to paint table stroke on top.

Overrides:

getStrokeOnTop in class RMShape

rpgAll

public RMShape rpgAll(ReportOwner anRptOwner,
                      RMShape aParent)

Override to set main table to first child table.

Overrides:

rpgAll in class RMParentShape

clone

public RMTableGroup clone()

Standard clone implementation.

Overrides:

clone in class RMParentShape

cloneDeep

public RMTableGroup cloneDeep()

Override to clone child tables.

Overrides:

cloneDeep in class RMParentShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()

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

Overrides:

childrenSuperSelectImmediately in class RMShape