org.icepdf.ri.common.utility.outline
Class OutlineItemTreeNode

java.lang.Object
  javax.swing.tree.DefaultMutableTreeNode
      org.icepdf.ri.common.utility.outline.OutlineItemTreeNode

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode

public class OutlineItemTreeNode
extends javax.swing.tree.DefaultMutableTreeNode

A PDF document may optionally display a document outline on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a "visual table of contents" to display the document's structure to the user. The user can interactively open and close individual items by clicking them with the mouse. When an item is open, its immediate children in the hierarchy become visible on the screen; each child may in turn be open or closed, selectively revealing or hiding further parts of the hierarchy. When an item is closed, all of its descendants in the hierarchy are hidden. Clicking the text of any visible item with the mouse activates the item, causing the viewer application to jump to a destination or trigger an action associated with the item. An OutlineItemTreeNode object represents the bookmarks or leaves which makes up the actual Outline JTree.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

OutlineItemTreeNode(org.icepdf.core.pobjects.OutlineItem item)
Creates a new instance of an OutlineItemTreeNode

Method Summary

int	getChildCount()
org.icepdf.core.pobjects.OutlineItem	getOutlineItem()
void	recursivelyClearOutlineItems()

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OutlineItemTreeNode

public OutlineItemTreeNode(org.icepdf.core.pobjects.OutlineItem item)

Creates a new instance of an OutlineItemTreeNode

Parameters:

item - Contains PDF Outline item data

Method Detail

getOutlineItem

public org.icepdf.core.pobjects.OutlineItem getOutlineItem()

recursivelyClearOutlineItems

public void recursivelyClearOutlineItems()

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class javax.swing.tree.DefaultMutableTreeNode