Package com.itextpdf.kernel.pdf.tagutils

Class DefaultAccessibilityProperties

java.lang.Object

com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties

com.itextpdf.kernel.pdf.tagutils.DefaultAccessibilityProperties

Direct Known Subclasses:

FormDefaultAccessibilityProperties

       public class DefaultAccessibilityProperties extends AccessibilityProperties
      

The class represents a basic implementation of AccessibilityProperties that preserves specified accessibility properties. Accessibility properties are used to define properties of structure elements in Tagged PDF documents via TagTreePointer API.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	actualText
protected String	alternateDescription
protected List<PdfStructureAttributes>	attributesList
protected String	expansion
protected String	language
protected PdfNamespace	namespace
protected String	phoneme
protected String	phoneticAlphabet
protected List<TagTreePointer>	refs
protected String	role

Constructor Summary

Constructors

Constructor	Description
DefaultAccessibilityProperties(String role)	Instantiates a new DefaultAccessibilityProperties instance based on structure element role.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	addAttributes(int index, PdfStructureAttributes attributes)	Adds the attributes to the element with specified index.
AccessibilityProperties	addAttributes(PdfStructureAttributes attributes)	Adds the attributes to the element.
AccessibilityProperties	addRef(TagTreePointer treePointer)	Adds the reference to other tagged element.
AccessibilityProperties	clearAttributes()	Clears the list of attributes.
AccessibilityProperties	clearRefs()	Clears the list of references to other tagged elements.
String	getActualText()	Gets the actual text of element.
String	getAlternateDescription()	Gets the alternate description of element.
List<PdfStructureAttributes>	getAttributesList()	Gets the attributes list.
String	getExpansion()	Gets the expansion of element.
String	getLanguage()	Gets the language identifier of element.
PdfNamespace	getNamespace()	Gets the namespace of element.
String	getPhoneme()	Gets the phoneme of element.
String	getPhoneticAlphabet()	Gets the phonetic alphabet of element.
List<TagTreePointer>	getRefsList()	Gets the list of references to other tagged elements.
String	getRole()	Gets the role of element.
byte[]	getStructureElementId()	Gets the associated structure element's ID string, if it has one.
AccessibilityProperties	setActualText(String actualText)	Sets the actual text of element.
AccessibilityProperties	setAlternateDescription(String alternateDescription)	Sets the alternate description of element.
AccessibilityProperties	setExpansion(String expansion)	Sets the expansion of element.
AccessibilityProperties	setLanguage(String language)	Sets the language identifier of element.
AccessibilityProperties	setNamespace(PdfNamespace namespace)	Sets the namespace of element.
AccessibilityProperties	setPhoneme(String phoneme)	Sets the phoneme of element.
AccessibilityProperties	setPhoneticAlphabet(String phoneticAlphabet)	Sets the phonetic alphabet of element.
AccessibilityProperties	setRole(String role)	Sets the role of element.
AccessibilityProperties	setStructureElementId(byte[] id)	Sets the associated structure element's ID.

Methods inherited from class com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties

setStructureElementIdString

Methods inherited from class java.lang.Object

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

Field Details

role

             protected String role
            

language

             protected String language
            

actualText

             protected String actualText
            

alternateDescription

             protected String alternateDescription
            

expansion

             protected String expansion
            

attributesList

             protected List<PdfStructureAttributes> attributesList
            

phoneme

             protected String phoneme
            

phoneticAlphabet

             protected String phoneticAlphabet
            

namespace

             protected PdfNamespace namespace
            

refs

             protected List<TagTreePointer> refs
            

Constructor Details

DefaultAccessibilityProperties

             public DefaultAccessibilityProperties
             (String role)
            

Instantiates a new DefaultAccessibilityProperties instance based on structure element role.

Parameters:

role - the structure element role

Method Details

getRole

             public String getRole()
            

Description copied from class: AccessibilityProperties

Gets the role of element.

See also StandardRoles.

Overrides:

