public class OutlineItem extends Dictionary
The OutlineItem represents the individual outline item within
the hierarchy defined by an Outlines class. The outlines items
are chained together through their Prev and Next entries. Each
outline item has a title and a destination which can be accessed by the
visual representation to create a function document outlines (sometimes
called bookmarks).
This class is used mainly by the Outlines class to build the outline hierarchy. The root node of the outline hierarchy can be accessed through the Outlines class.
org.icepdf.ri.common.utility.outline.OutlineItemTreeNode,
Outlines| Modifier and Type | Field and Description |
|---|---|
static Name |
A_KEY |
static Name |
COUNT_KEY |
static Name |
DEST_KEY |
static Name |
FIRST_KEY |
static Name |
LAST_KEY |
static Name |
NEXT_KEY |
static Name |
PARENT_KEY |
static Name |
PREV_KEY |
static Name |
TITLE_KEY |
entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY| Constructor and Description |
|---|
OutlineItem(Library l,
java.util.HashMap h)
Creates a new instance of an OutlineItem.
|
| Modifier and Type | Method and Description |
|---|---|
Action |
getAction()
Gets the action associated with this OutlineItem.
|
Destination |
getDest()
Gets the destination to be displayed when this item is activated.
|
Reference |
getFirst()
Gets a reference to an outline item dictionary representing the first
top-level item in the outline.
|
Reference |
getLast()
Gets a reference to an outline item dictionary representing the last
top-level item in the outline.
|
Reference |
getNext()
Gets the next outline item at this outline level.
|
Reference |
getParent()
Gets the parent of this outline item in the outline hierarchy.
|
Reference |
getPrev()
Gets the previous outline item at this outline level.
|
OutlineItem |
getSubItem(int index)
Gets the child outline item specified by the index.
|
int |
getSubItemCount()
Gets the number of descendants that would appear under this outline item.
|
java.lang.String |
getTitle()
Gets the text to be displayed on the screen for this item.
|
boolean |
isEmpty()
Indicates if the Outline item is empty.
|
getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toStringpublic static final Name A_KEY
public static final Name COUNT_KEY
public static final Name TITLE_KEY
public static final Name DEST_KEY
public static final Name FIRST_KEY
public static final Name LAST_KEY
public static final Name NEXT_KEY
public static final Name PREV_KEY
public static final Name PARENT_KEY
public OutlineItem(Library l, java.util.HashMap h)
l - document library.h - OutlineItem dictionary entries.public boolean isEmpty()
public int getSubItemCount()
public OutlineItem getSubItem(int index)
index - child index number of desired outline item.public Action getAction()
public Reference getFirst()
public Reference getLast()
public Reference getNext()
public Reference getPrev()
public Reference getParent()
public java.lang.String getTitle()
public Destination getDest()