Class BookmarkTree

  • All Implemented Interfaces:
    java.lang.Cloneable, Constants

    public class BookmarkTree
    extends FObj
    Class modelling the fo:bookmark-tree object, first introduced in the XSL 1.1 WD.
    • Constructor Detail

      • BookmarkTree

        public BookmarkTree​(FONode parent)
        Create a new BookmarkTree object that is a child of the given FONode.
        Parameters:
        parent - the FONode parent
    • Method Detail

      • addChildNode

        protected void addChildNode​(FONode obj)
        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 FObj
        Parameters:
        obj - child node to be added to the childNodes of this node
      • 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 FONode
        Throws:
        FOPException - if there's a problem during processing
      • validateChildNode

        protected void validateChildNode​(org.xml.sax.Locator loc,
                                         java.lang.String nsURI,
                                         java.lang.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
      • getBookmarks

        public java.util.ArrayList getBookmarks()
        Get the descendant Bookmarks.
        Returns:
        an ArrayList containing the Bookmark objects.
      • getLocalName

        public java.lang.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