RMTableRPGAdder (ReportMill 13 API)

java.lang.Object
- com.reportmill.shape.RMTableRPGAdder

Direct Known Subclasses:

RMTableRPGAdderDetails, RMTableRPGAdderHeader, RMTableRPGAdderSummary, RMTableRPGAdderTable
```
public class RMTableRPGAdder
extends java.lang.Object
```
An object responsible for adding a row to a table. There ends up being a chain of these to add all the rows to a table page, each linked to a next and a previous. The adders also end up acting like iterators when adding child adders - iterators than can be stopped and restarted (when a page end or page break is hit) and even rewound to handle orphan constraints.

Constructor Summary

Constructors
Constructor and Description

RMTableRPGAdder(RMTableRPG aTableRPG, RMTableRPGAdder anAdder)
Creates a new row adder.

Constructors
Constructor and Description
`RMTableRPGAdder(RMTableRPG aTableRPG, RMTableRPGAdder anAdder)` Creates a new row adder.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAdder(RMTableRPGAdder anAdder)` Adds an adder to the adders list.
`boolean`	`addRow(RMTableRow aRow)` Adds the given table row to this table page.
`boolean`	`addRows()` Adds rows.
`boolean`	`addSummaryRows()` Do add summary.
`void`	`childDidReset(RMTableRPGAdder anAdder)` Resets the given child adder.
`void`	`doStayWithCheck()` Do stay-with widow orphan check.
`RMTableRPGAdder`	`getAdder(int anIndex)` Returns the specific adder at the given index.
`int`	`getAdderCount()` Returns the number of child adders created by this adder.
`RMTableRPGAdder`	`getAdderLast()` Returns the last child adder.
`RMGroup`	`getGroup()` Returns the group.
`RMTableRPGAdderHeader`	`getHeaderAdder()` Returns the first header adder from up the previous adder chain.
`int`	`getRemainingRowCount(int aMax)` Returns the number of rows left to be added by this row.
`ReportMill`	`getReportMill()` Returns the reportmill.
`RMTableRow`	`getRow()` Returns the row template this adder used to add a row.
`RMTableRow`	`getRowRPG()` Returns the row actually added by this adder (null if none).
`int`	`getRunningRowCount(int aMax)` Returns the number of rows that have been added by child adders.
`int`	`getStayWithCount()` Returns the number of rows this adder's added row wants to stay with.
`RMTable`	`getTable()` Returns the table.
`RMTableRPG`	`getTableRPG()` Returns the table rpg.
`RMTableRPGAdder`	`getTopAdder()` Returns the first adder from up the previous adder chain.
`RMTableRPGAdderHeader`	`getTopHeaderAdder()` Returns the table top header adder.
`boolean`	`isDone()` Returns whether adder is done adding rows.
`void`	`resetAdder()` Resets this adder to it's state before add rows was called.
`RMTableRow`	`sizeAndSplitPartialRow()` Splits the given row at the point that it overlaps its next neighbor or row bottom.

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

- Constructor Detail
  - RMTableRPGAdder
```
public RMTableRPGAdder(RMTableRPG aTableRPG,
               RMTableRPGAdder anAdder)
```
    Creates a new row adder.
- Method Detail
  - getTableRPG
```
public RMTableRPG getTableRPG()
```
    Returns the table rpg.
  - getRow
```
public RMTableRow getRow()
```
    Returns the row template this adder used to add a row.
  - getRowRPG
```
public RMTableRow getRowRPG()
```
    Returns the row actually added by this adder (null if none).
  - getReportMill
```
public ReportMill getReportMill()
```
    Returns the reportmill.
  - getTable
```
public RMTable getTable()
```
    Returns the table.
  - getGroup
```
public RMGroup getGroup()
```
    Returns the group.
  - getTopAdder
```
public RMTableRPGAdder getTopAdder()
```
    Returns the first adder from up the previous adder chain.
  - getHeaderAdder
```
public RMTableRPGAdderHeader getHeaderAdder()
```
    Returns the first header adder from up the previous adder chain.
  - getTopHeaderAdder
```
public RMTableRPGAdderHeader getTopHeaderAdder()
```
    Returns the table top header adder.
  - getAdderCount
```
public int getAdderCount()
```
    Returns the number of child adders created by this adder.
  - getAdder
```
public RMTableRPGAdder getAdder(int anIndex)
```
    Returns the specific adder at the given index.
  - getAdderLast
```
public RMTableRPGAdder getAdderLast()
```
    Returns the last child adder.
  - addAdder
```
public void addAdder(RMTableRPGAdder anAdder)
```
    Adds an adder to the adders list.
  - resetAdder
```
public void resetAdder()
```
    Resets this adder to it's state before add rows was called.
  - childDidReset
```
public void childDidReset(RMTableRPGAdder anAdder)
```
    Resets the given child adder.
  - isDone
```
public boolean isDone()
```
    Returns whether adder is done adding rows.
  - getStayWithCount
```
public int getStayWithCount()
```
    Returns the number of rows this adder's added row wants to stay with.
  - addRows
```
public boolean addRows()
```
    Adds rows.
  - addSummaryRows
```
public boolean addSummaryRows()
```
    Do add summary.
  - addRow
```
public boolean addRow(RMTableRow aRow)
```
    Adds the given table row to this table page.
  - doStayWithCheck
```
public void doStayWithCheck()
```
    Do stay-with widow orphan check.
  - getRunningRowCount
```
public int getRunningRowCount(int aMax)
```
    Returns the number of rows that have been added by child adders.
    
    Parameters:
    aMax - A performance optimization to short circuit if count exceeds a number we're looking for.
  - getRemainingRowCount
```
public int getRemainingRowCount(int aMax)
```
    Returns the number of rows left to be added by this row.
    
    Parameters:
    aMax - A performance optimization to short circuit if count exceeds a number we're looking for.
  - sizeAndSplitPartialRow
```
public RMTableRow sizeAndSplitPartialRow()
```
    Splits the given row at the point that it overlaps its next neighbor or row bottom.

Class RMTableRPGAdder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RMTableRPGAdder

Method Detail

getTableRPG

getRow

getRowRPG

getReportMill

getTable

getGroup

getTopAdder

getHeaderAdder

getTopHeaderAdder

getAdderCount

getAdder

getAdderLast

addAdder

resetAdder

childDidReset

isDone

getStayWithCount

addRows

addSummaryRows

addRow

doStayWithCheck

getRunningRowCount

getRemainingRowCount

sizeAndSplitPartialRow