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
,java.io.Serializable
public class PdfStructureTreeRoot extends PdfDictionary implements IPdfStructureElement
The structure tree root corresponds to the highest hierarchy level in a tagged PDF.- Author:
- Paulo Soares
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfObject
getAttribute(PdfName name)
Gets the first entarance of attribute.PdfObject
getMappedClass(PdfName name)
java.util.HashMap<java.lang.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.void
setAttribute(PdfName name, PdfObject obj)
Sets the attribute value.-
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
-
-
-
-
Method Detail
-
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 tagstandard
- the standard tag
-
getWriter
public PdfWriter getWriter()
Gets the writer.- Returns:
- the writer
-
getNumTree
public java.util.HashMap<java.lang.Integer,PdfIndirectReference> getNumTree() throws java.io.IOException
- Throws:
java.io.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
-
getAttribute
public PdfObject getAttribute(PdfName name)
Gets the first entarance of attribute.- Specified by:
getAttribute
in interfaceIPdfStructureElement
- Since:
- 5.3.4
-
setAttribute
public void setAttribute(PdfName name, PdfObject obj)
Sets the attribute value.- Specified by:
setAttribute
in interfaceIPdfStructureElement
- Since:
- 5.3.4
-
-