Package org.apache.pdfbox.pdmodel
Class PDDocumentNameDictionary
java.lang.Object
org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
- All Implemented Interfaces:
COSObjectable
This class holds all of the name trees that are available at the document level.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PDDocumentNameDictionary
(PDDocumentCatalog cat, COSDictionary names) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.getDests()
Get the destination name tree node.Get the embedded files named tree node.Get the document level JavaScript name tree.void
Set the named destinations that are associated with this document.void
Set the named embedded files that are associated with this document.void
Set the named javascript entries that are associated with this document.
-
Field Details
-
nameDictionary
-
catalog
-
-
Constructor Details
-
PDDocumentNameDictionary
Constructor.- Parameters:
cat
- The document catalog that this dictionary is part of.
-
PDDocumentNameDictionary
Constructor.- Parameters:
cat
- The document that this dictionary is part of.names
- The names dictionary.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos dictionary for this object.
-
getDests
Get the destination name tree node. The values in this name tree will be PDPageDestination objects.- Returns:
- The destination name tree node.
-
setDests
Set the named destinations that are associated with this document.- Parameters:
dests
- The destination names.
-
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
Set the named embedded files that are associated with this document.- Parameters:
ef
- The new embedded files
-
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
Set the named javascript entries that are associated with this document.- Parameters:
js
- The new Javascript entries.
-