Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel

public Class PDDocumentNameDictionary

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable
This class holds all of the name trees that are available at the document level.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final PDDocumentCatalog
catalog

private final COSDictionary
nameDictionary

Constructor Summary

AccessConstructor and Description
public
PDDocumentNameDictionary(PDDocumentCatalog
The document catalog that this dictionary is part of.
cat)

Constructor.

public
PDDocumentNameDictionary(PDDocumentCatalog
The document that this dictionary is part of.
cat, COSDictionary
The names dictionary.
names)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos dictionary for this object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public PDDestinationNameTreeNode

Returns:

The destination name tree node.
getDests()

Get the destination named tree node.

public PDEmbeddedFilesNameTreeNode

Returns:

The embedded files name tree node.
getEmbeddedFiles()

Get the embedded files named tree node.

public PDJavascriptNameTreeNode

Returns:

The document level JavaScript name tree.
getJavaScript()

Get the document level JavaScript name tree.

public void
setDests(PDDestinationNameTreeNode
The destination names.
dests)

Set the named destinations that are associated with this document.

public void
setEmbeddedFiles(PDEmbeddedFilesNameTreeNode
The new embedded files
ef)

Set the named embedded files that are associated with this document.

public void
setJavascript(PDJavascriptNameTreeNode
The new Javascript entries.
js)

Set the named javascript entries that are associated with this document.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

catalogback to summary
private final PDDocumentCatalog catalog
nameDictionaryback to summary
private final COSDictionary nameDictionary

Constructor Detail

PDDocumentNameDictionaryback to summary
public PDDocumentNameDictionary(PDDocumentCatalog cat)

Constructor.

Parameters
cat:PDDocumentCatalog

The document catalog that this dictionary is part of.

PDDocumentNameDictionaryback to summary
public PDDocumentNameDictionary(PDDocumentCatalog cat, COSDictionary names)

Constructor.

Parameters
cat:PDDocumentCatalog

The document that this dictionary is part of.

names:COSDictionary

The names dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos dictionary for this object.

Annotations
@Override
getDestsback to summary
public PDDestinationNameTreeNode getDests()

Get the destination named tree node. The values in this name tree will be PDPageDestination objects.

Returns:PDDestinationNameTreeNode

The destination name tree node.

getEmbeddedFilesback to summary
public PDEmbeddedFilesNameTreeNode getEmbeddedFiles()

Get the embedded files named tree node. The values in this name tree will be PDComplexFileSpecification objects.

Returns:PDEmbeddedFilesNameTreeNode

The embedded files name tree node.

getJavaScriptback to summary
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:PDJavascriptNameTreeNode

The document level JavaScript name tree.

setDestsback to summary
public void setDests(PDDestinationNameTreeNode dests)

Set the named destinations that are associated with this document.

Parameters
dests:PDDestinationNameTreeNode

The destination names.

setEmbeddedFilesback to summary
public void setEmbeddedFiles(PDEmbeddedFilesNameTreeNode ef)

Set the named embedded files that are associated with this document.

Parameters
ef:PDEmbeddedFilesNameTreeNode

The new embedded files

setJavascriptback to summary
public void setJavascript(PDJavascriptNameTreeNode js)

Set the named javascript entries that are associated with this document.

Parameters
js:PDJavascriptNameTreeNode

The new Javascript entries.