Module org.sejda.sambox
Package org.sejda.sambox.pdmodel

Class PDDocumentNameDictionary

java.lang.Object
org.sejda.sambox.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.
Author:
Ben Litchfield

  • Constructor Details

    • PDDocumentNameDictionary

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

    • PDDocumentNameDictionary

      public PDDocumentNameDictionary(COSDictionary names)
      Constructor.
      Parameters:
      names - The names dictionary.

  • Method Details

    • getCOSObject

      public COSDictionary getCOSObject()
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos dictionary for this object.

    • getDests

      public PDDestinationNameTreeNode getDests()
      Get the destination named tree node. The value in this name tree will be PDDestination 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 value 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 value in this name tree will be PDTextStream.
      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.