com.itextpdf.kernel.pdf.tagutils

Interface IAccessibleElement

All Known Implementing Classes:

BlockElement, Cell, Div, Image, LineSeparator, Link, List, ListItem, Paragraph, Table, Text

public interface IAccessibleElement

A layout element which can have a role. The name of the role will be used to tag the element if it is added to a Tagged PDF document. It can also have AccessibilityProperties, metadata for the tag dictionary.

Method Summary

Modifier and Type	Method and Description
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility properties.
PdfName	getRole() Gets the element's role.
void	setRole(PdfName role) Sets the element's role.

Method Detail

getRole

PdfName getRole()

Gets the element's role.

Returns:

a PdfName containing the name of the role

setRole

void setRole(PdfName role)

Sets the element's role.

Parameters:

role - the new role which the IAccessibleElement should take

getAccessibilityProperties

AccessibilityProperties getAccessibilityProperties()

Gets the accessibility properties.

Returns:

a properties wrapper object specific to a tagged element in Tagged PDF