Class PageSequenceWrapper

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.PageSequenceWrapper
All Implemented Interfaces:
Cloneable, Constants

public class PageSequenceWrapper extends FObj
Class modelling the fo:page-sequence-wrapper object, first introduced in the XSL 1.1 WD.
  • Constructor Details

    • PageSequenceWrapper

      public PageSequenceWrapper(FONode parent)
      Create a PageSequenceWrapper instance that is a child of the given parent FONode.
      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 FObj
      Parameters:
      pList - the PropertyList where the properties can be found.
      Throws:
      FOPException - if there is a problem binding the values
    • 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/FOP: (bookmark+)
      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
    • getIndexClass

      public String getIndexClass()
      Get the value of the index-class property.
      Returns:
      the "index-class" property
    • getIndexKey

      public String getIndexKey()
      Get the value of the index-key property.
      Returns:
      the "index-key" property
    • 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_SEQUENCE_WRAPPER