sos.reports
Interface TierElement

All Superinterfaces:

Element

All Known Implementing Classes:

AbstractReport.AbstractTierElement, AbstractReport.DefaultTableElement.DefaultTierElement

public interface TierElement

extends Element

A portion of a report representing a row or column in a table.

Since:

1.0

See Also:

TableElement, CellElement

Method Summary

int	getIndex() Returns the index of this tier in its parent table.
CellElement	getPrototypeCellElement() Returns the prototypical cell element (or null, if none) for this tier.
TableElement	getTableElement() Returns this tier's parent table.
int	getType() Returns the type of this tier (either ROW or COLUMN).
boolean	isFooter() Returns true if this tier is a footer tier.
boolean	isHeader() Returns true if this tier is a header tier.

Methods inherited from interface sos.reports.Element

getAttributes, getName, getObject, getParentElement, getPrototypeObject, getReport, setParentElement

Method Detail

getIndex

public int getIndex()

Returns the index of this tier in its parent table.

Returns:

this tier's row or column index

getPrototypeCellElement

public CellElement getPrototypeCellElement()

Returns the prototypical cell element (or null, if none) for this tier.

Returns:

this tier's prototypical cell element

getTableElement

public TableElement getTableElement()

Returns this tier's parent table. This method is equivalent to invoking getParentElement and casting the result to TableElement.

Returns:

ths tier's table (may not be null)

getType

public int getType()

Returns the type of this tier (either ROW or COLUMN).

Returns:

ROW if this tier is a row; COLUMN if it is a column

isHeader

public boolean isHeader()

Returns true if this tier is a header tier.

Returns:

true if this tier is a header tier

isFooter

public boolean isFooter()

Returns true if this tier is a footer tier.

Returns:

true if this tier is a footer tier