org.icepdf.core.pobjects

Class NamedDestinations

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.NamedDestinations

public class NamedDestinations
extends Dictionary

Instead of being defined directly with the explicit syntax a destination may be referred to indirectly by means of a name object (PDF 1.1) or a byte string (PDF 1.2). This capability is especially useful when the destination is located in another PDF document.

In PDF 1.1, the correspondence between name objects and destinations shall be defined by the Dests entry in the document catalogue (see 7.7.2, “Document Catalog”). The value of this entry shall be a dictionary in which each key is a destination name and the corresponding value is either an array defining the destination

Since:

5.2.0

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
NamedDestinations(Library library, java.util.HashMap entries)

Method Summary

Modifier and Type	Method and Description
Destination	getDestination(Name name) Gets a Destination object for the given Name.

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedDestinations

public NamedDestinations(Library library,
                         java.util.HashMap entries)

Method Detail

getDestination

public Destination getDestination(Name name)

Gets a Destination object for the given Name. If now corresponding Destination value if found null is returned.

Parameters:

name - Name to looking up in NamedDestinations list.

Returns:

Destination for the given name, null otherwise.