Class Bookmark

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-title, 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

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

  Throws:

  FOPException - FOP Exception

• 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

• getCommonAccessibility

  public CommonAccessibility getCommonAccessibility()

  Returns the accessibility properties.

  Specified by:

  getCommonAccessibility in interface CommonAccessibilityHolder

  Returns:

  the accessibility properties

• getBookmarkTitle

  public String getBookmarkTitle()

  Get the bookmark title for this bookmark

  Returns:

  the bookmark title string or an empty string if not found

• getInternalDestination

  public String getInternalDestination()

  Returns the value of the internal-destination property.

  Returns:

  the internal-destination

• getExternalDestination

  public String getExternalDestination()

  Returns the value of the external-destination property.

  Returns:

  the external-destination

• showChildItems

  public boolean showChildItems()

  Determines if this fo:bookmark's subitems should be initially displayed or hidden, based on the starting-state property set on this FO.

  Returns:

  true if this bookmark's starting-state is "show", false if "hide".

• getChildBookmarks

  public ArrayList getChildBookmarks()

  Get the child Bookmarks in an java.util.ArrayList.

  Returns:

  an ArrayList containing the child Bookmarks

• 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