fop 0.92beta

org.apache.fop.layoutmgr.table
Class TableRowIterator

java.lang.Object
  extended byorg.apache.fop.layoutmgr.table.TableRowIterator

public class TableRowIterator
extends java.lang.Object

Iterator that lets the table layout manager step over all rows of a table.

Note: This class is not thread-safe.


Field Summary
static int BODY
          Selects the list of table-body elements for iteration.
static int FOOTER
          Selects the table-footer element for iteration.
static int HEADER
          Selects the table-header element for iteration.
protected  Table table
          The table on with this instance operates.
 
Constructor Summary
TableRowIterator(Table table, ColumnSetup columns, int what)
          Creates a new TableRowIterator.
 
Method Summary
 void backToPreviousRow()
          Sets the iterator to the previous row.
 EffRow getCachedRow(int index)
          Returns a cached effective row.
 EffRow getFirstRow()
          Returns the first effective row.
 EffRow getLastRow()
          Returns the last effective row.
 EffRow getNextRow()
          Retuns the next effective row.
 EffRow[] getNextRowGroup()
          Returns the next row group if any.
 void prefetchAll()
          Preloads the whole table.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BODY

public static final int BODY
Selects the list of table-body elements for iteration.

See Also:
Constant Field Values

HEADER

public static final int HEADER
Selects the table-header element for iteration.

See Also:
Constant Field Values

FOOTER

public static final int FOOTER
Selects the table-footer element for iteration.

See Also:
Constant Field Values

table

protected Table table
The table on with this instance operates.

Constructor Detail

TableRowIterator

public TableRowIterator(Table table,
                        ColumnSetup columns,
                        int what)
Creates a new TableRowIterator.

Parameters:
table - the table to iterate over
columns - the column setup for the table
what - indicates what part of the table to iterate over (HEADER, FOOTER, BODY)
Method Detail

prefetchAll

public void prefetchAll()

Preloads the whole table.

Note:This is inefficient for large tables.


getNextRowGroup

public EffRow[] getNextRowGroup()
Returns the next row group if any. A row group in this context is the minimum number of consecutive rows which contains all spanned grid units of its cells.

Returns:
the next row group, or null

getNextRow

public EffRow getNextRow()
Retuns the next effective row.

Returns:
the requested effective row.

backToPreviousRow

public void backToPreviousRow()
Sets the iterator to the previous row.


getFirstRow

public EffRow getFirstRow()
Returns the first effective row.

Returns:
the requested effective row.

getLastRow

public EffRow getLastRow()

Returns the last effective row.

Note:This is inefficient for large tables because the whole table if preloaded.

Returns:
the requested effective row.

getCachedRow

public EffRow getCachedRow(int index)
Returns a cached effective row.

Parameters:
index - index of the row (zero-based)
Returns:
the requested effective row

fop 0.92beta

Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.