Interface TableRow

All Superinterfaces:
TableObject
All Known Implementing Classes:
TableRowImpl

public interface TableRow extends TableObject
Represents a row of cells. Every cell is part of exactly one TableRow.
Since:
Epic 4.3
  • Method Details

    • cell

      TableCell cell(int cellindex) throws TableException
      Returns a TableCell representing the cell at the given position in the row or a null pointer if that cell does not 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 row.
    • getLeftCell

      TableCell getLeftCell()
      The left-most cell in the row.
    • getRightCell

      TableCell getRightCell()
      The right-most cell in the row.
    • getCells

      TableObjectStore getCells()
      A TableObjectStore containing all the cells in the row.
    • getCellCount

      int getCellCount()
      The number of cells in the row.
    • getIndex

      int getIndex()
      The row number of this row in its grid. The top row in the grid is row 1.
    • getRowAbove

      TableRow getRowAbove()
      A TableRow representing the row above this one. If this is the top row, it is a null pointer.
    • getRowBelow

      TableRow getRowBelow()
      A TableRow representing the row below this one. If this is the bottom row, it is a null pointer.
    • getRulesAbove

      TableObjectStore getRulesAbove()
      A TableObjectStore containing a TableRule for each rule on the top edge of this row.
    • getRulesBelow

      TableObjectStore getRulesBelow()
      A TableObjectStore containing a TableRule for each rule on the bottom edge of this row.
    • getRuleLeft

      TableRule getRuleLeft()
      A TableRule for the rule at the left end of the row.
    • getRuleRight

      TableRule getRuleRight()
      A TableRule for the rule at the right end of the row.
    • getFirst

      boolean getFirst()
      True if this row is the first row in the TableSet. A row that is first in the TableSet will also be first in its TableGrid. (However, a row that is first in its TableGrid will not necessarily also be first in the TableSet.)
    • getLast

      boolean getLast()
      True if this row is the last row in the TableSet. A row that is last in the TableSet will also be last in its TableGrid . (However, a row that is last in its TableGrid will not necessarily also be last in the TableSet.)
    • getSuppressed

      boolean getSuppressed()
      True if the entire row is suppressed because all of its cells are spanned and none of them is a spanning cell.