getRole in class AccessibilityProperties

Returns:

the role

setRole

             public AccessibilityProperties setRole
             (String role)
            

Description copied from class: AccessibilityProperties

Sets the role of element.

See also StandardRoles.

Calling this method with a null argument will make the tagging on the associated layout element "neutral". The effect is that all children of the layout element will be tagged as if they were direct children of the parent element.

Overrides:

setRole in class AccessibilityProperties

Parameters:

role - the role to be set

Returns:

this AccessibilityProperties instance

getLanguage

             public String getLanguage()
            

Description copied from class: AccessibilityProperties

Gets the language identifier of element. Should be in format xy-ZK (for example en-US).

For more information see PDF Specification ISO 32000-1 section 14.9.2.

Overrides:

getLanguage in class AccessibilityProperties

Returns:

the language

setLanguage

             public AccessibilityProperties setLanguage
             (String language)
            

Description copied from class: AccessibilityProperties

Sets the language identifier of element. Should be in format xy-ZK (for example en-US).

For more information see PDF Specification ISO 32000-1 section 14.9.2.

Overrides:

setLanguage in class AccessibilityProperties

Parameters:

language - the language to be set

Returns:

this AccessibilityProperties instance

getActualText

             public String getActualText()
            

Description copied from class: AccessibilityProperties

Gets the actual text of element.

Overrides:

getActualText in class AccessibilityProperties

Returns:

the actual text

setActualText

             public AccessibilityProperties setActualText
             (String actualText)
            

Description copied from class: AccessibilityProperties

Sets the actual text of element.

Overrides:

setActualText in class AccessibilityProperties

Parameters:

actualText - the actual text to be set

Returns:

this AccessibilityProperties instance

getAlternateDescription

             public String getAlternateDescription()
            

Description copied from class: AccessibilityProperties

Gets the alternate description of element.

Overrides:

getAlternateDescription in class AccessibilityProperties

Returns:

the alternate description

setAlternateDescription

             public AccessibilityProperties setAlternateDescription
             (String alternateDescription)
            

Description copied from class: AccessibilityProperties

Sets the alternate description of element.

Overrides:

setAlternateDescription in class AccessibilityProperties

Parameters:

alternateDescription - the alternation description to be set

Returns:

this AccessibilityProperties instance

getExpansion

             public String getExpansion()
            

Description copied from class: AccessibilityProperties

Gets the expansion of element.

Expansion it is the expanded form of an abbreviation of structure element.

Overrides:

getExpansion in class AccessibilityProperties

Returns:

the expansion

setExpansion

             public AccessibilityProperties setExpansion
             (String expansion)
            

Description copied from class: AccessibilityProperties

Sets the expansion of element.

Expansion it is the expanded form of an abbreviation of structure element.

Overrides:

setExpansion in class AccessibilityProperties

Parameters:

expansion - the expansion to be set

Returns:

this AccessibilityProperties instance

addAttributes

             public AccessibilityProperties addAttributes
             (PdfStructureAttributes attributes)
            

Description copied from class: AccessibilityProperties

Adds the attributes to the element.

Overrides:

addAttributes in class AccessibilityProperties

Parameters:

attributes - the attributes to be added

Returns:

this AccessibilityProperties instance

addAttributes

             public AccessibilityProperties addAttributes
             (int index, PdfStructureAttributes attributes)
            

Description copied from class: AccessibilityProperties

Adds the attributes to the element with specified index.

If an attribute with the same O and NS entries is specified more than once, the later (in array order) entry shall take precedence. For more information see PDF Specification ISO-32000 section 14.7.6.

Overrides:

addAttributes in class AccessibilityProperties

Parameters:

index - the attributes index

attributes - the attributes to be added

Returns:

this AccessibilityProperties instance

clearAttributes

             public AccessibilityProperties clearAttributes()
            

Description copied from class: AccessibilityProperties

Clears the list of attributes.

Overrides:

clearAttributes in class AccessibilityProperties

