Top Description Constructors Methods
org.apache.pdfbox.pdmodel

public Class PDDestinationNameTreeNode

extends PDNameTreeNode<PDPageDestination>
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.PDNameTreeNode, org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination, .PDPageDestination
This class holds all of the name trees that are available at the document level.
Author
Ben Litchfield

Constructor Summary

AccessConstructor and Description
public
PDDestinationNameTreeNode()

Constructor.

public
PDDestinationNameTreeNode(COSDictionary
The COS dictionary.
dic)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected PDPageDestination
convertCOSToPD(COSBase
The COS object to convert.
base)

Implements abstract org.apache.pdfbox.pdmodel.common.PDNameTreeNode.convertCOSToPD.

Method to convert the COS value in the name tree to the PD Model object.

protected PDNameTreeNode<PDPageDestination>
createChildNode(COSDictionary
The dictionary for the child node object to refer to.
dic)

Implements abstract org.apache.pdfbox.pdmodel.common.PDNameTreeNode.createChildNode.

Create a child node object.

Inherited from org.apache.pdfbox.pdmodel.common.PDNameTreeNode:
getCOSObjectgetKidsgetLowerLimitgetNamesgetParentgetUpperLimitgetValueisRootNodesetKidssetNamessetParent

Constructor Detail

PDDestinationNameTreeNodeback to summary
public PDDestinationNameTreeNode()

Constructor.

PDDestinationNameTreeNodeback to summary
public PDDestinationNameTreeNode(COSDictionary dic)

Constructor.

Parameters
dic:COSDictionary

The COS dictionary.

Method Detail

convertCOSToPDback to summary
protected PDPageDestination convertCOSToPD(COSBase base) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.common.PDNameTreeNode.convertCOSToPD.

Doc from org.apache.pdfbox.pdmodel.common.PDNameTreeNode.convertCOSToPD.

Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply return the given COSBase object. Subclasses should do something specific.

Parameters
base:COSBase

The COS object to convert.

Returns:PDPageDestination

The converted PD Model object.

Annotations
@Override
Exceptions
IOException:
If there is an error during creation.
createChildNodeback to summary
protected PDNameTreeNode<PDPageDestination> createChildNode(COSDictionary dic)

Implements abstract org.apache.pdfbox.pdmodel.common.PDNameTreeNode.createChildNode.

Doc from org.apache.pdfbox.pdmodel.common.PDNameTreeNode.createChildNode.

Create a child node object.

Parameters
dic:COSDictionary

The dictionary for the child node object to refer to.

Returns:PDNameTreeNode<PDPageDestination>

The new child node object.

Annotations
@Override