org.pdfbox.pdmodel

Class PDDocumentNameDictionary

Implemented Interfaces:
COSObjectable

public class PDDocumentNameDictionary
extends java.lang.Object
implements COSObjectable

This class holds all of the name trees that are available at the document level.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

PDDocumentNameDictionary(PDDocumentCatalog cat)
Constructor.
PDDocumentNameDictionary(PDDocumentCatalog cat, COSDictionary names)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
PDDestinationNameTreeNode
getDests()
Get the destination named tree node.
PDEmbeddedFilesNameTreeNode
getEmbeddedFiles()
Get the embedded files named tree node.
void
setDests(PDDestinationNameTreeNode dests)
Set the named destinations that are associated with this document.
void
setEmbeddedFiles(PDEmbeddedFilesNameTreeNode ef)
Set the named embedded files that are associated with this document.

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

getCOSDictionary

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

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.

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.

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.

setDests

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

setEmbeddedFiles

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