Package org.apache.fop.fo.pagination

Class AbstractPageSequence

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.AbstractPageSequence
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder
Direct Known Subclasses:
ExternalDocument, PageSequence
public abstract class AbstractPageSequence extends FObj implements CommonAccessibilityHolder
Abstract base class for the fo:page-sequence formatting object and the fox:external-document extension object.

  • Field Details

    • initialPageNumber

      protected Numeric initialPageNumber
      initial page number

    • forcePageCount

      protected int forcePageCount
      forced page count

    • startingPageNumber

      protected int startingPageNumber
      starting page number

  • Constructor Details

    • AbstractPageSequence

      public AbstractPageSequence(FONode parent)
      Create an AbstractPageSequence that is a child of the given parent FONode.
      Parameters:
      parent - the parent FONode

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

    • initPageNumber

      public void initPageNumber()
      Initialize the current page number for the start of the page sequence.

    • getStartingPageNumber

      public int getStartingPageNumber()
      Get the starting page number for this page sequence.
      Returns:
      the starting page number

    • makeFormattedPageNumber

      public String makeFormattedPageNumber(int pageNumber)
      Retrieves the string representation of a page number applicable for this page sequence
      Parameters:
      pageNumber - the page number
      Returns:
      string representation of the page number

    • getCommonAccessibility

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

    • getRoot

      public Root getRoot()
      Public accessor for the ancestor Root.
      Overrides:
      getRoot in class FONode
      Returns:
      the ancestor Root

    • getForcePageCount

      public int getForcePageCount()
      Get the value of the force-page-count property.
      Returns:
      the force-page-count value

    • getInitialPageNumber

      public Numeric getInitialPageNumber()
      Get the value of the initial-page-number property.
      Returns:
      the initial-page-number property value

    • getReferenceOrientation

      public int getReferenceOrientation()
      Get the value of the reference-orientation property.
      Returns:
      the "reference-orientation" property
      Since:
      XSL 1.1