Class PdfStructureTreeRoot

java.lang.Object

org.openpdf.text.pdf.PdfObject

org.openpdf.text.pdf.PdfDictionary

org.openpdf.text.pdf.PdfStructureTreeRoot

public class PdfStructureTreeRoot
extends PdfDictionary

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

Author:

Paulo Soares (psoares@consiste.pt)

Field Summary

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

Method Summary

Modifier and Type	Method	Description
int	addExistingObject(PdfIndirectReference reference)	Adds a reference to the existing (already added to the document) object to the parentTree.
PdfIndirectReference	getReference()	Gets the reference this object will be written to.
PdfWriter	getWriter()	Gets the writer.
void	mapRole(PdfName used, PdfName standard)	Maps the user tags to the standard tags.

Methods inherited from class PdfDictionary

clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, getKeysAndValues, 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

Method Details

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

getWriter

public PdfWriter getWriter()

Gets the writer.

Returns:

the writer

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

addExistingObject

public int addExistingObject(PdfIndirectReference reference)

Adds a reference to the existing (already added to the document) object to the parentTree. This method can be used when the object is need to be referenced via /StructParent key.

Returns:

key which define the object record key (e.g. in /NUMS array)