Package com.itextpdf.text.pdf
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
The structure tree root corresponds to the highest hierarchy level in a tagged PDF.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PdfDictionary
private HashMap<Integer,
PdfIndirectReference> private PdfIndirectReference
private PdfWriter
Holds value of property writer. -
Constructor Summary
ConstructorsConstructorDescriptionPdfStructureTreeRoot
(PdfWriter writer) Creates a new instance of PdfStructureTreeRoot -
Method Summary
Modifier and TypeMethodDescription(package private) void
private void
getAttribute
(PdfName name) Gets the first entarance of attribute.getMappedClass
(PdfName name) Gets the reference this object will be written to.Gets the writer.void
void
Maps the user tags to the standard tags.(package private) void
(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 com.itextpdf.text.pdf.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 com.itextpdf.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Field Details
-
parentTree
-
reference
-
classMap
-
classes
-
numTree
-
idTreeMap
-
writer
Holds value of property writer.
-
-
Constructor Details
-
PdfStructureTreeRoot
PdfStructureTreeRoot(PdfWriter writer) Creates a new instance of PdfStructureTreeRoot
-
-
Method Details
-
createNumTree
- Throws:
IOException
-
mapRole
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 tagstandard
- the standard tag
-
mapClass
-
putIDTree
-
getMappedClass
-
getWriter
Gets the writer.- Returns:
- the writer
-
getNumTree
- Throws:
IOException
-
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
-
setAnnotationMark
-
buildTree
- Throws:
IOException
-
getAttribute
Gets the first entarance of attribute.- Specified by:
getAttribute
in interfaceIPdfStructureElement
- Since:
- 5.3.4
-
setAttribute
Sets the attribute value.- Specified by:
setAttribute
in interfaceIPdfStructureElement
- Since:
- 5.3.4
-