com.itextpdf.kernel.pdf.tagging

Class PdfStructTreeRoot

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.tagging.PdfStructTreeRoot

All Implemented Interfaces:

IPdfStructElem, Serializable

public class PdfStructTreeRoot
extends PdfObjectWrapper<PdfDictionary>
implements IPdfStructElem

To be able to be wrapped with this PdfObjectWrapper the PdfObject must be indirect.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfStructTreeRoot(PdfDictionary pdfObject)
PdfStructTreeRoot(PdfDocument document)

Method Summary

Modifier and Type	Method and Description
PdfStructElem	addKid(int index, PdfStructElem structElem)
PdfStructElem	addKid(PdfStructElem structElem)
void	copyTo(PdfDocument destDocument, int insertBeforePage, Map<PdfPage,PdfPage> page2page) Copies structure to a destDocument and insert it in a specified position in the document.
void	copyTo(PdfDocument destDocument, Map<PdfPage,PdfPage> page2page) Copies structure to a destDocument.
void	createParentTreeEntryForPage(PdfPage page) Creates and flushes parent tree entry for the page.
PdfMcr	findMcrByMcid(PdfDictionary pageDict, int mcid)
PdfObjRef	findObjRefByStructParentIndex(PdfDictionary pageDict, int structParentIndex)
void	flush()
PdfDocument	getDocument()
List<IPdfStructElem>	getKids() Gets list of the direct kids of StructTreeRoot.
PdfArray	getKidsObject()
int	getNextMcidForPage(PdfPage page)
Collection<PdfMcr>	getPageMarkedContentReferences(PdfPage page) Gets an unmodifiable collection of marked content references on page.
IPdfStructElem	getParent()
int	getParentTreeNextKey()
PdfName	getRole()
PdfDictionary	getRoleMap()
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.

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

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfStructTreeRoot

public PdfStructTreeRoot(PdfDocument document)

PdfStructTreeRoot

public PdfStructTreeRoot(PdfDictionary pdfObject)

Parameters:

pdfObject - must be an indirect object.

Method Detail

addKid

public PdfStructElem addKid(PdfStructElem structElem)

addKid

public PdfStructElem addKid(int index,
                            PdfStructElem structElem)

getParent

public IPdfStructElem getParent()

Specified by:

getParent in interface IPdfStructElem

getKids

public List<IPdfStructElem> getKids()

Gets list of the direct kids of StructTreeRoot. If certain kid is flushed, there will be a null in the list on it's place.

Specified by:

getKids in interface IPdfStructElem

Returns:

list of the direct kids of StructTreeRoot.

getKidsObject

public PdfArray getKidsObject()

getRoleMap

public PdfDictionary getRoleMap()

createParentTreeEntryForPage

public void createParentTreeEntryForPage(PdfPage page)

Creates and flushes parent tree entry for the page. Effectively this means that new content mustn't be added to the page.

Parameters:

page - PdfPage for which to create parent tree entry. Typically this page is flushed after this call.

getPageMarkedContentReferences

public Collection<PdfMcr> getPageMarkedContentReferences(PdfPage page)

Gets an unmodifiable collection of marked content references on page. NOTE: Do not remove tags when iterating over returned collection, this could lead to the ConcurrentModificationException, because returned collection is backed by the internal list of the actual page tags.

findMcrByMcid

public PdfMcr findMcrByMcid(PdfDictionary pageDict,
                            int mcid)

findObjRefByStructParentIndex

public PdfObjRef findObjRefByStructParentIndex(PdfDictionary pageDict,
                                               int structParentIndex)

getRole

public PdfName getRole()

Specified by:

getRole in interface IPdfStructElem

flush

public void flush()

Overrides:

flush in class PdfObjectWrapper<PdfDictionary>

copyTo

public void copyTo(PdfDocument destDocument,
                   Map<PdfPage,PdfPage> page2page)

Copies structure to a destDocument. NOTE: Works only for PdfStructTreeRoot that is read from the document opened in reading mode, otherwise an exception is thrown.

Parameters:

destDocument - document to copy structure to. Shall not be current document.

page2page - association between original page and copied page.

copyTo

public void copyTo(PdfDocument destDocument,
                   int insertBeforePage,
                   Map<PdfPage,PdfPage> page2page)

Copies structure to a destDocument and insert it in a specified position in the document. NOTE: Works only for PdfStructTreeRoot that is read from the document opened in reading mode, otherwise an exception is thrown.

Parameters:

destDocument - document to copy structure to.

insertBeforePage - indicates where the structure to be inserted.

page2page - association between original page and copied page.

getParentTreeNextKey

public int getParentTreeNextKey()

getNextMcidForPage

public int getNextMcidForPage(PdfPage page)

getDocument

public PdfDocument getDocument()

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.