com.businessobjects.rebean.wi
Interface Table

All Superinterfaces:
Representation, TableFormBase, Unit
All Known Subinterfaces:
CrossTable, SimpleTable

public interface Table
extends TableFormBase

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Representation of any kind of table.

Note that since version 6.5.0, a number of methods from this class have been moved to the new super class TableFormBase.


Method Summary
 Decoration getBodyDecoration()
          Returns the default graphical attributes of all body cells.
 Decoration getFooterDecoration()
          Returns the default graphical attributes of all footer cells.
 BlockCalculation getHBlockCalculation(TableCell cell)
          Returns all horizontal calculations for a given cell in this table.
 Decoration getHeaderDecoration()
          Returns the default graphical attributes of all header cells.
 BlockCalculation getVBlockCalculation(TableCell cell)
          Returns all verctical calculations for a given cell in this table.
 boolean isFooterOnEveryPage()
          Checks wheather the footer (when visible, see Table.isFooterVisible()) should be repeated on every page (default is false).
 boolean isFooterVisible()
          Checks if the footer cells are visible or not.
 boolean isHeaderOnEveryPage()
          Checks wheather the header (when visible, see Table.isHeaderVisible()) should be repeated on every page (default is true).
 boolean isHeaderVisible()
          Checks if the header cells are visible or not.
 void setFooterOnEveryPage(boolean b)
          Changes wheather the footer (when visible, see Table.isFooterVisible()) should be repeated on every page.
 void setFooterVisible(boolean b)
          Displays or hides the footer cells.
 void setHeaderOnEveryPage(boolean b)
          Changes wheather the header (when visible, see Table.isHeaderVisible()) should be repeated on every page.
 void setHeaderVisible(boolean b)
          Displays or hides the header cells.
 
Methods inherited from interface com.businessobjects.rebean.wi.TableFormBase
getAlternateColor, getAlternateColorFrequency, getBodyTableDecoration, getCellPadding, getCellSpacing, getTableCell, setAlternateColor, setCellPadding, setCellSpacing
 
Methods inherited from interface com.businessobjects.rebean.wi.Representation
getBlock, getType, setType
 
Methods inherited from interface com.businessobjects.rebean.wi.Unit
getUnit, setUnit
 

Method Detail

getHeaderDecoration

Decoration getHeaderDecoration()
Returns the default graphical attributes of all header cells.

Returns:
the default graphical attributes of all header cells

getBodyDecoration

Decoration getBodyDecoration()
Returns the default graphical attributes of all body cells.

Returns:
the default graphical attributes of all body cells

getFooterDecoration

Decoration getFooterDecoration()
Returns the default graphical attributes of all footer cells.

Returns:
the default graphical attributes of all footer cells

isHeaderVisible

boolean isHeaderVisible()
Checks if the header cells are visible or not.

Returns:
true when the header cells are visible (default is true)

setHeaderVisible

void setHeaderVisible(boolean b)
Displays or hides the header cells.

Parameters:
b - when true, the header cells will be shown

isFooterVisible

boolean isFooterVisible()
Checks if the footer cells are visible or not.

Returns:
true when the footer cells are visible (default is true)

setFooterVisible

void setFooterVisible(boolean b)
Displays or hides the footer cells.

Parameters:
b - when true, the footer cells will be shown

isHeaderOnEveryPage

boolean isHeaderOnEveryPage()
Checks wheather the header (when visible, see Table.isHeaderVisible()) should be repeated on every page (default is true).

Returns:
true when the table header will be repeated on every page the table appears on

setHeaderOnEveryPage

void setHeaderOnEveryPage(boolean b)
Changes wheather the header (when visible, see Table.isHeaderVisible()) should be repeated on every page.

Parameters:
b - when true, the table header will be repeated on every page the table appears on

isFooterOnEveryPage

boolean isFooterOnEveryPage()
Checks wheather the footer (when visible, see Table.isFooterVisible()) should be repeated on every page (default is false).

Returns:
true when the table footer will be repeated on every page the table appears on

setFooterOnEveryPage

void setFooterOnEveryPage(boolean b)
Changes wheather the footer (when visible, see Table.isFooterVisible()) should be repeated on every page.

Parameters:
b - when true, the table footer will be repeated on every page the table appears on

getHBlockCalculation

BlockCalculation getHBlockCalculation(TableCell cell)
Returns all horizontal calculations for a given cell in this table.

Parameters:
cell - the cell for which to return a BlockCalculation instance
Returns:
a block calculation object allowing to view, add or remove calculations to this cell, or null when no calculations are possible for this cell (for example, when it is empty, contains a constant text or when there are no calculations possible in this direction for the given table cell)
Throws:
java.lang.NullPointerException - when cell is null
Since:
6.1

getVBlockCalculation

BlockCalculation getVBlockCalculation(TableCell cell)
Returns all verctical calculations for a given cell in this table.

Parameters:
cell - the cell for which to return a BlockCalculation instance
Returns:
a block calculation object allowing to view, add or remove calculations to this cell, or null when no calculations are possible for this cell (for example, when it is empty, contains a constant text or when there are no calculations possible in this direction for the given table cell)
Throws:
java.lang.NullPointerException - when cell is null
Since:
6.1