org.icepdf.core.pobjects

Class Catalog

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.Catalog

public class Catalog
extends Dictionary

The Catalog object represents the root of a PDF document's object heirarchy. The Catalog is located by means of the Root entry in the trailer of the PDF file. The catalog contains references to other objects defining the document's contents, outline, names, destinations, and other attributes.

The Catalog class can be accessed from the Document class for convenience, but can also be accessed via the PTrailer class. Useful information about the document can be extracted from the Catalog Dictionary, such as PDF version information and Viewer Preferences. All Catalog dictionary properties can be accesed via the getEntries method. See section 3.6.1 of the PDF Reference version 1.6 for more information on the properties available in the Catalog Object.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static Name	ACRO_FORM_KEY
static Name	COLLECTION_KEY
static Name	DESTS_KEY
static Name	METADATA_KEY
static Name	NAMES_KEY
static Name	OCPROPERTIES_KEY
static Name	OUTLINES_KEY
static Name	PAGELAYOUT_KEY
static Name	PAGEMODE_KEY
static Name	PAGES_KEY
static Name	TYPE
static Name	VIEWERPREFERENCES_KEY

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
Catalog(Library l, java.util.HashMap<java.lang.Object,java.lang.Object> h) Creates a new instance of a Catalog.

Method Summary

Modifier and Type	Method and Description
NamedDestinations	getDestinations() Gets a dictionary of names and corresponding destinations.
InteractiveForm	getInteractiveForm() Gets the interactive form object that contains the form widgets for the given PDF.
Stream	getMetaData() A metadata stream that shall contain metadata for the document.
Names	getNames() Gets the document's Names dictionary.
OptionalContent	getOptionalContent() Gets the the optional content properties dictionary if present.
Outlines	getOutlines() Gets the Outlines Dictionary that is the root of the document's outline hierarchy.
PageTree	getPageTree() Gets PageTree node that is the root of the document's page tree.
ViewerPreferences	getViewerPreferences() Gets a dictionary of keys and corresponding viewer preferences This can be used to pull information based on the PDF specification, such as HideToolbar or FitWindow
void	init() Initiate the PageTree.
java.lang.String	toString() Returns a summary of the Catalog dictionary values.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final Name TYPE

DESTS_KEY

public static final Name DESTS_KEY

VIEWERPREFERENCES_KEY

public static final Name VIEWERPREFERENCES_KEY

NAMES_KEY

public static final Name NAMES_KEY

OUTLINES_KEY

public static final Name OUTLINES_KEY

OCPROPERTIES_KEY

public static final Name OCPROPERTIES_KEY

PAGES_KEY

public static final Name PAGES_KEY

PAGELAYOUT_KEY

public static final Name PAGELAYOUT_KEY

PAGEMODE_KEY

public static final Name PAGEMODE_KEY

ACRO_FORM_KEY

public static final Name ACRO_FORM_KEY

COLLECTION_KEY

public static final Name COLLECTION_KEY

METADATA_KEY

public static final Name METADATA_KEY

Constructor Detail

Catalog

public Catalog(Library l,
               java.util.HashMap<java.lang.Object,java.lang.Object> h)

Creates a new instance of a Catalog.

Parameters:

l - document library.

h - Catalog dictionary entries.

Method Detail

init

public void init()

Initiate the PageTree.

Overrides:

init in class Dictionary

getPageTree

public PageTree getPageTree()

Gets PageTree node that is the root of the document's page tree. The PageTree can be traversed to access child PageTree and Page objects.

Returns:

Catalogs PageTree.

See Also:

Page

getOutlines

public Outlines getOutlines()

Gets the Outlines Dictionary that is the root of the document's outline hierarchy. The Outline can be traversed to access child OutlineItems.

Returns:

Outlines object if one exists; null, otherwise.

See Also:

OutlineItem

getNames

public Names getNames()

Gets the document's Names dictionary. The Names dictionary contains a category of objects in a PDF file which can be referred to by name rather than by object reference.

Returns:

names object entry. If no names entries exists null is returned.

getDestinations

public NamedDestinations getDestinations()

Gets a dictionary of names and corresponding destinations.

Returns:

A Dictionary of Destinations; if none, null is returned.

getViewerPreferences

public ViewerPreferences getViewerPreferences()

Gets a dictionary of keys and corresponding viewer preferences This can be used to pull information based on the PDF specification, such as HideToolbar or FitWindow

Returns:

the constructed ViewerPreferences object

getOptionalContent

public OptionalContent getOptionalContent()

Gets the the optional content properties dictionary if present.

Returns:

OptionalContent dictionary, null if none exists.

getMetaData

public Stream getMetaData()

A metadata stream that shall contain metadata for the document. To access the metadata stream data make a call to getMetData().getDecodedStreamBytes() which can be used to create a String or open an InputStream.

Returns:

metadata stream if define, otherwise null.

getInteractiveForm

public InteractiveForm getInteractiveForm()

Gets the interactive form object that contains the form widgets for the given PDF.

Returns:

interactive form object, null if no forms are pressent.

toString

public java.lang.String toString()

Returns a summary of the Catalog dictionary values.

Overrides:

toString in class Dictionary

Returns:

dictionary values.