ReportMill 7.0 API

com.reportmill.shape
Class RMTableGroup

java.lang.Object
  extended bycom.reportmill.foundation.RMObject
      extended bycom.reportmill.shape.RMShape
          extended bycom.reportmill.shape.RMTableGroup
All Implemented Interfaces:
java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

public class RMTableGroup
extends RMShape


Field Summary
 
Fields inherited from class com.reportmill.shape.RMShape
HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth
 
Constructor Summary
RMTableGroup()
          Creates a basic (empty) table group.
 
Method Summary
 boolean acceptsChildren()
          Editor method.
 boolean acceptsEvents()
          Editor method.
 boolean acceptsFirstEvent()
          Editor method.
 void addChildTable(RMTable aTable)
           
 void addChildTable(RMTable aTable, RMTable aParentTable)
           
 void addChildTable(RMTable aTable, RMTable aParentTable, RMTable afterThisTable)
           
 void addPeerTable(RMTable aTable)
           
 void addPeerTable(RMTable aTable, RMTable afterThisTable)
           
 boolean canBeUngrouped()
          Editor method.
 boolean childrenSuperSelectImmediately()
          Editor method.
 java.lang.Object clone()
          Standard implementation of Object clone.
 java.lang.Object fromXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement)
          XML unarchival.
 void fromXML(com.ribs.RXArchiver anArchiver, com.ribs.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)
           
 int getChildTableCount()
          Returns the number of top level tables in this table group.
 int getChildTableCount(java.lang.Object aTable)
           
 java.util.List getChildTables()
          Returns the list of top level tables for this table group.
 java.util.List getChildTables(java.lang.Object aTable)
           
 java.util.List getChildTables(java.lang.Object aTable, boolean create)
           
 java.lang.String getListKey()
          Returns the "List Key" associated with this shape.
 RMShape getListKeyShape()
          Returns the real shape used to resolve the list key for this shape.
 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.
 java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)
          Legacy archival.
 void makeTableChildOfTable(RMTable aTable, java.lang.Object newParent)
           
 void moveTable(RMTable aTable, int interval)
           
 void removeTable(RMTable aTable)
           
 RMShape rpgClone(com.reportmill.foundation.ReportMill aReportMill)
          A clone implementation that copies this shape and its children, performing data substituion as well.
 void rpgClonePreprocess(com.reportmill.foundation.ReportMill aReportMill)
          An rpgClone hook called by RMDocument on all children before anything else.
 void setMainTable(RMTable aTable)
          Sets the currently selected table.
 boolean superSelectable()
          Editor method.
 com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)
          XML archival.
 void toXML(com.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement, RMTable aParentTable)
          XML archival to recursively archive table group hierarchy.
 
Methods inherited from class com.reportmill.shape.RMShape
acceptsDragKeys, acceptsFormat, addChild, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, bringShapesToFront, childHitByPoint, childrenHitByPath, cloneDeep, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copy, copyShape, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, drawChildren, drawsFill, drawsStroke, dropKeyAtPoint, equals, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsOfPath, getBoundsOrigin, getBoundsSize, getBoundsSuperSelected, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildLast, getChildren, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKeyDeep, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, getPathInBounds, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getY, groupShapes, handleAtPoint, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, hitChildren, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, page, pageBreakMax, pageBreakPageMax, pageMax, put, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setBoundsOrigin, setBoundsOrigin, setBoundsOriginX, setBoundsOriginY, setBoundsSize, setBoundsSize, setChildAnimator, setChildren, setColor, setColor, setDrawsFill, setDrawsStroke, setEverythingStretches, setFill, setFill, setFont, setFormat, setHeight, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOnlyBottomAndRightMarginStretches, setOnlyTopAndRightMarginStretches, setOnlyWidthAndHeightStretches, setOpacity, setOrigin, setOrigin, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeDeep, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewXY, setSkewY, setStroke, setStroke, setStrokeColor, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectImmediately, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y
 
Methods inherited from class com.reportmill.foundation.RMObject
archiverClassName, 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)

getChildTable

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

getChildTables

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

getChildTables

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

getListKey

public java.lang.String getListKey()
Description copied from class: RMShape
Returns the "List Key" associated with this shape. A List Key is a key path that specifies a specific list of objects in the document's datasource.

Overrides:
getListKey in class RMShape

getListKeyShape

public RMShape getListKeyShape()
Description copied from class: RMShape
Returns the real shape used to resolve the list key for this shape. This seems bogus - might go soon.

Overrides:
getListKeyShape in class RMShape

addPeerTable

public void addPeerTable(RMTable aTable)

addPeerTable

public void addPeerTable(RMTable aTable,
                         RMTable afterThisTable)

addChildTable

public void addChildTable(RMTable aTable)

addChildTable

public void addChildTable(RMTable aTable,
                          RMTable aParentTable)

addChildTable

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

moveTable

public void moveTable(RMTable aTable,
                      int interval)

makeTableChildOfTable

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

removeTable

public void removeTable(RMTable aTable)

initWithArchiver

public java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)
Legacy archival.

Specified by:
initWithArchiver in interface com.reportmill.foundation.RMArchiver.Archiving
Overrides:
initWithArchiver in class RMShape

toXML

public com.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)
XML archival.

Overrides:
toXML in class RMShape

fromXML

public java.lang.Object fromXML(com.ribs.RXArchiver anArchiver,
                                com.ribs.RXElement anElement)
XML unarchival.

Overrides:
fromXML in class RMShape

toXML

public void toXML(com.ribs.RXArchiver anArchiver,
                  com.ribs.RXElement anElement,
                  RMTable aParentTable)
XML archival to recursively archive table group hierarchy.


fromXML

public void fromXML(com.ribs.RXArchiver anArchiver,
                    com.ribs.RXElement anElement,
                    RMTable aParentTable)
XML archival to recursively unarchive table group hierarchy.


rpgClonePreprocess

public void rpgClonePreprocess(com.reportmill.foundation.ReportMill aReportMill)
Description copied from class: RMShape
An rpgClone hook called by RMDocument on all children before anything else.

Overrides:
rpgClonePreprocess in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill aReportMill)
Description copied from class: RMShape
A clone implementation that copies this shape and its children, performing data substituion as well.

Overrides:
rpgClone in class RMShape

clone

public java.lang.Object clone()
Description copied from class: RMShape
Standard implementation of Object clone. Null's out shape's parent and children.

Overrides:
clone in class RMShape

superSelectable

public boolean superSelectable()
Description copied from class: RMShape
Editor method.

Overrides:
superSelectable in class RMShape

canBeUngrouped

public boolean canBeUngrouped()
Description copied from class: RMShape
Editor method.

Overrides:
canBeUngrouped in class RMShape

acceptsChildren

public boolean acceptsChildren()
Description copied from class: RMShape
Editor method.

Overrides:
acceptsChildren in class RMShape

childrenSuperSelectImmediately

public boolean childrenSuperSelectImmediately()
Description copied from class: RMShape
Editor method.

Overrides:
childrenSuperSelectImmediately in class RMShape

acceptsEvents

public boolean acceptsEvents()
Description copied from class: RMShape
Editor method.

Overrides:
acceptsEvents in class RMShape

acceptsFirstEvent

public boolean acceptsFirstEvent()
Description copied from class: RMShape
Editor method.

Overrides:
acceptsFirstEvent in class RMShape

ReportMill 7.0 API