Package com.itextpdf.kernel.pdf.tagging

Class PdfMcr

java.lang.Object

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

com.itextpdf.kernel.pdf.tagging.PdfMcr

All Implemented Interfaces:

IStructureNode

Direct Known Subclasses:

PdfMcrDictionary, PdfMcrNumber, PdfObjRef

 public abstract class PdfMcr extends PdfObjectWrapper<PdfObject> implements IStructureNode 
      

Represents Marked Content Reference (MCR) object wrapper.

Field Summary

Fields

Modifier and Type	Field	Description
protected PdfStructElem	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfMcr(PdfObject pdfObject, PdfStructElem parent)

Method Summary

Modifier and Type	Method	Description
List<IStructureNode>	getKids()
abstract int	getMcid()
PdfIndirectReference	getPageIndirectReference()
PdfDictionary	getPageObject()
IStructureNode	getParent()
PdfName	getRole()
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, flush, 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

Field Details

parent

 protected PdfStructElem parent 
            

Constructor Details

PdfMcr

 protected PdfMcr 
             (PdfObject pdfObject, PdfStructElem parent) 
            

Method Details

getMcid

 public abstract int getMcid() 
            

getPageObject

 public PdfDictionary getPageObject() 
            

getPageIndirectReference

 public PdfIndirectReference getPageIndirectReference() 
            

getRole

 public PdfName getRole() 
            

Specified by:

getRole in interface IStructureNode

getParent

 public IStructureNode getParent() 
            

Specified by:

getParent in interface IStructureNode

getKids

 public List<IStructureNode> getKids() 
            

Specified by:

getKids in interface IStructureNode

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<PdfObject>

Returns:

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