Package com.arbortext.epic.table

Interface TableSet

All Superinterfaces:

TableObject

All Known Implementing Classes:

TableSetImpl

public interface TableSet
extends TableObject

A TableSet is a collection of one or more TableGrids, each of which is a rectangular array of TableCells

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
TableGrid	addGrid(int columns, int rows)	Method overload which omits the last 2 parameters.
TableGrid	addGrid(int columns, int rows, TableGrid refGrid)	Method overload which omits the last parameter.
TableGrid	addGrid(int columns, int rows, TableGrid refGrid, boolean addBefore)	Adds an empty grid to the set.
void	deleteGrid(TableGrid grid)
void	deleteTitle()	Delete the title for this table set.
int	getGridCount()	The number of grids in the set.
TableObjectStore	getGrids()	A list of all the TableGrids in the TableSet.
Range	getMarkupRange()	Returns a Range that selects all of the markup in the table.
String	getTitle()	The table's title (or caption) for table models that define one.
TableGrid	grid(int gridindex)	Returns a grid given its index.
TableGrid	insertGrid(TableRectangle contents)	Method overload which omits the last parameter.
TableGrid	insertGrid(TableRectangle contents, TableGrid refGrid)	Inserts a new TableGrid into the TableSet.
void	setTitle(String title)	The table's title (or caption) for table models that define one.

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

getGridCount

int getGridCount()

The number of grids in the set.

getGrids

TableObjectStore getGrids()

A list of all the TableGrids in the TableSet.

insertGrid

TableGrid insertGrid(TableRectangle contents,
 TableGrid refGrid)
              throws TableException

Inserts a new TableGrid into the TableSet.

Parameters:

contents - The contents of this rectangle is copied into the new grid.

refGrid - The TableGrid before which the new one should be inserted. If this is null, the new grid is inserted at the end of the TableSet.

Returns:

The TableGrid added to the set.

Throws:

TableException - INVALID_PARAMETER_ERR: Raised if the refGrid is not in this set, or if the table model does not allow grids to be added to a set.

insertGrid

TableGrid insertGrid(TableRectangle contents)
              throws TableException

Method overload which omits the last parameter.

Throws:

TableException

addGrid

TableGrid addGrid(int columns,
 int rows,
 TableGrid refGrid,
 boolean addBefore)
           throws TableException

Adds an empty grid to the set.

Parameters:

columns - The number of columns in the new grid.

rows - The number of rows in the new grid.

refGrid - The TableGrid before or after which the new one should be inserted. If this is null, the new grid is inserted at the end of the TableSet.

addBefore - If omitted or false, the new grid is inserted after refGrid. If it is true, the new grid is added before refGrid.

Returns:

The new TableGrid.

Throws:

TableException - INVALID_PARAMETER_ERR: Raised if the refGrid is not in this set, or if the table model does not allow grids to be added to a set.

addGrid

TableGrid addGrid(int columns,
 int rows,
 TableGrid refGrid)
           throws TableException

Method overload which omits the last parameter.

Throws:

TableException

addGrid

TableGrid addGrid(int columns,
 int rows)
           throws TableException

Method overload which omits the last 2 parameters.

Throws:

TableException

deleteGrid

void deleteGrid(TableGrid grid)
         throws TableException

Parameters:

grid - The TableGrid to be deleted from the set.

Throws:

TableException - INVALID_PARAMETER_ERR: Raised if the grid is not in this set, or if the grid cannot be deleted because it is the last grid in the set, or because the table model does not allow grids to be deleted.

grid

TableGrid grid(int gridindex)

Returns a grid given its index. The first grid in the set is grid number 1. If no grid with this index exists, a null pointer is returned.

Parameters:

gridindex - The index of the grid to be returned. The first grid has index 1.

Returns:

getMarkupRange

Range getMarkupRange()

Returns a Range that selects all of the markup in the table.

getTitle

String getTitle()

The table's title (or caption) for table models that define one.

Throws:

TableException - OPERATION_FAILED_ERR: Raised if the insertion failed, or if the table model does not a title to be added to a set.

Since:

Epic 5.2

setTitle

void setTitle(String title)
       throws TableException

The table's title (or caption) for table models that define one.

Throws:

TableException - OPERATION_FAILED_ERR: Raised if the insertion failed, or if the table model does not a title to be added to a set.

Since:

Epic 5.2

deleteTitle

void deleteTitle()
          throws TableException

Delete the title for this table set.

Throws:

TableException - OPERATION_FAILED_ERR: Raised if deletion failed, or if there is no table title to be deleted.

Since:

Epic 5.2