setasign\SetaPDF2\Core\Document\Catalog
StructTreeRoot Class representing the access to the StructTreeRoot dictionary of a document
File: /SetaPDF v2/Core/Document/Catalog/StructTreeRoot.php
Old class name (alias):
\SetaPDF_Core_Document_Catalog_StructTreeRoot
Class hierarchy
Summary
Properties
Methods
__construct()
addChild()
Add a child element.
Parameters
- $object : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
- $beforeIndex : null
Exceptions
exists()
Checks whether the StructTreeRoot dictionary exists or not.
Exceptions
getAndIncrementParentTreeNextKey()
Get the current next key for the parent tree and increase it.
Exceptions
getChilds()
Get the immediate children of the structure tree root.
Exceptions
getDictionary()
public StructTreeRoot::getDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionaryGet and creates the dictionary of the StructTreeRoot entry.
Parameters
- $create : bool
Exceptions
getIdTree()
public StructTreeRoot::getIdTree (
bool $create = false
): ?\setasign\SetaPDF2\Core\DataStructure\Tree\NameTreeGet and create the id tree instance.
Parameters
- $create : bool
Exceptions
getObject()
public StructTreeRoot::getObject (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfIndirectObjectGets and creates the indirect object of the StructTreeRoot entry.
Parameters
- $create : bool
Exceptions
getParentTree()
public StructTreeRoot::getParentTree (
bool $create = false
): ?\setasign\SetaPDF2\Core\DataStructure\Tree\NumberTreeGets and create the parent tree.
Parameters
- $create : bool
Exceptions
getParentTreeNextKey()
Get and sets the next key in the parent tree (if it not already exists).