Class PDDocumentNameDictionary

java.lang.Object
org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
All Implemented Interfaces:
COSObjectable

public class PDDocumentNameDictionary extends Object implements COSObjectable
This class holds all of the name trees that are available at the document level.
Version:
$Revision: 1.4 $
Author:
Ben Litchfield
  • Constructor Details

    • PDDocumentNameDictionary

      public PDDocumentNameDictionary(PDDocumentCatalog cat)
      Constructor.
      Parameters:
      cat - The document catalog that this dictionary is part of.
    • PDDocumentNameDictionary

      public PDDocumentNameDictionary(PDDocumentCatalog cat, COSDictionary names)
      Constructor.
      Parameters:
      cat - The document that this dictionary is part of.
      names - The names dictionary.
  • Method Details

    • getCOSObject

      public COSBase getCOSObject()
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos object that matches this Java object.
    • getCOSDictionary

      public COSDictionary getCOSDictionary()
      Convert this standard java object to a COS object.
      Returns:
      The cos dictionary for this object.
    • getDests

      public PDDestinationNameTreeNode getDests()
      Get the destination name tree node. The values in this name tree will be PDPageDestination objects.
      Returns:
      The destination name tree node.
    • setDests

      public void setDests(PDDestinationNameTreeNode dests)
      Set the named destinations that are associated with this document.
      Parameters:
      dests - The destination names.
    • getEmbeddedFiles

      public PDEmbeddedFilesNameTreeNode getEmbeddedFiles()
      Get the embedded files named tree node. The values in this name tree will be PDComplexFileSpecification objects.
      Returns:
      The embedded files name tree node.
    • setEmbeddedFiles

      public void setEmbeddedFiles(PDEmbeddedFilesNameTreeNode ef)
      Set the named embedded files that are associated with this document.
      Parameters:
      ef - The new embedded files
    • getJavaScript

      public PDJavascriptNameTreeNode getJavaScript()
      Get the document level javascript entries. The values in this name tree will be PDTextStream objects.
      Returns:
      The document level named javascript.
    • setJavascript

      public void setJavascript(PDJavascriptNameTreeNode js)
      Set the named javascript entries that are associated with this document.
      Parameters:
      js - The new Javascript entries.