Class Wrapper

All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder

public class Wrapper extends FObjMixed implements CommonAccessibilityHolder
Class modelling the fo wrapper fo:wrapper object. The fo:wrapper object serves as a property holder for its child node objects.
  • Constructor Details

    • Wrapper

      public Wrapper(FONode parent)
      Create a Wrapper instance that is a child of the given FONode
      Parameters:
      parent - FONode that is the parent of this object
  • Method Details

    • bind

      public void bind(PropertyList pList) throws FOPException
      Description copied from class: FObj
      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
      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
    • 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* (#PCDATA|%inline;|%block;)*
      Additionally (unimplemented): "An fo:wrapper that is a child of an fo:multi-properties is only permitted to have children that would be permitted in place of the fo:multi-properties."
      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
    • addChildNode

      protected void addChildNode(FONode child) throws FOPException
      Adds a node as a child of this node. The default implementation of this method just ignores any child node being added.
      Overrides:
      addChildNode in class FObjMixed
      Parameters:
      child - child node to be added to the childNodes of this node
      Throws:
      FOPException - if there's a problem during processing
    • 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_WRAPPER
    • getCommonAccessibility

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

      public boolean isDelimitedTextRangeBoundary(int boundary)
      Description copied from class: FONode
      Determine if node has a delimited text range boundary. N.B. that we report this to be true by default, while specific subclasses override this method to report false.
      Overrides:
      isDelimitedTextRangeBoundary in class FONode
      Parameters:
      boundary - one of {EN_BEFORE, EN_AFTER, or EN_BOTH} enumeration constants
      Returns:
      true if indicated boundary (or boundaries) constitute a delimited text range boundary.