Package com.arbortext.epic.table

Interface TableRule

All Superinterfaces:

TableObject

All Known Implementing Classes:

TableRuleImpl

public interface TableRule
extends TableObject

Represents a rule. A rule is the line between two cells.

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	getCellAbove()	The cell above the rule if the rule is horizontal.
TableCell	getCellBelow()	The cell below the rule if the rule is horizontal
TableCell	getCellLeft()	The cell to the left of the rule if the rule is vertical
TableCell	getCellRight()	The cell to the right of the rule if the rule is vertical.
int	getEndColumnIndex()	The index of the ending column of the rule.
int	getEndRowIndex()	The index of the ending row of the rule.
short	getOrientation()	The orientation of the rule, that is, VERTICAL or HORIZONTAL.
TableRule	getRuleAbove()	The rule above this rule.
TableRule	getRuleBelow()	The rule below this rule.
TableRule	getRuleLeft()	The rule to the left of this rule.
TableRule	getRuleRight()	The rule to the right of this rule.
int	getStartColumnIndex()	The index of the starting column of the rule.
int	getStartRowIndex()	The index of the starting row of the rule.
boolean	getSuppressed()	True if the rule is suppressed because it is inside a multicell (representing a spanned set of cells).

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

getCellAbove

TableCell getCellAbove()

The cell above the rule if the rule is horizontal.

getCellRight

TableCell getCellRight()

The cell to the right of the rule if the rule is vertical.

getCellBelow

TableCell getCellBelow()

The cell below the rule if the rule is horizontal

getCellLeft

TableCell getCellLeft()

The cell to the left of the rule if the rule is vertical

getRuleAbove

TableRule getRuleAbove()

The rule above this rule. It will be parallel to this rule if it is a horizontal rule and join it end to end if it is a vertical rule

getRuleRight

TableRule getRuleRight()

The rule to the right of this rule. It will be parallel to this rule if it is a vertical rule and join it end to end if it is a horizontal rule

getRuleBelow

TableRule getRuleBelow()

The rule below this rule. It will be parallel to this rule if it is a horizontal rule and join it end to end if it is a vertical rule

getRuleLeft

TableRule getRuleLeft()

The rule to the left of this rule. It will be parallel to this rule if it is a vertical rule and join it end to end if it is a horizontal rule

getStartColumnIndex

int getStartColumnIndex()

The index of the starting column of the rule. This will be 1 for horizontal rules that start at the left edge of the grid or for vertical rules on the left edge of the grid.

getEndColumnIndex

int getEndColumnIndex()

The index of the ending column of the rule. This will be the number of columns plus 1 for vertical rules on the right edge of the grid.

getStartRowIndex

int getStartRowIndex()

The index of the starting row of the rule. This will be 1 for vertical rules that start at the top edge of the grid or for horizontal rules on the top edge of the grid.

getEndRowIndex

int getEndRowIndex()

The index of the ending row of the rule. This will be the number of rows plus 1 for horizontal rules on the bottom edge of the grid.

getSuppressed

boolean getSuppressed()

True if the rule is suppressed because it is inside a multicell (representing a spanned set of cells).

getOrientation

short getOrientation()

The orientation of the rule, that is, VERTICAL or HORIZONTAL.