The class represents a basic implementation of AccessibilityProperties that preserves specified accessibility properties. More...

Inheritance diagram for iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties:

Public Member Functions
	DefaultAccessibilityProperties (String role)
	Instantiates a new DefaultAccessibilityProperties instance based on structure element role. More...

override String	GetRole ()
	Gets the role of element. More...

override AccessibilityProperties	SetRole (String role)
	Sets the role of element. More...

override String	GetLanguage ()
	Gets the language identifier of element. More...

override AccessibilityProperties	SetLanguage (String language)
	Sets the language identifier of element. More...

override String	GetActualText ()
	Gets the actual text of element. More...

override AccessibilityProperties	SetActualText (String actualText)
	Sets the actual text of element. More...

override String	GetAlternateDescription ()
	Gets the alternate description of element. More...

override AccessibilityProperties	SetAlternateDescription (String alternateDescription)
	Sets the alternate description of element. More...

override String	GetExpansion ()
	Gets the expansion of element. More...

override AccessibilityProperties	SetExpansion (String expansion)
	Sets the expansion of element. More...

override AccessibilityProperties	AddAttributes (PdfStructureAttributes attributes)
	Adds the attributes to the element. More...

override AccessibilityProperties	AddAttributes (int index, PdfStructureAttributes attributes)
	Adds the attributes to the element with specified index. More...

override AccessibilityProperties	ClearAttributes ()
	Clears the list of attributes. More...

override IList< PdfStructureAttributes >	GetAttributesList ()
	Gets the attributes list. More...

override String	GetPhoneme ()
	Gets the phoneme of element. More...

override AccessibilityProperties	SetPhoneme (String phoneme)
	Sets the phoneme of element. More...

override String	GetPhoneticAlphabet ()
	Gets the phonetic alphabet of element. More...

override AccessibilityProperties	SetPhoneticAlphabet (String phoneticAlphabet)
	Sets the phonetic alphabet of element. More...

override PdfNamespace	GetNamespace ()
	Gets the namespace of element. More...

override AccessibilityProperties	SetNamespace (PdfNamespace @namespace)
	Sets the namespace of element. More...

override AccessibilityProperties	AddRef (TagTreePointer treePointer)
	Adds the reference to other tagged element. More...

override IList< TagTreePointer >	GetRefsList ()
	Gets the list of references to other tagged elements. More...

override AccessibilityProperties	ClearRefs ()
	Clears the list of references to other tagged elements. More...

override byte[]	GetStructureElementId ()
	Gets the associated structure element's ID string, if it has one. More...

override AccessibilityProperties	SetStructureElementId (byte[] id)
	Sets the associated structure element's ID. More...

Public Member Functions inherited from iText.Kernel.Pdf.Tagutils.AccessibilityProperties
virtual AccessibilityProperties	SetStructureElementIdString (String id)
	Sets the associated structure element's ID. More...

Package Attributes
String	role

String	language

String	actualText

String	alternateDescription

String	expansion

IList< PdfStructureAttributes >	attributesList = new List<PdfStructureAttributes>()

String	phoneme

String	phoneticAlphabet

IList< TagTreePointer >	refs = new List<TagTreePointer>()

Detailed Description

The class represents a basic implementation of AccessibilityProperties that preserves specified accessibility properties.

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.

Constructor & Destructor Documentation

◆ DefaultAccessibilityProperties()

iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.DefaultAccessibilityProperties ( String role )

inline

Instantiates a new DefaultAccessibilityProperties instance based on structure element role.

Parameters

role	the structure element role

Member Function Documentation

◆ AddAttributes() [1/2]

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.AddAttributes	(	int	index,
		PdfStructureAttributes	attributes
	)

inlinevirtual

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.

Parameters

index	the attributes index
attributes	the attributes to be added

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ AddAttributes() [2/2]

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.AddAttributes ( PdfStructureAttributes attributes )

inlinevirtual

Adds the attributes to the element.

Parameters

attributes the attributes to be added

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ AddRef()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.AddRef ( TagTreePointer treePointer )

inlinevirtual

Adds the reference to other tagged element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Parameters

treePointer the reference to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ ClearAttributes()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.ClearAttributes ( )

