fsdk.AccessibilityChecker Class Reference

Public Member Functions
def	CanCheck ()
	Check whether the current PDF document can be full checked. More...
def	GetTagTreeNodeIDByCheckResultItemID (page_index, item_id)
	Get tag tree node ID by check result item ID. More...
def	IsEmpty ()
	Check whether current object is empty or not. More...
def	RecheckResult (check_options, root_data)
	Recheck by result root. More...
def	RemoveSkippedStateInResultTree (check_options, root_data, sub_item_data)
	Remove skipped state in result tree. More...
def	StartCheck (check_options, report_callback, provider, pause)
	Start check for accessibility. More...
def	UpdateCheckResultReport ()
	Update check result report. More...

Detailed Description

This class represents an accessibility checker for a PDF document: run the full accessibility check, re-check parts of the result tree, change / remove check states and update the check result report. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function fsdk.LibraryInitialize with a key including "Accessibility" module.

See also

fsdk.Library

Member Function Documentation

CanCheck()

def fsdk.AccessibilityChecker.CanCheck

(

)

Check whether the current PDF document can be full checked.

Returns

true means the document can be full checked, while false means not.

GetTagTreeNodeIDByCheckResultItemID()

def fsdk.AccessibilityChecker.GetTagTreeNodeIDByCheckResultItemID	(		page_index,
			item_id
	)

Get tag tree node ID by check result item ID.

Parameters

[in]	page_index	The page index.
[in]	item_id	The check result item ID.

Returns

The tag tree node ID.

IsEmpty()

def fsdk.AccessibilityChecker.IsEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

RecheckResult()

def fsdk.AccessibilityChecker.RecheckResult	(		check_options,
			root_data
	)

Recheck by result root.

Recheck by sub item.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.

Returns

The updated check result item data.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data of check result tree.

Returns

The updated check result item data.

RemoveSkippedStateInResultTree()

def fsdk.AccessibilityChecker.RemoveSkippedStateInResultTree	(		check_options,
			root_data,
			sub_item_data
	)

Remove skipped state in result tree.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.

Returns

The updated check result item data.

StartCheck()

def fsdk.AccessibilityChecker.StartCheck	(		check_options,
			report_callback,
			provider,
			pause
	)

Start check for accessibility.

Parameters

[in]	check_options	The check options. Please refer to AccessibilityCheckOptions .
[in]	report_callback	A stream callback object for report output. This can be null.
[in]	provider	An AccessibilityCheckResultsCallback object for check results.
[in]	pause	A pause object. This can be null.

Returns

A progressive object.

UpdateCheckResultReport()

def fsdk.AccessibilityChecker.UpdateCheckResultReport

(

)

Update check result report.

Returns

true means success, while false means not.