org.icepdf.core.pobjects

Class Names

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.Names

public class Names
extends Dictionary

Some categories of objects in a PDF file can be referred to by name rather than by object reference. The correspondence between names and objects is established by the document’s name dictionary (PDF 1.2), located by means of the Names entry in the document’s catalog (see 7.7.2, "Document Catalog"). Each entry in this dictionary designates the root of a name tree (see 7.9.6, "Name Trees") defining names for a particular category of objects.

Since:

5.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static Name	ALTERNATE_PRESENTATIONS_KEY A name tree mapping name strings to alternate presentations.
static Name	ANNOTATION_APPEARANCE_KEY A name tree mapping name strings to annotation appearance streams.
static Name	DEST_KEY A name tree mapping name strings to destinations.
static Name	EMBEDDED_FILES_KEY A name tree mapping name strings to file specifications for embedded file streams.
static Name	IDS_KEY A name tree mapping digital identifiers to Web Capture content sets.
static Name	JAVASCRIPT_KEY A name tree mapping name strings to document-level JavaScript actions.
static Name	PAGES_KEY A name tree mapping name strings to visible pages for use in interactive forms.
static Name	RENDITIONS_KEY A name tree mapping name strings (which shall have Unicode encoding) to rendition objects.
static Name	TEMPLATES_KEY A name tree mapping name strings to invisible (template) pages for use in interactive forms.

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
Names(Library l, java.util.HashMap h)

Method Summary

Modifier and Type	Method and Description
NameTree	getAlternatePresentationsNameTree()
NameTree	getAnnotationAppearanceNameTree()
NameTree	getDestsNameTree()
NameTree	getEmbeddedFilesNameTree()
NameTree	getIdsNameTree()
NameTree	getJavaScriptNameTree()
NameTree	getPagesNameTree()
NameTree	getRenditionsNameTree()
NameTree	getTemplatesNameTree()

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

Field Detail

DEST_KEY

public static final Name DEST_KEY

A name tree mapping name strings to destinations.

ANNOTATION_APPEARANCE_KEY

public static final Name ANNOTATION_APPEARANCE_KEY

A name tree mapping name strings to annotation appearance streams.

JAVASCRIPT_KEY

public static final Name JAVASCRIPT_KEY

A name tree mapping name strings to document-level JavaScript actions.

PAGES_KEY

public static final Name PAGES_KEY

A name tree mapping name strings to visible pages for use in interactive forms.

TEMPLATES_KEY

public static final Name TEMPLATES_KEY

A name tree mapping name strings to invisible (template) pages for use in interactive forms.

IDS_KEY

public static final Name IDS_KEY

A name tree mapping digital identifiers to Web Capture content sets.

EMBEDDED_FILES_KEY

public static final Name EMBEDDED_FILES_KEY

A name tree mapping name strings to file specifications for embedded file streams.

ALTERNATE_PRESENTATIONS_KEY

public static final Name ALTERNATE_PRESENTATIONS_KEY

A name tree mapping name strings to alternate presentations.

RENDITIONS_KEY

public static final Name RENDITIONS_KEY

A name tree mapping name strings (which shall have Unicode encoding) to rendition objects.

Constructor Detail

Names

public Names(Library l,
             java.util.HashMap h)

Method Detail

getDestsNameTree

public NameTree getDestsNameTree()

getAnnotationAppearanceNameTree

public NameTree getAnnotationAppearanceNameTree()

getJavaScriptNameTree

public NameTree getJavaScriptNameTree()

getPagesNameTree

public NameTree getPagesNameTree()

getTemplatesNameTree

public NameTree getTemplatesNameTree()

getIdsNameTree

public NameTree getIdsNameTree()

getEmbeddedFilesNameTree

public NameTree getEmbeddedFilesNameTree()

getAlternatePresentationsNameTree

public NameTree getAlternatePresentationsNameTree()

getRenditionsNameTree

public NameTree getRenditionsNameTree()