com.itextpdf.kernel.pdf.tagging

Class PdfStructureAttributes

java.lang.Object

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

com.itextpdf.kernel.pdf.tagging.PdfStructureAttributes

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PdfUserPropertiesAttributes

public class PdfStructureAttributes
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfStructureAttributes(PdfDictionary attributesDict)
PdfStructureAttributes(PdfNamespace namespace)
PdfStructureAttributes(String owner)

Method Summary

Modifier and Type	Method and Description
PdfStructureAttributes	addEnumAttribute(String attributeName, String attributeValue)
PdfStructureAttributes	addFloatAttribute(String attributeName, float attributeValue)
PdfStructureAttributes	addIntAttribute(String attributeName, int attributeValue)
PdfStructureAttributes	addTextAttribute(String attributeName, String attributeValue)
String	getAttributeAsEnum(String attributeName)
Float	getAttributeAsFloat(String attributeName)
Integer	getAttributeAsInt(String attributeName)
String	getAttributeAsText(String attributeName)
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
PdfStructureAttributes	removeAttribute(String attributeName)

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

Constructor Detail

PdfStructureAttributes

public PdfStructureAttributes(PdfDictionary attributesDict)

PdfStructureAttributes

public PdfStructureAttributes(String owner)

PdfStructureAttributes

public PdfStructureAttributes(PdfNamespace namespace)

Method Detail

addEnumAttribute

public PdfStructureAttributes addEnumAttribute(String attributeName,
                                               String attributeValue)

addTextAttribute

public PdfStructureAttributes addTextAttribute(String attributeName,
                                               String attributeValue)

addIntAttribute

public PdfStructureAttributes addIntAttribute(String attributeName,
                                              int attributeValue)

addFloatAttribute

public PdfStructureAttributes addFloatAttribute(String attributeName,
                                                float attributeValue)

getAttributeAsEnum

public String getAttributeAsEnum(String attributeName)

getAttributeAsText

public String getAttributeAsText(String attributeName)

getAttributeAsInt

public Integer getAttributeAsInt(String attributeName)

getAttributeAsFloat

public Float getAttributeAsFloat(String attributeName)

removeAttribute

public PdfStructureAttributes removeAttribute(String attributeName)

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.