org.icepdf.core.pobjects

Class Outlines

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.Outlines

public class Outlines
extends Dictionary

This class represents a PDF document outline. A document outline is an optional component of a PDF document and is accessible from the document's Catalog. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks) which can be used to display a documents structure to the user.

The outlines class does not build a visible structure; it only represents the non-visual structure of the outline. The OutlineItemTreeNode available in the packageorg.icepdf.core.ri.common provides an example on converting this hierarchy to a Swing JTree.

Since:

1.0

See Also:

org.icepdf.ri.common.utility.outline.OutlineItemTreeNode, OutlineItem

Field Summary

Fields

Modifier and Type	Field and Description
static Name	COUNT_KEY
static Name	D_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
Outlines(Library l, java.util.HashMap h) Creates a new instance of Outlines.

Method Summary

Modifier and Type	Method and Description
OutlineItem	getRootOutlineItem() Gets the root OutlineItem.

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

D_KEY

public static final Name D_KEY

COUNT_KEY

public static final Name COUNT_KEY

Constructor Detail

Outlines

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

Creates a new instance of Outlines.

Parameters:

l - document library.

h - Outlines dictionary entries.

Method Detail

getRootOutlineItem

public OutlineItem getRootOutlineItem()

Gets the root OutlineItem. The root outline item can be traversed to build a visible outline of the hierarchy.

Returns:

root outline item.