PdfStructureTreeRoot

java.lang.Object
- com.aowagie.text.pdf.PdfObject
- - com.aowagie.text.pdf.PdfDictionary
  - - com.aowagie.text.pdf.PdfStructureTreeRoot

```
class PdfStructureTreeRoot
extends PdfDictionary
```
The structure tree root corresponds to the highest hierarchy level in a tagged PDF.

Field Summary

Fields
Modifier and Type Field Description

private java.util.HashMap parentTree

private PdfIndirectReference reference

private PdfWriter writer
Holds value of property writer.
- Fields inherited from class com.aowagie.text.pdf.PdfDictionary
  CATALOG, hashMap, OUTLINES, PAGE
- Fields inherited from class com.aowagie.text.pdf.PdfObject
  ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors
Constructor Description

PdfStructureTreeRoot(PdfWriter writer)
Creates a new instance of PdfStructureTreeRoot

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`buildTree()`
`PdfIndirectReference`	`getReference()`	Gets the reference this object will be written to.
`PdfWriter`	`getWriter()`	Gets the writer.
`private void`	`nodeProcess(PdfDictionary struc, PdfIndirectReference reference)`

Methods inherited from class com.aowagie.text.pdf.PdfDictionary
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, remove, size, toPdf, toString

Methods inherited from class com.aowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type

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

Field Detail

parentTree

private final java.util.HashMap parentTree

reference

private final PdfIndirectReference reference

writer
```
private final PdfWriter writer
```
Holds value of property writer.

Constructor Detail
- PdfStructureTreeRoot
```
PdfStructureTreeRoot(PdfWriter writer)
```
  Creates a new instance of PdfStructureTreeRoot

Method Detail

getWriter
```
public PdfWriter getWriter()
```
Gets the writer.

Returns:

the writer

getReference
```
public PdfIndirectReference getReference()
```
Gets the reference this object will be written to.

Returns:

the reference this object will be written to

Since:

2.1.6 method removed in 2.1.5, but restored in 2.1.6

nodeProcess

private void nodeProcess(PdfDictionary struc,
                         PdfIndirectReference reference)
                  throws java.io.IOException

Throws:: java.io.IOException

buildTree

void buildTree()
        throws java.io.IOException

Throws:: java.io.IOException