Top Description Constructors Methods
org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline

public final Class PDDocumentOutline

extends PDOutlineNode
Class Inheritance
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName
This represents an outline in a pdf document.
Author
Ben Litchfield

Constructor Summary

AccessConstructor and Description
public
PDDocumentOutline()

Default Constructor.

public
PDDocumentOutline(COSDictionary
The storage dictionary.
dic)

Constructor for an existing document outline.

Method Summary

Modifier and TypeMethod and Description
public void
closeNode()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.closeNode.

Close this node.

public boolean
isNodeOpen()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.isNodeOpen.

public void
openNode()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.openNode.

This will set this node to be open when it is shown in the viewer.

Inherited from org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode:
addFirstaddLastchildrengetFirstChildgetLastChildgetOpenCountgetOutlineItemgetParenthasChildrenrequireSingleNodesetFirstChildsetLastChildsetOpenCountsetParentupdateParentOpenCountupdateParentOpenCountForAddedChild

Constructor Detail

PDDocumentOutlineback to summary
public PDDocumentOutline()

Default Constructor.

PDDocumentOutlineback to summary
public PDDocumentOutline(COSDictionary dic)

Constructor for an existing document outline.

Parameters
dic:COSDictionary

The storage dictionary.

Method Detail

closeNodeback to summary
public void closeNode()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.closeNode.

Doc from org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.closeNode.

Close this node.

Annotations
@Override
isNodeOpenback to summary
public boolean isNodeOpen()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.isNodeOpen.

Returns:boolean

Doc from org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.isNodeOpen.

true if this node count is greater than zero, false otherwise.

Annotations
@Override
openNodeback to summary
public void openNode()

Overrides org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.openNode.

Doc from org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode.openNode.

This will set this node to be open when it is shown in the viewer. By default, when a new node is created it will be closed. This will do nothing if the node is already open.

Annotations
@Override