Package org.apache.fop.render.pdf.extensions

Class PDFDictionaryElement

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.render.pdf.extensions.AbstractPDFExtensionElement
org.apache.fop.render.pdf.extensions.PDFCollectionEntryElement
org.apache.fop.render.pdf.extensions.PDFDictionaryElement
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
PDFActionElement, PDFCatalogElement, PDFDocumentInformationElement, PDFLayerElement, PDFNavigatorElement, PDFPageElement, PDFPagePieceElement, PDFVTElement
public class PDFDictionaryElement extends PDFCollectionEntryElement
Extension element for dictionaries: pdf:{catalog,page,dictionary}. The specific type of dictionary is established at construction type.

  • Field Details

  • Method Details

    • getDictionaryExtension

      public PDFDictionaryExtension getDictionaryExtension()

    • processNode

      public void processNode(String elementName, Locator locator, Attributes attlist, PropertyList propertyList) throws FOPException
      Description copied from class: FONode
      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 PDFCollectionEntryElement
      Parameters:
      elementName - element name (e.g., "fo:block")
      locator - Locator object (ignored by default)
      attlist - Collection of attributes passed to us from the parser.
      propertyList - the property list of the parent node
      Throws:
      FOPException - for errors or inconsistencies in the attributes

    • startOfNode

      public void startOfNode() throws FOPException
      Description copied from class: FONode
      Called after processNode() is called. Subclasses can do additional processing.
      Overrides:
      startOfNode in class PDFCollectionEntryElement
      Throws:
      FOPException - if there's a problem during processing

    • addChildNode

      protected void addChildNode(FONode child) throws FOPException
      Description copied from class: FONode
      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 FONode
      Parameters:
      child - child node to be added to the childNodes of this node
      Throws:
      FOPException - if there's a problem during processing

    • endOfNode

      public void endOfNode() throws FOPException
      Description copied from class: FONode
      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 PDFCollectionEntryElement
      Throws:
      FOPException - if there's a problem during processing

    • getLocalName

      public String getLocalName()
      Description copied from class: FONode
      Returns the local name (i.e. without namespace prefix) of the node
      Overrides:
      getLocalName in class PDFCollectionEntryElement
      Returns:
      the local name of this node

    • instantiateExtensionAttachment

      protected ExtensionAttachment instantiateExtensionAttachment()
      Description copied from class: AbstractPDFExtensionElement
      Instantiates extension attachment object.
      Overrides:
      instantiateExtensionAttachment in class AbstractPDFExtensionElement
      Returns:
      extension attachment