Package org.apache.fop.fo.flow.table

Class TableCell

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.flow.table.TableFObj
org.apache.fop.fo.flow.table.TableCell
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder
public class TableCell extends TableFObj implements CommonAccessibilityHolder
Class modelling the fo:table-cell object.

  • Constructor Details

    • TableCell

      public TableCell(FONode parent)
      Create a TableCell instance with the given FONode as parent.
      Parameters:
      parent - FONode that is the parent of this object

  • Method Details

    • bind

      public void bind(PropertyList pList) throws FOPException
      Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it.
      Overrides:
      bind in class TableFObj
      Parameters:
      pList - the PropertyList where the properties can be found.
      Throws:
      FOPException - if there is a problem binding the values

    • startOfNode

      public void startOfNode() throws FOPException
      Called after processNode() is called. Subclasses can do additional processing.
      Overrides:
      startOfNode in class FObj
      Throws:
      FOPException - FOP Exception

    • endOfNode

      public void endOfNode() throws FOPException
      Make sure content model satisfied, if so then tell the FOEventHandler that we are at the end of the table-cell. Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached. The default implementation simply calls FONode.finalizeNode(), without sending any event to the FOEventHandler.

      Note: the recommended way to override this method in subclasses is

      super.endOfNode(); // invoke finalizeNode()

      getFOEventHandler().endXXX(); // send endOfNode() notification

      Overrides:
      endOfNode in class FObj
      Throws:
      FOPException - FOP Exception

    • finalizeNode

      public void finalizeNode() throws FOPException
      Finalize this node. This method can be overridden by subclasses to perform finishing tasks (cleanup, validation checks, ...) without triggering endXXX() events in the FOEventHandler. The method is called by the default FONode.endOfNode() implementation.
      Overrides:
      finalizeNode in class FONode
      Throws:
      FOPException - in case there was an error

    • validateChildNode

      protected void validateChildNode(Locator loc, String nsURI, String localName) throws ValidationException
      Checks to make sure, during SAX processing of input document, that the incoming node is valid for this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called from FOTreeBuilder.startElement(String, String, String, Attributes) before constructing the child FObj.
      XSL Content Model: marker* (%block;)+
      Overrides:
      validateChildNode in class FONode
      Parameters:
      loc - location in the FO source file
      nsURI - namespace of incoming node
      localName - name of the incoming node (without namespace prefix)
      Throws:
      ValidationException - if incoming node not valid for parent

    • generatesReferenceAreas

      public boolean generatesReferenceAreas()
      Check if this formatting object generates reference areas.
      Overrides:
      generatesReferenceAreas in class FObj
      Returns:
      true if generates reference areas TODO see if needed

    • getCommonAccessibility

      public CommonAccessibility getCommonAccessibility()
      Returns the accessibility properties.
      Specified by:
      getCommonAccessibility in interface CommonAccessibilityHolder
      Returns:
      the accessibility properties

    • getCommonBorderPaddingBackground

      public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
      Get the CommonBorderPaddingBackground instance attached to this TableCell.
      Specified by:
      getCommonBorderPaddingBackground in class TableFObj
      Returns:
      the CommonBorderPaddingBackground instance

    • getColumnNumber

      public int getColumnNumber()
      Get the value for the column-number property.
      Returns:
      the "column-number" property.

    • showEmptyCells

      public boolean showEmptyCells()
      Get the value for the empty-cells property.
      Returns:
      true if "empty-cells" is "show"

    • getNumberColumnsSpanned

      public int getNumberColumnsSpanned()
      Get the value for the number-columns-spanned property
      Returns:
      the "number-columns-spanned" property.

    • getNumberRowsSpanned

      public int getNumberRowsSpanned()
      Get the value for the number-rows-spanned property
      Returns:
      the "number-rows-spanned" property.

    • getBlockProgressionDimension

      public LengthRangeProperty getBlockProgressionDimension()
      Get the value for the block-progression-dimension property
      Returns:
      the "block-progression-dimension" property.

    • getDisplayAlign

      public int getDisplayAlign()
      Get the value for the display-align property
      Returns:
      the display-align property.

    • getWidth

      public Length getWidth()
      Get the value for the width property
      Returns:
      the "width" property.

    • startsRow

      public boolean startsRow()
      Get the value for the starts-row property
      Returns:
      true if the cell starts a row.

    • endsRow

      public boolean endsRow()
      Get the value for the ends-row property
      Returns:
      true if the cell ends a row.

    • getLocalName

      public String getLocalName()
      Returns the local name (i.e. without namespace prefix) of the node
      Specified by:
      getLocalName in class FONode
      Returns:
      the local name of this node

    • getNameId

      public final int getNameId()
      Returns the Constants class integer value of this node
      Overrides:
      getNameId in class FONode
      Returns:
      Constants.FO_TABLE_CELL

    • flagAsHavingRetrieveTableMarker

      public void flagAsHavingRetrieveTableMarker()

    • hasRetrieveTableMarker

      public boolean hasRetrieveTableMarker()