public Class PDDocumentNameDestinationDictionary

Class Inheritance

extends Object
implements COSObjectable

All Implemented Interfaces

org.apache.pdfbox.pdmodel.common.COSObjectable

Imports

This encapsulates the "dictionary of names and corresponding destinations" for the /Dests entry in the document catalog.

Field Summary

Modifier and Type	Field and Description
private final COSDictionary	nameDictionary

Access	Constructor and Description
public	PDDocumentNameDestinationDictionary(COSDictionary The dictionary of names and corresponding destinations. dict) Constructor.

Modifier and Type	Method 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 PDDestination	Returns: The destination for that name, or null if there isn't any. getDestination(String The destination name. name) Returns the destination corresponding to the parameter.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

nameDictionary	back to summary
private final COSDictionary nameDictionary

PDDocumentNameDestinationDictionary	back to summary
public PDDocumentNameDestinationDictionary(COSDictionary dict) Constructor. Parameters dict:COSDictionary The dictionary of names and corresponding destinations.

PDDocumentNameDestinationDictionary

public PDDocumentNameDestinationDictionary(COSDictionary dict)

Constructor.

Parameters

getCOSObject	back 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

getCOSObject

public COSDictionary getCOSObject()

Convert this standard java object to a COS object.

The cos dictionary for this object.

Annotations

getDestination	back to summary
public PDDestination getDestination(String name) throws IOException Returns the destination corresponding to the parameter. Parameters name:String The destination name. Returns:PDDestination The destination for that name, or null if there isn't any. Exceptions IOException: if something goes wrong when creating the destination object.

getDestination

public PDDestination getDestination(String name) throws IOException

Returns the destination corresponding to the parameter.

Parameters

The destination for that name, or null if there isn't any.

Exceptions