inlinevirtual

Clears the list of attributes.

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ ClearRefs()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.ClearRefs ( )

inlinevirtual

Clears the list of references to other tagged elements.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetActualText()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetActualText ( )

inlinevirtual

Gets the actual text of element.

Returns: the actual text

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetAlternateDescription()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetAlternateDescription ( )

inlinevirtual

Gets the alternate description of element.

Returns: the alternate description

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetAttributesList()

override IList<PdfStructureAttributes> iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetAttributesList ( )

inlinevirtual

Gets the attributes list.

Returns: the attributes list

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetExpansion()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetExpansion ( )

inlinevirtual

Gets the expansion of element.

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

Returns: the expansion

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetLanguage()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetLanguage ( )

inlinevirtual

Gets the language identifier of element.

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.

Returns: the language

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetNamespace()

override PdfNamespace iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetNamespace ( )

inlinevirtual

Gets the namespace of element.

Returns: the namespace

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetPhoneme()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetPhoneme ( )

inlinevirtual

Gets the phoneme of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneme(iText.Kernel.Pdf.PdfString).

Returns: the phoneme

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetPhoneticAlphabet()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetPhoneticAlphabet ( )

inlinevirtual

Gets the phonetic alphabet of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneticAlphabet(iText.Kernel.Pdf.PdfName).

Returns: the phonetic alphabet

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetRefsList()

override IList<TagTreePointer> iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetRefsList ( )

inlinevirtual

Gets the list of references to other tagged elements.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Returns: the list of references

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetRole()

override String iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetRole ( )

inlinevirtual

Gets the role of element.

Returns: the role

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ GetStructureElementId()

override byte [] iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.GetStructureElementId ( )

inlinevirtual

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

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetActualText()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetActualText ( String actualText )

inlinevirtual

Sets the actual text of element.

Parameters

actualText the actual text to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetAlternateDescription()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetAlternateDescription ( String alternateDescription )

inlinevirtual

Sets the alternate description of element.

Parameters

alternateDescription the alternation description to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetExpansion()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetExpansion ( String expansion )

inlinevirtual

Sets the expansion of element.

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

Parameters

expansion the expansion to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetLanguage()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetLanguage ( String language )

inlinevirtual

Sets the language identifier of element.

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.

Parameters

language the language to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetNamespace()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetNamespace ( PdfNamespace @ namespace )

inlinevirtual

Sets the namespace of element.

Parameters

namespace the namespace to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetPhoneme()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetPhoneme ( String phoneme )

inlinevirtual

Sets the phoneme of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneme(iText.Kernel.Pdf.PdfString).

Parameters

phoneme the phoneme to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetPhoneticAlphabet()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetPhoneticAlphabet ( String phoneticAlphabet )

inlinevirtual

Sets the phonetic alphabet of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneticAlphabet(iText.Kernel.Pdf.PdfName).

Parameters

phoneticAlphabet the phonetic alphabet to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetRole()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetRole ( String role )

inlinevirtual

Sets the role of element.

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.

Parameters

role	the role to be set

Returns: this AccessibilityProperties instance

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

◆ SetStructureElementId()

override AccessibilityProperties iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.SetStructureElementId ( byte[] id )

inlinevirtual

Sets the associated structure element's ID.

Reimplemented from iText.Kernel.Pdf.Tagutils.AccessibilityProperties.

Public Member Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DefaultAccessibilityProperties()

Member Function Documentation

◆ AddAttributes() [1/2]

◆ AddAttributes() [2/2]

◆ AddRef()

◆ ClearAttributes()

◆ ClearRefs()

◆ GetActualText()

◆ GetAlternateDescription()

◆ GetAttributesList()

◆ GetExpansion()

◆ GetLanguage()

◆ GetNamespace()

◆ GetPhoneme()

◆ GetPhoneticAlphabet()

◆ GetRefsList()

◆ GetRole()

◆ GetStructureElementId()

◆ SetActualText()

◆ SetAlternateDescription()

◆ SetExpansion()

◆ SetLanguage()

◆ SetNamespace()

◆ SetPhoneme()

◆ SetPhoneticAlphabet()

◆ SetRole()

◆ SetStructureElementId()