Package org.apache.fop.fo.flow

Class PageNumberCitation

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.flow.AbstractPageNumberCitation
org.apache.fop.fo.flow.PageNumberCitation
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder, StructureTreeElementHolder
public class PageNumberCitation extends AbstractPageNumberCitation
Class modelling the fo:page-number-citation object. This inline fo is replaced with the text for a page number. The page number used is the page that contains the start of the block referenced with the ref-id attribute.

  • Constructor Details

    • PageNumberCitation

      public PageNumberCitation(FONode parent)
      Main constructor
      Parameters:
      parent - FONode that is the parent of this object

  • Method Details

    • 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
      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

    • 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 int getNameId()
      Returns the Constants class integer value of this node
      Overrides:
      getNameId in class FONode
      Returns:
      Constants.FO_PAGE_NUMBER_CITATION