RMTable (ReportMill 14 API)

java.lang.Object
- SnapObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMParentShape
    - - com.reportmill.shape.RMTable

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener
```
public class RMTable
extends RMParentShape
```
This RMShape subclass provides functionality to graphically represent a list of data in a ReportMill report. It also supports data manipulation such as grouping and sorting.

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
`RMTable()` Creates a plain table.
`RMTable(java.lang.String aDatasetKey)` Creates a table with given dataset key (and corresponding default grouping and details row).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChildWithTitle(RMTableRow aChild, int anIndex, java.lang.String aTitle)` Convenience to set a child title and add to the table.
`RMTableRow`	`addDetails(java.lang.String aKey)` Convenience to add details for grouping key.
`void`	`addGrouping(RMGrouping aGrouping, int anIndex)` Adds a given grouping to the table at the given grouping index.
`void`	`addGroupingKey(java.lang.String aKey, int anIndex)` Adds a grouping to the table for the given key string at the given grouping index.
`RMTableRow`	`addHeader(java.lang.String aKey)` Convenience to add header for grouping key.
`RMTableRow`	`addSummary(java.lang.String aKey)` Convenience to add summary for grouping key.
`boolean`	`childrenSuperSelectImmediately()` Editor method - indicates that children should super select immediately when split shape is super selected.
`RMTable`	`clone()` Standard clone implementation.
`RMShape`	`getChildWithTitle(java.lang.String aTitle)` Returns a specific child with the given name.
`int`	`getColumnCount()` Returns the number of columns that this table should be repeated over on the same page before paginating.
`double`	`getColumnSpacing()` Returns the space between a table that has more than one column (int printer points).
`java.lang.String`	`getDatasetKey()` Returns the dataset key associated with the table.
`java.lang.String`	`getFilterKey()` Returns the optional key chain expression string used to prune the table list derived from dataset key.
`RMGrouper`	`getGrouper()` Returns the grouper associated with the table.
`RMGrouping`	`getGrouping(int anIndex)` Returns the individual grouping at the given index.
`RMGrouping`	`getGrouping(java.lang.String aKey)` Returns the individual grouping that has the same key as the one given.
`RMGrouping`	`getGrouping(java.lang.String aKey, boolean doCreate, int anIndex)` Returns the individual grouping that has the same key as the one given, with option to create at index if missing.
`int`	`getGroupingCount()` Returns the number of groups in this table.
`int`	`getPageBreakGroupIndex()` Returns the index of the grouping in the grouper at which an explicit.
`int`	`getResizeBarAtPoint(RMPoint aPoint)` Returns the index of the resize bar that is hit by the given point.
`RMRect`	`getResizeBarBounds(int anIndex)` Returns the bounds rect of the resize bar for the child at the given index.
`RMTableRow`	`getRow(int anIndex)` Returns the specific table row at the given index.
`RMTableRow`	`getRow(java.lang.String aName)` Returns the specific table row with the given name.
`boolean`	`getStartingPageBreak()` Returns whether this table should always start on a new page (if in table group).
`boolean`	`getStrokeOnTop()` Override to paint table stroke on top.
`boolean`	`isPrintEvenIfGroupIsEmpty()` Returns whether table does printing even if no objects (which really depends on whether first row is a header that does this).
`void`	`moveGrouping(int fromIndex, int toIndex)` Moves the grouping at the first index so that it resides at the second index.
`void`	`paintShape(RMShapePainter aPntr)` Paints a table shape.
`void`	`paintShapeOver(RMShapePainter aPntr)` Paints stroke around table after all children have drawn.
`void`	`propertyChange(java.beans.PropertyChangeEvent anEvent)` Override to update rows when grouper changes and revalidate when child height changes.
`void`	`removeGrouping(RMGrouping aGrouping)` Removes the given grouping.
`RMShape`	`rpgAll(ReportOwner anOwner, RMShape aParent)` Report generation for table.
`void`	`setColumnCount(int aValue)` Sets the number of columns that this table should be repeated over on the same page before paginating.
`void`	`setColumnSpacing(double aValue)` Sets the space between a table that has more than one column (int printer points).
`void`	`setDatasetKey(java.lang.String aKeyPath)` Sets the dataset key associated with the table.
`void`	`setFilterKey(java.lang.String aKeyExpr)` Sets the optional key chain expression string used to prune the table list derived from dataset key.
`void`	`setGrouper(RMGrouper aGrouper)` Sets the grouper associated with the table.
`void`	`setPageBreakGroupIndex(int aValue)` Returns the index of the grouping in the grouper at which an explicit.
`void`	`setStartingPageBreak(boolean aFlag)` Sets whether this table should always start on a new page (if in table group).
`void`	`setTitleForChild(java.lang.String aNm1, java.lang.String aNm2)` Sets title for child of given name to new name.
`java.lang.String`	`toString()` Standard to string implementation (prints class name and shape bounds).

Methods inherited from class com.reportmill.shape.RMParentShape
addChild, addChild, addChild, addChild, bringShapesToFront, cloneDeep, 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, paintShapeAll, paintShapeChildren, 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, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RMTable
```
public RMTable()
```
    Creates a plain table.
  - RMTable
```
public RMTable(java.lang.String aDatasetKey)
```
    Creates a table with given dataset key (and corresponding default grouping and details row).
- Method Detail
  - getDatasetKey
```
public java.lang.String getDatasetKey()
```
    Returns the dataset key associated with the table.
    
    Overrides:
    
    getDatasetKey in class RMShape
  - setDatasetKey
```
public void setDatasetKey(java.lang.String aKeyPath)
```
    Sets the dataset key associated with the table.
  - getFilterKey
```
public java.lang.String getFilterKey()
```
    Returns the optional key chain expression string used to prune the table list derived from dataset key.
  - setFilterKey
```
public void setFilterKey(java.lang.String aKeyExpr)
```
    Sets the optional key chain expression string used to prune the table list derived from dataset key.
  - getGrouper
```
public RMGrouper getGrouper()
```
    Returns the grouper associated with the table.
  - setGrouper
```
public void setGrouper(RMGrouper aGrouper)
```
    Sets the grouper associated with the table.
  - getGroupingCount
```
public int getGroupingCount()
```
    Returns the number of groups in this table.
  - getGrouping
```
public RMGrouping getGrouping(int anIndex)
```
    Returns the individual grouping at the given index.
  - getGrouping
```
public RMGrouping getGrouping(java.lang.String aKey)
```
    Returns the individual grouping that has the same key as the one given.
  - getGrouping
```
public RMGrouping getGrouping(java.lang.String aKey,
                              boolean doCreate,
                              int anIndex)
