Package com.arbortext.epic.table

Interface TableRectangle

All Known Subinterfaces:
TableMulticell
All Known Implementing Classes:
TableMulticellImpl, TableRectangleImpl
public interface TableRectangle
Represents a rectangle of cells.
Since:
Epic 4.3

  • Method Details

    • getCells

      TableObjectStore getCells()
      A TableObjectStore containing all the cells in the rectangle. This is static. If the TableRectangle changes, the contents of the TableObjectStore remain unchanged.

    • getCellsOnTopEdge

      TableObjectStore getCellsOnTopEdge()
      A table object store containing all the cells on the top edge of the rectangle.

    • getCellsOnRightEdge

      TableObjectStore getCellsOnRightEdge()
      A table object store containing all the cells on the right edge of the rectangle.

    • getCellsOnBottomEdge

      TableObjectStore getCellsOnBottomEdge()
      A table object store containing all the cells on the bottom edge of the rectangle.

    • getCellsOnLeftEdge

      TableObjectStore getCellsOnLeftEdge()
      A table object store containing all the cells on the left edge of the rectangle.

    • getCellsAbove

      TableObjectStore getCellsAbove()
      A table object store containing the cells just above the rectangle.

    • getCellsRight

      TableObjectStore getCellsRight()
      A table object store containing the cells just to the right of the rectangle.

    • getCellsBelow

      TableObjectStore getCellsBelow()
      A table object store containing the cells just below the rectangle.

    • getCellsLeft

      TableObjectStore getCellsLeft()
      A table object store containing the cells just to the left of the rectangle.

    • getUpperLeft

      TableCell getUpperLeft()
      The upper left TableCell in the rectangle.

    • getLowerLeft

      TableCell getLowerLeft()
      The lower left TableCell in the rectangle.

    • getUpperRight

      TableCell getUpperRight()
      The upper right TableCell in the rectangle.

    • getLowerRight

      TableCell getLowerRight()
      The lower right TableCell in the rectangle.

    • getRulesAbove

      TableObjectStore getRulesAbove()
      A table object store containing the rules on the top edge of the rectangle

    • getRulesRight

      TableObjectStore getRulesRight()
      A table object store containing the rules on the right edge of the rectangle

    • getRulesBelow

      TableObjectStore getRulesBelow()
      A table object store containing the rules on the bottom edge of the rectangle

    • getRulesLeft

      TableObjectStore getRulesLeft()
      A table object store containing the rules on the left edge of the rectangle

    • getHeight

      int getHeight()
      The height of the rectangle in rows.

    • getWidth

      int getWidth()
      The width of the rectangle in columns.

    • copyRectangle

      void copyRectangle(TableRectangle sourceRectangle) throws TableException
      Copies the contents and attributes from one rectangle to another rectangle. The two rectangles must be the same size. They do not have to be in the same document or managed by the same table model.
      Parameters:
      sourceRectangle - The rectangle to be copied into this rectangle. It may be in a different document and it may managed by a different table model.
      Throws:
      TableException - INVALID_PARAMETER_ERR: Raised if the source rectangle is not the same size as this rectangle.
      OPERATION_FAILED_ERR: Raised if the copy can not be done for a reason other than the source rectangle being a different size than this rectangle.

    • getValid

      boolean getValid()
      True if the rectangle is valid. A rectangle may become invalid if, for example, one of its corner cells is deleted from the grid.

    • span

      TableMulticell span() throws TableException
      Converts the cells in the rectangle to a spanned cell and returns the new multicell.
      Returns:
      The new multicell created.
      Throws:
      TableException - INVALID_SPAN_ERR: Raised if a span can't be created from the two corner cells