SetaPDF_Core_Document_Catalog_StructTreeRoot Class representing the access to the StructTreeRoot dictionary of a document

File: /SetaPDF v2/Core/Document/Catalog/StructTreeRoot.php

Class hierarchy

Summary

Properties


Methods

__construct()

addChild()

Add a child element.

Parameters
$object : SetaPDF_Core_Type_IndirectObjectInterface
 
$beforeIndex : null
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

Release memory and cycled references.

exists()

Checks whether the StructTreeRoot dictionary exists or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getAndIncrementParentTreeNextKey()

Get the current next key for the parent tree and increase it.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getChilds()

Get the immediate children of the structure tree root.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDictionary()

Get and creates the dictionary of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

getObject()

Gets and creates the indirect object of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

getParentTree()

Gets and create the parent tree.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getParentTreeNextKey()

Get and sets the next key in the parent tree (if it not already exists).

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception