Package com.tom_roush.pdfbox.pdmodel

Class 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.

    • Constructor Detail

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

      • 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 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 name tree. When the document is opened, all the JavaScript actions in it shall be executed, defining JavaScript functions for use by other scripts in the document.
        Returns:
        The document level JavaScript name tree.

      • setJavascript

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