com.itextpdf.text.pdf.interfaces

Interface IAccessibleElement

All Known Implementing Classes:

Chapter, ChapterAutoNumber, Chunk, Document, GreekList, HtmlCell, Image, ImgCCITT, ImgJBIG2, ImgRaw, ImgTemplate, ImgWMF, Jpeg, Jpeg2000, List, ListBody, ListItem, ListLabel, Paragraph, PdfAnnotation, PdfAppearance, PdfArtifact, PdfDiv, PdfDocument, PdfFormField, PdfImportedPage, PdfPatternPainter, PdfPCell, PdfPHeaderCell, PdfPRow, PdfPSXObject, PdfPTable, PdfPTableBody, PdfPTableFooter, PdfPTableHeader, PdfTemplate, RomanList, Section, TabbedChunk, ZapfDingbatsList, ZapfDingbatsNumberList

public interface IAccessibleElement

Describes accessible element.

Method Summary

Modifier and Type	Method and Description
PdfObject	getAccessibleAttribute(PdfName key) Get the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).
HashMap<PdfName,PdfObject>	getAccessibleAttributes() Gets all the properties of accessible element.
AccessibleElementId	getId()
PdfName	getRole() Gets the role of the accessible element.
boolean	isInline()
void	setAccessibleAttribute(PdfName key, PdfObject value) Set the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).
void	setId(AccessibleElementId id)
void	setRole(PdfName role) Sets the role of the accessiblee element.

Method Detail

getAccessibleAttribute

PdfObject getAccessibleAttribute(PdfName key)

Get the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).

Parameters:

key -

Returns:

setAccessibleAttribute

void setAccessibleAttribute(PdfName key,
                            PdfObject value)

Set the attribute of accessible element (everything in A dictionary + Lang, Alt, ActualText, E).

Parameters:

key -

value -

getAccessibleAttributes

HashMap<PdfName,PdfObject> getAccessibleAttributes()

Gets all the properties of accessible element.

Returns:

getRole

PdfName getRole()

Gets the role of the accessible element.

Returns:

setRole

void setRole(PdfName role)

Sets the role of the accessiblee element. Set role to null if you don't want to tag this element. Note that all child elements won't also be tagged.

Parameters:

role -

getId

AccessibleElementId getId()

setId

void setId(AccessibleElementId id)

isInline

boolean isInline()