Package com.arbortext.epic.table

Interface TableCell

All Superinterfaces:
TableObject
All Known Implementing Classes:
TableCellImpl
public interface TableCell extends TableObject
Represents a single cell in a table. May be part of a spanned TableMulticell, but represents a single cell in that multicell if so.
Since:
Epic 4.3

  • Method Details

    • getRuleAbove

      TableRule getRuleAbove()
      The TableRule on the top edge of the cell.

    • getRuleRight

      TableRule getRuleRight()
      The TableRule on the right edge of the cell.

    • getRuleBelow

      TableRule getRuleBelow()
      The TableRule on the bottom edge of the cell.

    • getRuleLeft

      TableRule getRuleLeft()
      The TableRule on the left edge of the cell.

    • getColumn

      TableColumn getColumn()
      The column that the cell is part of.

    • getRow

      TableRow getRow()
      The row that the cell is part of.

    • inSameColumn

      boolean inSameColumn(TableCell otherCell)
      Returns true if this cell is in the same column in the same grid as the indicated cell.
      Parameters:
      otherCell - The other cell that may be in the same column.
      Returns:
      True if the two cells are in the same column.

    • inSameRow

      boolean inSameRow(TableCell otherCell)
      Returns true if this cell is in the same row in the same grid as the indicated cell.
      Parameters:
      otherCell - The other cell that may be in the same row.
      Returns:
      True if the two cells are in the same row.

    • isAdjacent

      boolean isAdjacent(TableCell otherCell)
      Returns true if the indicated cell is a neighbor.
      Parameters:
      otherCell - The cell that might be a neighbor.
      Returns:
      True if the other cell is a neighbor.

    • getMulticell

      TableMulticell getMulticell()
      The TableMulticell that this cell is part of. Will be null if not part of a multicell.

    • getCellAbove

      TableCell getCellAbove()
      The cell above this cell.

    • getCellRight

      TableCell getCellRight()
      The cell to the right of this cell.

    • getCellBelow

      TableCell getCellBelow()
      The cell below this cell.

    • getCellLeft

      TableCell getCellLeft()
      The cell to the left of this cell.

    • span

      TableMulticell span(TableCell otherCorner) throws TableException
      Creates a span of a rectangle of cells. This cell is on one corner and the cell given as a parameter is on the other corner.
      Parameters:
      otherCorner - The cell on the other corner. Either cell may be the upper left or lower right.
      Returns:
      The multicell created to represent the span.
      Throws:
      TableException - INVALID_SPAN_ERR: Raised if a span can't be created from the two corner cells

    • unspan

      void unspan() throws TableException
      Unspans the cell, which must be in a multicell.
      Throws:
      TableException - INVALID_SPAN_ERR: Raised if the cell is not in a multicell.

    • getContents

      Range getContents()
      The contents of the cell. The Range returned contains the cell's contents. If the cell has no contents, a collapsed Range is returned. The contents of the cell can be changed by changing the contents of the Range.

    • rectangle

      TableRectangle rectangle(TableCell otherCorner) throws TableException
      Returns a TableRectangle with this cell on one corner and the cell given as the parameter on the other corner. Either cell may be the upper left cell. Both must be in the same grid.
      Parameters:
      otherCorner - The TableCell that defines the other corner of the rectangle.
      Returns:
      A rectangle with the specified corner cells.
      Throws:
      TableException - INVALID_PARAMETER_ERR: Raised if the two cells are not in the same grid.

    • findFontPI

      Element findFontPI(boolean create) throws TableException
      Returns an Element node for the font PI in the cell, creating it if asked to.
      Parameters:
      create - If true, then the font PI is created if it doesn't exist and the table model allows the creation.
      Returns:
      The font PI. Null if none and create not specified.
      Throws:
      TableException - OPERATION_FAILED_ERR: Raised if an attempt to create font PI fails.

    • deleteFontPI

      void deleteFontPI() throws TableException
      Deletes the font PI from the table cell if it has one. Otherwise does nothing.
      Throws:
      TableException - OPERATION_FAILED_ERR: Raised if the font PI can't be deleted.

    • instantiate

      void instantiate()
      Marks the cell as being non-sparse. Some table models allow sparse markup, where some cells of a table are not explicitly described in markup. PTC Arbortext Editor and PTC Arbortext Publishing Engine add generated cell markup to the document when reading a sparse table so that there is markup underlying every table cell. When a document containing a table is saved, this generated markup is deleted, unless the cell has acquired content, attributes, or some other reason for existence. This function allows the user to require that the markup corresponding to a cell NOT be discarded, even if it is generated markup.

    • nextGalleyCell

      TableCell nextGalleyCell(boolean wrap)
      Returns the next cell in galley order, wrapping around from the last to the first if requested.
      Parameters:
      wrap - If true, wrap around from the last cell to the first.
      Returns:
      The next cell in galley order, if any.

    • previousGalleyCell

      TableCell previousGalleyCell(boolean wrap)
      Returns the previous cell in galley order, wrapping around from the first to the last if requested.
      Parameters:
      wrap - If true, wrap around from the first cell to the last.
      Returns:
      The previous cell in galley order, if any.

    • getOnTopMulticellEdge

      boolean getOnTopMulticellEdge()
      True if the cell in on the top edge of a multicell.

    • getOnRightMulticellEdge

      boolean getOnRightMulticellEdge()
      True if the cell is on the right edge of a multicell.

    • getOnBottomMulticellEdge

      boolean getOnBottomMulticellEdge()
      True if the cell is on the bottom edge of a multicell.

    • getOnLeftMulticellEdge

      boolean getOnLeftMulticellEdge()
      True if the cell is on the left edge of a multicell.

    • getSpanned

      boolean getSpanned()
      True if this cell is in a multicell and is not the spanning cell in the multicell

    • getSpanning

      boolean getSpanning()
      True if this cell is the spanning cell in a multicell