```
    Returns the individual grouping that has the same key as the one given, with option to create at index if missing.
  - addGroupingKey
```
public void addGroupingKey(java.lang.String aKey,
                           int anIndex)
```
    Adds a grouping to the table for the given key string at the given grouping index.
  - addGrouping
```
public void addGrouping(RMGrouping aGrouping,
                        int anIndex)
```
    Adds a given grouping to the table at the given grouping index.
  - removeGrouping
```
public void removeGrouping(RMGrouping aGrouping)
```
    Removes the given grouping.
  - moveGrouping
```
public void moveGrouping(int fromIndex,
                         int toIndex)
```
    Moves the grouping at the first index so that it resides at the second index.
  - addHeader
```
public RMTableRow addHeader(java.lang.String aKey)
```
    Convenience to add header for grouping key.
  - addDetails
```
public RMTableRow addDetails(java.lang.String aKey)
```
    Convenience to add details for grouping key.
  - addSummary
```
public RMTableRow addSummary(java.lang.String aKey)
```
    Convenience to add summary for grouping key.
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Override to update rows when grouper changes and revalidate when child height changes.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
    
    Overrides:
    
    propertyChange in class RMShape
  - getPageBreakGroupIndex
```
public int getPageBreakGroupIndex()
```
    Returns the index of the grouping in the grouper at which an explicit.
  - setPageBreakGroupIndex
```
public void setPageBreakGroupIndex(int aValue)
```
    Returns the index of the grouping in the grouper at which an explicit.
  - getStartingPageBreak
```
public boolean getStartingPageBreak()
```
    Returns whether this table should always start on a new page (if in table group).
  - setStartingPageBreak
```
public void setStartingPageBreak(boolean aFlag)
```
    Sets whether this table should always start on a new page (if in table group).
  - isPrintEvenIfGroupIsEmpty
```
public boolean isPrintEvenIfGroupIsEmpty()
```
    Returns whether table does printing even if no objects (which really depends on whether first row is a header that does this).
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns that this table should be repeated over on the same page before paginating.
  - setColumnCount
```
public void setColumnCount(int aValue)
```
    Sets the number of columns that this table should be repeated over on the same page before paginating.
  - getColumnSpacing
```
public double getColumnSpacing()
```
    Returns the space between a table that has more than one column (int printer points).
  - setColumnSpacing
```
public void setColumnSpacing(double aValue)
```
    Sets the space between a table that has more than one column (int printer points).
  - getRow
```
public RMTableRow getRow(int anIndex)
```
    Returns the specific table row at the given index.
  - getRow
```
public RMTableRow getRow(java.lang.String aName)
```
    Returns the specific table row with the given name.
  - getChildWithTitle
```
public RMShape getChildWithTitle(java.lang.String aTitle)
```
    Returns a specific child with the given name.
  - setTitleForChild
```
public void setTitleForChild(java.lang.String aNm1,
                             java.lang.String aNm2)
