Package org.apache.fop.fo.extensions.destination

Class Destination

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.extensions.destination.Destination
All Implemented Interfaces:
Cloneable
public class Destination extends FONode
Class for named destinations in PDF.

  • Constructor Details

    • Destination

      public Destination(FONode parent)
      Constructs a Destination object (called by Maker).
      Parameters:
      parent - the parent formatting object

  • Method Details

    • processNode

      public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList pList) throws FOPException
      Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element.
      Overrides:
      processNode in class FONode
      Parameters:
      elementName - element name (e.g., "fo:block")
      locator - Locator object (ignored by default)
      attlist - Collection of attributes passed to us from the parser.
      pList - the property list of the parent node
      Throws:
      FOPException - for errors or inconsistencies in the attributes

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

    • getInternalDestination

      public String getInternalDestination()
      Returns the internal destination (an reference of the id property of any FO).
      Returns:
      the internal destination

    • getNamespaceURI

      public String getNamespaceURI()
      Returns the namespace URI for this node
      Overrides:
      getNamespaceURI in class FONode
      Returns:
      the namespace URI for this node

    • getNormalNamespacePrefix

      public String getNormalNamespacePrefix()
      Returns the normally used namespace prefix for this node
      Specified by:
      getNormalNamespacePrefix in class FONode
      Returns:
      the normally used namespace prefix for this kind of node (ex. "fo" for XSL-FO)

    • 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