Returns:

this AccessibilityProperties instance

getAttributesList

             public List<PdfStructureAttributes> getAttributesList()
            

Description copied from class: AccessibilityProperties

Gets the attributes list.

Overrides:

getAttributesList in class AccessibilityProperties

Returns:

the attributes list

getPhoneme

             public String getPhoneme()
            

Description copied from class: AccessibilityProperties

Gets the phoneme of element.

For more information see PdfStructElem.setPhoneme(PdfString).

Overrides:

getPhoneme in class AccessibilityProperties

Returns:

the phoneme

setPhoneme

             public AccessibilityProperties setPhoneme
             (String phoneme)
            

Description copied from class: AccessibilityProperties

Sets the phoneme of element.

For more information see PdfStructElem.setPhoneme(PdfString).

Overrides:

setPhoneme in class AccessibilityProperties

Parameters:

phoneme - the phoneme to be set

Returns:

this AccessibilityProperties instance

getPhoneticAlphabet

             public String getPhoneticAlphabet()
            

Description copied from class: AccessibilityProperties

Gets the phonetic alphabet of element.

For more information see PdfStructElem.setPhoneticAlphabet(PdfName).

Overrides:

getPhoneticAlphabet in class AccessibilityProperties

Returns:

the phonetic alphabet

setPhoneticAlphabet

             public AccessibilityProperties setPhoneticAlphabet
             (String phoneticAlphabet)
            

Description copied from class: AccessibilityProperties

Sets the phonetic alphabet of element.

For more information see PdfStructElem.setPhoneticAlphabet(PdfName).

Overrides:

setPhoneticAlphabet in class AccessibilityProperties

Parameters:

phoneticAlphabet - the phonetic alphabet to be set

Returns:

this AccessibilityProperties instance

getNamespace

             public PdfNamespace getNamespace()
            

Description copied from class: AccessibilityProperties

Gets the namespace of element.

Overrides:

getNamespace in class AccessibilityProperties

Returns:

the namespace

setNamespace

             public AccessibilityProperties setNamespace
             (PdfNamespace namespace)
            

Description copied from class: AccessibilityProperties

Sets the namespace of element.

Overrides:

setNamespace in class AccessibilityProperties

Parameters:

namespace - the namespace to be set

Returns:

this AccessibilityProperties instance

addRef

             public AccessibilityProperties addRef
             (TagTreePointer treePointer)
            

Description copied from class: AccessibilityProperties

Adds the reference to other tagged element.

For more information see PdfStructElem.addRef(PdfStructElem).

Overrides:

addRef in class AccessibilityProperties

Parameters:

treePointer - the reference to be set

Returns:

this AccessibilityProperties instance

getRefsList

             public List<TagTreePointer> getRefsList()
            

Description copied from class: AccessibilityProperties

Gets the list of references to other tagged elements.

For more information see PdfStructElem.addRef(PdfStructElem).

Overrides:

getRefsList in class AccessibilityProperties

Returns:

the list of references

clearRefs

             public AccessibilityProperties clearRefs()
            

Description copied from class: AccessibilityProperties

Clears the list of references to other tagged elements.

For more information see PdfStructElem.addRef(PdfStructElem).

Overrides:

clearRefs in class AccessibilityProperties

Returns:

this AccessibilityProperties instance

getStructureElementId

             public byte[] getStructureElementId()
            

Gets the associated structure element's ID string, if it has one.

See also PdfStructElem.getStructureElementId().

Overrides:

getStructureElementId in class AccessibilityProperties

Returns:

the structure element's ID string, or null if there is none

setStructureElementId

             public AccessibilityProperties setStructureElementId
             (byte[] id)
            

Sets the associated structure element's ID. Passing null removes the ID.

See also PdfStructElem.setStructureElementId(PdfString).

Overrides:

setStructureElementId in class AccessibilityProperties

Parameters:

id - the element's ID to be set

Returns:

this AccessibilityProperties instance