Package com.arbortext.epic.table

Interface TableColumn

All Superinterfaces:

TableObject

All Known Implementing Classes:

TableColumnImpl

public interface TableColumn
extends TableObject

Represents either a column of cells. Every cell is part of exactly one TableColumn.

Since:

Epic 4.3

Field Summary

Fields inherited from interface com.arbortext.epic.table.TableObject

ABOVE, BELOW, EXAMINE_ALL_COLSPECS, EXAMINE_TFOOT_COLSPECS, EXAMINE_TGROUP_COLSPECS, EXAMINE_THEAD_COLSPECS, HORIZONTAL, INVALID_TYPE, LEFT, RIGHT, TABLE_CELL, TABLE_COLUMN, TABLE_GRID, TABLE_OBJECT_STORE, TABLE_ROW, TABLE_RULE, TABLE_SET, TABLE_TILEPLEX, VERTICAL

Method Summary

Modifier and Type	Method	Description
TableCell	cell(int cellindex)	Returns a TableCell representing the cell at the given position in the column or a null pointer if that cell doesn't exist.
TableCell	getBottomCell()	The bottom cell in the column.
int	getCellCount()	The number of cells in the column.
TableObjectStore	getCells()	A TableObjectStore containing all the cells in the column.
TableColumn	getColumnLeft()	A TableColumn representing the column to the left of this one.
TableColumn	getColumnRight()	A TableColumn representing the column to the right of this one.
boolean	getFirst()	True if this column is the first column in the TableGrid.
int	getIndex()	The column number of this column in its grid.
boolean	getLast()	True if this column is the last column in the TableGrid.
TableRule	getRuleAbove()	A TableRule for the rule at the top end of the column.
TableRule	getRuleBelow()	A TableRule for the rule at the bottom end of the column.
TableObjectStore	getRulesLeft()	A TableObjectStore containing a TableRule for each rule on the left edge of this column.
TableObjectStore	getRulesRight()	A TableObjectStore containing a TableRule for each rule on the right edge of this column.
boolean	getSuppressed()	True if the entire column is suppressed because all of its cells are spanned and none of them is a spanning cell.
TableCell	getTopCell()	The top cell in the column.

Methods inherited from interface com.arbortext.epic.table.TableObject

clearAttributes, deleteAttribute, deletePrivateColspecs, deleteSpanspecs, getAttribute, getDocument, getElement, getGrid, getModifiable, getSet, getTableModel, getToid, getType, minimizeAttributes, renameColspec, renameColumns, renameSpanspec, setAttribute

Method Details

cell

TableCell cell(int cellindex)
        throws TableException

Returns a TableCell representing the cell at the given position in the column or a null pointer if that cell doesn't exist. The first cell is cell 1.

Parameters:

cellindex - The index of the cell desired. The first cell is cell 1.

Returns:

The cell.

Throws:

TableException - INVALID_INDEX_ERR: Raised if index is less than one or greater than the number cells in the column.

getTopCell

TableCell getTopCell()

The top cell in the column.

getBottomCell

TableCell getBottomCell()

The bottom cell in the column.

getCells

TableObjectStore getCells()

A TableObjectStore containing all the cells in the column.

getCellCount

int getCellCount()

The number of cells in the column.

getIndex

int getIndex()

The column number of this column in its grid. The left most column in the grid is column 1.

getColumnLeft

TableColumn getColumnLeft()

A TableColumn representing the column to the left of this one. If this is the left-most column it is a null pointer.

getColumnRight

TableColumn getColumnRight()

A TableColumn representing the column to the right of this one. If this is the right-most column it is a null pointer.

getRulesLeft

TableObjectStore getRulesLeft()

A TableObjectStore containing a TableRule for each rule on the left edge of this column.

getRulesRight

TableObjectStore getRulesRight()

A TableObjectStore containing a TableRule for each rule on the right edge of this column.

getRuleAbove

TableRule getRuleAbove()

A TableRule for the rule at the top end of the column.

getRuleBelow

TableRule getRuleBelow()

A TableRule for the rule at the bottom end of the column.

getFirst

boolean getFirst()

True if this column is the first column in the TableGrid.

getLast

boolean getLast()

True if this column is the last column in the TableGrid.

getSuppressed

boolean getSuppressed()

True if the entire column is suppressed because all of its cells are spanned and none of them is a spanning cell.