Public Member Functions
void	drawLine (PDFDoc pdf_doc, int page_index, int type, AccessibilityLineInfoArray line_info_array)
	A callback function used to draw lines for accessibility visualization. More...

void	drawRect (PDFDoc pdf_doc, int page_index, int type, AccessibilityRectInfoArray rect_info_array)
	A callback function used to draw rectangles for accessibility visualization. More...

void	drawText (PDFDoc pdf_doc, int page_index, int type, AccessibilityTextInfoArray text_info_array)
	A callback function used to draw text for accessibility visualization. More...

boolean	generateContent (PDFDoc pdf_doc, int page_index)
	A callback function used to generate content for a specified page. More...

String	getDocumentFileName (PDFDoc pdf_doc)
	A callback function used to get the document file name. More...

String	getTextStringByStringID (String string_id)
	A callback function used to get text string by string ID. More...

void	onContentChanged (PDFDoc pdf_doc, int page_index, boolean is_notify_self)
	A callback function used to notify that content has changed on a specified page. More...

void	release ()
	A callback function used to release current callback object itself. More...

Static Public Attributes
static final int	e_DrawRectTypeContent = 0
	Draw rect type : content.

static final int	e_DrawRectTypeLabel = 7
	Draw rect type : label.

static final int	e_DrawRectTypeLine = 6
	Draw rect type : line.

static final int	e_DrawRectTypeOrderRect = 3
	Draw rect type : order rect.

static final int	e_DrawRectTypeTableCell = 1
	Draw rect type : table cell.

static final int	e_DrawRectTypeTableCellsBorder = 9
	Draw rect type : table cells border.

static final int	e_DrawRectTypeTableCellsDataBackground = 12
	Draw rect type : table cells data background.

static final int	e_DrawRectTypeTableCellsDataBackgroundMissingHeader = 16
	Draw rect type : table cells data background missing header.

static final int	e_DrawRectTypeTableCellsDataBackgroundMultispan = 14
	Draw rect type : table cells data background multispan.

static final int	e_DrawRectTypeTableCellsHeaderBackground = 11
	Draw rect type : table cells header background.

static final int	e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader = 15
	Draw rect type : table cells header background missing header.

static final int	e_DrawRectTypeTableCellsHeaderBackgroundMultispan = 13
	Draw rect type : table cells header background multispan.

static final int	e_DrawRectTypeTableCellsSelectedBorder = 10
	Draw rect type : table cells selected border.

static final int	e_DrawRectTypeTableCellsType = 8
	Draw rect type : table cells type.

static final int	e_DrawRectTypeTableFigure = 2
	Draw rect type : table figure.

static final int	e_DrawRectTypeTableLabel = 5
	Draw rect type : table label.

static final int	e_DrawRectTypeText = 4
	Draw rect type : text.

Detailed Description

This class represents a render provider for accessibility, used to generate content and draw visual elements.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class. The render provider is shared between the accessibility classes and ReadingOrderEditor, providing rendering capabilities for accessibility visual feedback.

Member Function Documentation

◆ drawLine()

void com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.drawLine	(	PDFDoc	pdf_doc,
		int	page_index,
		int	type,
		AccessibilityLineInfoArray	line_info_array
	)

A callback function used to draw lines for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	line_info_array	The array of accessibility line info objects.

Returns: None.

◆ drawRect()

void com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.drawRect	(	PDFDoc	pdf_doc,
		int	page_index,
		int	type,
		AccessibilityRectInfoArray	rect_info_array
	)

A callback function used to draw rectangles for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	rect_info_array	The array of accessibility rect info objects.

Returns: None.

◆ drawText()

void com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.drawText	(	PDFDoc	pdf_doc,
		int	page_index,
		int	type,
		AccessibilityTextInfoArray	text_info_array
	)

A callback function used to draw text for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	text_info_array	The array of accessibility text info objects.

Returns: None.

◆ generateContent()

boolean com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.generateContent	(	PDFDoc	pdf_doc,
		int	page_index
	)

A callback function used to generate content for a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.

Returns: true means content generated successfully, while false means not.

◆ getDocumentFileName()

String com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.getDocumentFileName ( PDFDoc pdf_doc )

A callback function used to get the document file name.

Parameters

[in] pdf_doc The PDF document object.

Returns: The document file name.

◆ getTextStringByStringID()

String com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.getTextStringByStringID ( String string_id )

A callback function used to get text string by string ID.

Parameters

[in] string_id The string ID.

Returns: The text string.

◆ onContentChanged()

void com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.onContentChanged	(	PDFDoc	pdf_doc,
		int	page_index,
		boolean	is_notify_self
	)

A callback function used to notify that content has changed on a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	is_notify_self	Whether to notify self.

Returns: None.

◆ release()

void com.foxit.sdk.addon.accessibility.AccessibilityProviderCallback.release ( )

A callback function used to release current callback object itself.

Returns: None.

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ drawLine()

◆ drawRect()

◆ drawText()

◆ generateContent()

◆ getDocumentFileName()

◆ getTextStringByStringID()

◆ onContentChanged()

◆ release()