sos.reports
Interface CellElement

All Superinterfaces:

Element

All Known Implementing Classes:

AbstractReport.AbstractCellElement, AbstractReport.DefaultTableElement.DefaultCellElement

public interface CellElement

extends Element

A portion of a report representing a rectangular region inside a table. The cell element always contains another report element. The content's parent element is always the enclosing cell element, and the cell element's parent element is always the enclosing table element.

Since:

1.0

See Also:

TableElement

Method Summary

Element	getContent() Returns the contents of this cell element.
TierElement	getFirstTier(int tierType) Returns the first row or column of this cell element.
TierElement	getLastTier(int tierType) Returns the last row or column of this cell element.
TableElement	getTableElement() Returns the table element to which this cell belongs.

Methods inherited from interface sos.reports.Element

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

Method Detail

getContent

public Element getContent()

Returns the contents of this cell element.

Returns:

the element contained in this cell element

getLastTier

public TierElement getLastTier(int tierType)
                        throws java.lang.IllegalArgumentException

Returns the last row or column of this cell element. If the specified type is ROW, the ending row is returned; if COLUMN, the ending column is returned.

Parameters:

tierType - type of tier (either ROW or COLUMN)

Returns:

the row (if ROW) or column (if COLUMN) at which this cell element ends (may not be null)

Throws:

java.lang.IllegalArgumentException - if tierType is not ROW or COLUMN

See Also:

getFirstTier(int)

getFirstTier

public TierElement getFirstTier(int tierType)
                         throws java.lang.IllegalArgumentException

Returns the first row or column of this cell element. If the specified type is ROW, the starting row is returned; if COLUMN, the starting column is returned.

Parameters:

tierType - type of tier (either ROW or COLUMN)

Returns:

the row (if ROW) or column (if COLUMN) at which this cell element starts (may not be null)

Throws:

java.lang.IllegalArgumentException - if tierType is not ROW or COLUMN

See Also:

getLastTier(int)

getTableElement

public TableElement getTableElement()

Returns the table element to which this cell belongs.

Returns:

this cell's table