```
    Sets title for child of given name to new name.
  - addChildWithTitle
```
public void addChildWithTitle(RMTableRow aChild,
                              int anIndex,
                              java.lang.String aTitle)
```
    Convenience to set a child title and add to the table.
  - getResizeBarBounds
```
public RMRect getResizeBarBounds(int anIndex)
```
    Returns the bounds rect of the resize bar for the child at the given index.
  - getResizeBarAtPoint
```
public int getResizeBarAtPoint(RMPoint aPoint)
```
    Returns the index of the resize bar that is hit by the given point.
  - childrenSuperSelectImmediately
```
public boolean childrenSuperSelectImmediately()
```
    Editor method - indicates that children should super select immediately when split shape is super selected.
    
    Overrides:
    
    childrenSuperSelectImmediately in class RMShape
  - rpgAll
```
public RMShape rpgAll(ReportOwner anOwner,
                      RMShape aParent)
```
    Report generation for table.
    
    Overrides:
    
    rpgAll in class RMParentShape
  - paintShape
```
public void paintShape(RMShapePainter aPntr)
```
    Paints a table shape.
    
    Overrides:
    
    paintShape in class RMShape
  - paintShapeOver
```
public void paintShapeOver(RMShapePainter aPntr)
```
    Paints stroke around table after all children have drawn.
    
    Overrides:
    
    paintShapeOver in class RMShape
  - getStrokeOnTop
```
public boolean getStrokeOnTop()
```
    Override to paint table stroke on top.
    
    Overrides:
    
    getStrokeOnTop in class RMShape
  - clone
```
public RMTable clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class RMParentShape
  - toString
```
public java.lang.String toString()
```
    Standard to string implementation (prints class name and shape bounds).
    
    Overrides:
    
    toString in class RMShape

Class RMTable

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMParentShape

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class java.lang.Object

Constructor Detail

RMTable

RMTable

Method Detail

getDatasetKey

setDatasetKey

getFilterKey

setFilterKey

getGrouper

setGrouper

getGroupingCount

getGrouping

getGrouping

getGrouping

addGroupingKey

addGrouping

removeGrouping

moveGrouping

addHeader

addDetails

addSummary

propertyChange

getPageBreakGroupIndex

setPageBreakGroupIndex

getStartingPageBreak

setStartingPageBreak

isPrintEvenIfGroupIsEmpty

getColumnCount

setColumnCount

getColumnSpacing

setColumnSpacing

getRow

getRow

getChildWithTitle

setTitleForChild

addChildWithTitle

getResizeBarBounds

getResizeBarAtPoint

childrenSuperSelectImmediately

rpgAll

paintShape

paintShapeOver

getStrokeOnTop

clone

toString