com.itextpdf.kernel.pdf.tagging

Class PdfStructIdTree

java.lang.Object

com.itextpdf.kernel.pdf.GenericNameTree

com.itextpdf.kernel.pdf.tagging.PdfStructIdTree

All Implemented Interfaces:

IPdfNameTreeAccess

public class PdfStructIdTree
extends GenericNameTree

Models the tree of structure element IDs. This is an optional feature of tagged PDF documents.

Method Summary

Modifier and Type	Method and Description
void	addEntry(PdfString key, PdfObject value) Add an entry to the name tree.
PdfStructElem	getStructElemById(byte[] id) Retrieve a structure element by ID, if it has one.
PdfStructElem	getStructElemById(PdfString id) Retrieve a structure element by ID, if it has one.

Methods inherited from class com.itextpdf.kernel.pdf.GenericNameTree

addEntry, addEntry, buildTree, getEntry, getEntry, getItems, getKeys, isModified, readTree, removeEntry, setItems, setModified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStructElemById

public PdfStructElem getStructElemById(PdfString id)

Retrieve a structure element by ID, if it has one.

Parameters:

id - the ID of the structure element to retrieve

Returns:

the structure element with the given ID if one exists, or null otherwise.

getStructElemById

public PdfStructElem getStructElemById(byte[] id)

Retrieve a structure element by ID, if it has one.

Parameters:

id - the ID of the structure element to retrieve

Returns:

the structure element with the given ID if one exists, or null otherwise.

addEntry

public void addEntry(PdfString key,
                     PdfObject value)

Description copied from class: GenericNameTree

Add an entry to the name tree.

Overrides:

addEntry in class GenericNameTree

Parameters:

key - key of the entry

value - object to add