Package org.apache.fop.fo.pagination.bookmarks

Class BookmarkTitle

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.bookmarks.BookmarkTitle
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder
public class BookmarkTitle extends FObj implements CommonAccessibilityHolder
Class modelling the fo:bookmark-title object, first introduced in the XSL 1.1 WD.

  • Constructor Details

    • BookmarkTitle

      public BookmarkTitle(FONode parent)
      Create a new BookmarkTitle object that is a child of the given FONode.
      Parameters:
      parent - the FONode parent

  • 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

    • characters

      protected void characters(char[] data, int start, int length, PropertyList pList, Locator locator)
      Add the characters to this BookmarkTitle. The text data inside the BookmarkTitle xml element is used for the BookmarkTitle string.
      Overrides:
      characters in class FONode
      Parameters:
      data - the character data
      start - the start position in the data array
      length - the length of the character array
      pList - currently applicable PropertyList
      locator - location in fo source file.

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

    • getCommonAccessibility

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

    • getTitle

      public String getTitle()
      Get the title for this BookmarkTitle.
      Returns:
      the bookmark title

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