Class PdfStructureTreeRoot

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.PdfStructureTreeRoot

All Implemented Interfaces:

IPdfStructureElement, Serializable

public class PdfStructureTreeRoot
extends PdfDictionary
implements IPdfStructureElement

The structure tree root corresponds to the highest hierarchy level in a tagged PDF.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<PdfName, PdfObject>	classes
private PdfDictionary	classMap
private HashMap<String, PdfObject>	idTreeMap
private HashMap<Integer, PdfIndirectReference>	numTree
private HashMap<Integer, PdfObject>	parentTree
private PdfIndirectReference	reference
private PdfWriter	writer	Holds value of property writer.

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, 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

Modifier and Type	Method	Description
(package private) void	buildTree()
private void	createNumTree()
PdfObject	getAttribute(PdfName name)	Gets the first entarance of attribute.
PdfObject	getMappedClass(PdfName name)
HashMap<Integer, PdfIndirectReference>	getNumTree()
PdfIndirectReference	getReference()	Gets the reference this object will be written to.
PdfWriter	getWriter()	Gets the writer.
void	mapClass(PdfName name, PdfObject object)
void	mapRole(PdfName used, PdfName standard)	Maps the user tags to the standard tags.
(package private) void	putIDTree(String record, PdfObject reference)
(package private) void	setAnnotationMark(int structParentIndex, PdfIndirectReference struc)
void	setAttribute(PdfName name, PdfObject obj)	Sets the attribute value.
(package private) void	setPageMark(int page, PdfIndirectReference struc)

Methods inherited from class PdfDictionary

checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class Object

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

Field Details

parentTree

private HashMap<Integer, PdfObject> parentTree

reference

private PdfIndirectReference reference

classMap

private PdfDictionary classMap

classes

protected HashMap<PdfName, PdfObject> classes

numTree

private HashMap<Integer, PdfIndirectReference> numTree

idTreeMap

private HashMap<String, PdfObject> idTreeMap

writer

private PdfWriter writer

Holds value of property writer.

Constructor Details

PdfStructureTreeRoot

PdfStructureTreeRoot(PdfWriter writer)

Creates a new instance of PdfStructureTreeRoot

Method Details

createNumTree

private void createNumTree()
                    throws IOException

Throws:

IOException

mapRole

public void mapRole(PdfName used,
 PdfName standard)

Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged document whatever the user tags may be.

Parameters:

used - the user tag

standard - the standard tag

mapClass

public void mapClass(PdfName name,
 PdfObject object)

putIDTree

void putIDTree(String record,
 PdfObject reference)

getMappedClass

public PdfObject getMappedClass(PdfName name)

getWriter

public PdfWriter getWriter()

Gets the writer.

Returns:

the writer

getNumTree

public HashMap<Integer, PdfIndirectReference> getNumTree()
                                                  throws IOException

Throws:

IOException

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

setPageMark

void setPageMark(int page,
 PdfIndirectReference struc)

setAnnotationMark

void setAnnotationMark(int structParentIndex,
 PdfIndirectReference struc)

buildTree

void buildTree()
        throws IOException

Throws:

IOException

getAttribute

public PdfObject getAttribute(PdfName name)

Gets the first entarance of attribute.

Specified by:

getAttribute in interface IPdfStructureElement

Since:

5.3.4

setAttribute

public void setAttribute(PdfName name,
 PdfObject obj)

Sets the attribute value.

Specified by:

setAttribute in interface IPdfStructureElement

Since:

5.3.4