PDStructureTreeRoot (Apache PDFBox 2.0.1 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
- - org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot

All Implemented Interfaces:

COSObjectable
```
public class PDStructureTreeRoot
extends PDStructureNode
```
A root of a structure tree.

Author:

Ben Litchfield, Johannes Koch

Constructor Summary

Constructors
Constructor and Description

PDStructureTreeRoot()
Default Constructor.

PDStructureTreeRoot(COSDictionary dic)
Constructor for an existing structure element.

Constructors
Constructor and Description
`PDStructureTreeRoot()` Default Constructor.
`PDStructureTreeRoot(COSDictionary dic)` Constructor for an existing structure element.

Method Summary

Methods
Modifier and Type	Method and Description
`PDNameTreeNode`	`getIDTree()` Returns the ID tree.
`COSBase`	`getK()` Returns the K entry.
`COSArray`	`getKArray()` Returns the K array entry.
`PDNumberTreeNode`	`getParentTree()` Returns the parent tree.
`int`	`getParentTreeNextKey()` Returns the next key in the parent tree.
`Map<String,Object>`	`getRoleMap()` Returns the role map.
`void`	`setIDTree(PDNameTreeNode idTree)` Sets the ID tree.
`void`	`setK(COSBase k)` Sets the K entry.
`void`	`setParentTree(PDNumberTreeNode parentTree)` Sets the parent tree.
`void`	`setParentTreeNextKey(int parentTreeNextkey)` Sets the next key in the parent tree.
`void`	`setRoleMap(Map<String,String> roleMap)` Sets the role map.

Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
appendKid, appendKid, appendObjectableKid, create, createObject, getCOSObject, getKids, getType, insertBefore, insertBefore, insertObjectableBefore, removeKid, removeKid, removeObjectableKid, setKids

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

- Constructor Detail
  - PDStructureTreeRoot
```
public PDStructureTreeRoot()
```
    Default Constructor.
  - PDStructureTreeRoot
```
public PDStructureTreeRoot(COSDictionary dic)
```
    Constructor for an existing structure element.
    
    Parameters:
    dic - The existing dictionary.
- Method Detail
  - getKArray
```
public COSArray getKArray()
```
    Returns the K array entry.
    
    Returns:
    the K array entry
  - getK
```
public COSBase getK()
```
    Returns the K entry.
    
    Returns:
    the K entry
  - setK
```
public void setK(COSBase k)
```
    Sets the K entry.
    
    Parameters:
    k - the K value
  - getIDTree
```
public PDNameTreeNode getIDTree()
```
    Returns the ID tree.
    
    Returns:
    the ID tree
  - setIDTree
```
public void setIDTree(PDNameTreeNode idTree)
```
    Sets the ID tree.
    
    Parameters:
    idTree - the ID tree
  - getParentTree
```
public PDNumberTreeNode getParentTree()
```
    Returns the parent tree.
    
    Returns:
    the parent tree
  - setParentTree
```
public void setParentTree(PDNumberTreeNode parentTree)
```
    Sets the parent tree.
    
    Parameters:
    parentTree - the parent tree
  - getParentTreeNextKey
```
public int getParentTreeNextKey()
```
    Returns the next key in the parent tree.
    
    Returns:
    the next key in the parent tree
  - setParentTreeNextKey
```
public void setParentTreeNextKey(int parentTreeNextkey)
```
    Sets the next key in the parent tree.
    
    Parameters:
    parentTreeNextkey - the next key in the parent tree.
  - getRoleMap
```
public Map<String,Object> getRoleMap()
```
    Returns the role map.
    
    Returns:
    the role map
  - setRoleMap
```
public void setRoleMap(Map<String,String> roleMap)
```
    Sets the role map.
    
    Parameters:
    roleMap - the role map

Class PDStructureTreeRoot

Constructor Summary

Method Summary

Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode

Methods inherited from class java.lang.Object

Constructor Detail

PDStructureTreeRoot

PDStructureTreeRoot

Method Detail

getKArray

getK

setK

getIDTree

setIDTree

getParentTree

setParentTree

getParentTreeNextKey

setParentTreeNextKey

getRoleMap

setRoleMap