PDDestinationNameTreeNode (PDFBox reactor 2.0.4 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.pdfbox.pdmodel.common.PDNameTreeNode<PDPageDestination>
- - org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode

All Implemented Interfaces:

COSObjectable
```
public class PDDestinationNameTreeNode
extends PDNameTreeNode<PDPageDestination>
```
This class holds all of the name trees that are available at the document level.

Author:

Ben Litchfield

Constructor Summary

Constructors
Constructor and Description

PDDestinationNameTreeNode()
Constructor.

PDDestinationNameTreeNode(COSDictionary dic)
Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected PDPageDestination`	`convertCOSToPD(COSBase base)` Method to convert the COS value in the name tree to the PD Model object.
`protected PDNameTreeNode<PDPageDestination>`	`createChildNode(COSDictionary dic)` Create a child node object.

Methods inherited from class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
getCOSObject, getKids, getLowerLimit, getNames, getParent, getUpperLimit, getValue, isRootNode, setKids, setNames, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDDestinationNameTreeNode
```
public PDDestinationNameTreeNode()
```
    Constructor.
  - PDDestinationNameTreeNode
```
public PDDestinationNameTreeNode(COSDictionary dic)
```
    Constructor.
    
    Parameters:
    dic - The COS dictionary.
- Method Detail
  - convertCOSToPD
```
protected PDPageDestination convertCOSToPD(COSBase base)
                                    throws IOException
```
    Description copied from class: PDNameTreeNode
    
    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.
    
    Specified by:
    
    convertCOSToPD in class PDNameTreeNode<PDPageDestination>
    
    Parameters:
    base - The COS object to convert.
    
    Returns:
    The converted PD Model object.
    
    Throws:
    
    IOException - If there is an error during creation.
  - createChildNode
```
protected PDNameTreeNode<PDPageDestination> createChildNode(COSDictionary dic)
```
    Description copied from class: PDNameTreeNode
    
    Create a child node object.
    
    Specified by:
    
    createChildNode in class PDNameTreeNode<PDPageDestination>
    
    Parameters:
    dic - The dictionary for the child node object to refer to.
    
    Returns:
    The new child node object.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2017 The Apache Software Foundation. All rights reserved.