Package org.apache.fop.fo.flow

Class RetrieveTableMarker

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.FObjMixed
org.apache.fop.fo.flow.AbstractRetrieveMarker
org.apache.fop.fo.flow.RetrieveTableMarker
All Implemented Interfaces:
Cloneable, Constants
public class RetrieveTableMarker extends AbstractRetrieveMarker
Class modelling the fo:retrieve-table-marker formatting object.

  • Constructor Details

    • RetrieveTableMarker

      public RetrieveTableMarker(FONode parent)
      Create a new RetrieveTableMarker instance that is a child of the given FONode.
      Parameters:
      parent - the parent FONode

  • Method Details

    • processNode

      public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException
      Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element. NOTE: An fo:retrieve-table-marker is only permitted as a descendant of an fo:table-header or an fo:table-footer.
      Overrides:
      processNode in class FObj
      Parameters:
      elementName - element name (e.g., "fo:block")
      locator - Locator object (ignored by default)
      attlist - Collection of attributes passed to us from the parser.
      pList - the property list of the parent node
      Throws:
      FOPException - for errors or inconsistencies in the attributes

    • 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. Store a reference to the parent PropertyList to be used when the retrieve-marker is resolved.
      Overrides:
      bind in class AbstractRetrieveMarker
      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
      Description copied from class: FObj
      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
      Description copied from class: FObjMixed
      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 FObjMixed
      Throws:
      FOPException - FOP Exception

    • findAncestor

      protected int findAncestor(int ancestorID)
      Overridden to flag the ancestor table-cell.
      Overrides:
      findAncestor in class FObj
      Parameters:
      ancestorID - ID of node name to check for (e.g., FO_ROOT)
      Returns:
      number of levels above FO where ancestor exists, -1 if not found

    • getRetrievePositionWithinTable

      public int getRetrievePositionWithinTable()
      Return the value for the retrieve-position-within-table property
      Returns:
      the value for retrieve-position-within-table; one of Constants.EN_FIRST_STARTING, Constants.EN_FIC, Constants.EN_LAST_STARTING, Constants.EN_LAST_ENDING.

    • getRetrieveBoundaryWithinTable

      public int getRetrieveBoundaryWithinTable()
      Return the value for the retrieve-boundary-within-table property
      Returns:
      the value for retrieve-boundary-within-table; one of Constants.EN_TABLE, Constants.EN_TABLE_FRAGMENT, Constants.EN_PAGE.

    • getLocalName

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

    • getNameId

      public int getNameId()
      Returns the Constants class integer value of this node
      Specified by:
      getNameId in class AbstractRetrieveMarker
      Returns:
      Constants.FO_RETRIEVE_TABLE_MARKER

    • clearChildNodes

      public void clearChildNodes()
      Clears the list of child nodes.
      Overrides:
      clearChildNodes in class FObj

    • restoreFOEventHandlerState

      protected void restoreFOEventHandlerState()
      Specified by:
      restoreFOEventHandlerState in class AbstractRetrieveMarker