foxit.addon.accessibility.AccessibilityChecker Class Reference

Inheritance diagram for foxit.addon.accessibility.AccessibilityChecker:

Public Member Functions
	AccessibilityChecker (PDFDoc pdf_doc)
	Constructor. More...
	AccessibilityChecker (AccessibilityChecker other)
	Constructor, with another checker object. More...
bool	CanCheck ()
	Check whether the current PDF document can be full checked. More...
AccessibilityCheckResultItemData	ChangeCheckStateInResultTree (AccessibilityCheckResultItemData root_data, AccessibilityCheckResultSubItemData sub_item_data, CheckState new_check_state)
	Change check state in result tree. More...
string	GetTagTreeNodeIDByCheckResultItemID (int page_index, string item_id)
	Get tag tree node ID by check result item ID. More...
bool	IsEmpty ()
	Check whether current object is empty or not. More...
AccessibilityCheckResultItemData	RecheckResult (AccessibilityCheckOptions check_options, AccessibilityCheckResultItemData root_data)
	Recheck by result root. More...
AccessibilityCheckResultItemData	RecheckResult (AccessibilityCheckOptions check_options, AccessibilityCheckResultItemData root_data, AccessibilityCheckResultSubItemData sub_item_data)
	Recheck by sub item. More...
AccessibilityCheckResultItemData	RemoveSkippedStateInResultTree (AccessibilityCheckOptions check_options, AccessibilityCheckResultItemData root_data, AccessibilityCheckResultSubItemData sub_item_data)
	Remove skipped state in result tree. More...
Progressive	StartCheck (AccessibilityCheckOptions check_options, StreamCallback report_callback, AccessibilityCheckResultsCallback provider, PauseCallback pause)
	Start check for accessibility. More...
bool	UpdateCheckResultReport ()
	Update check result report. More...
bool	UpdateCheckState (RuleType rule_type, CheckState check_state)
	Update check state for a specified rule. 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 common.Library.Initialize with a key including "Accessibility" module.

See also

foxit.common.Library

Constructor & Destructor Documentation

AccessibilityChecker() [1/2]

foxit.addon.accessibility.AccessibilityChecker.AccessibilityChecker ( PDFDoc  pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityChecker() [2/2]

foxit.addon.accessibility.AccessibilityChecker.AccessibilityChecker ( AccessibilityChecker  other )

inline

Constructor, with another checker object.

Parameters

[in]

other

Another checker object.

Member Function Documentation

CanCheck()

bool foxit.addon.accessibility.AccessibilityChecker.CanCheck ( )

inline

Check whether the current PDF document can be full checked.

Returns

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

ChangeCheckStateInResultTree()

AccessibilityCheckResultItemData foxit.addon.accessibility.AccessibilityChecker.ChangeCheckStateInResultTree ( AccessibilityCheckResultItemData  root_data, AccessibilityCheckResultSubItemData  sub_item_data, CheckState  new_check_state  )

inline

Change check state in result tree.

Parameters

[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.
[in]	new_check_state	The new check state.

Returns

The updated check result item data.

GetTagTreeNodeIDByCheckResultItemID()

string foxit.addon.accessibility.AccessibilityChecker.GetTagTreeNodeIDByCheckResultItemID ( int  page_index, string  item_id  )

inline

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()

bool foxit.addon.accessibility.AccessibilityChecker.IsEmpty ( )

inline

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() [1/2]

AccessibilityCheckResultItemData foxit.addon.accessibility.AccessibilityChecker.RecheckResult ( AccessibilityCheckOptions  check_options, AccessibilityCheckResultItemData  root_data  )

inline

Recheck by result root.

Parameters

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

Returns

The updated check result item data.

RecheckResult() [2/2]

AccessibilityCheckResultItemData foxit.addon.accessibility.AccessibilityChecker.RecheckResult ( AccessibilityCheckOptions  check_options, AccessibilityCheckResultItemData  root_data, AccessibilityCheckResultSubItemData  sub_item_data  )

inline

Recheck by sub item.

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()

AccessibilityCheckResultItemData foxit.addon.accessibility.AccessibilityChecker.RemoveSkippedStateInResultTree ( AccessibilityCheckOptions  check_options, AccessibilityCheckResultItemData  root_data, AccessibilityCheckResultSubItemData  sub_item_data  )

inline

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()

Progressive foxit.addon.accessibility.AccessibilityChecker.StartCheck ( AccessibilityCheckOptions  check_options, StreamCallback  report_callback, AccessibilityCheckResultsCallback  provider, PauseCallback  pause  )

inline

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()

bool foxit.addon.accessibility.AccessibilityChecker.UpdateCheckResultReport ( )

inline

Update check result report.

Returns

true means success, while false means not.

UpdateCheckState()

bool foxit.addon.accessibility.AccessibilityChecker.UpdateCheckState ( RuleType  rule_type, CheckState  check_state  )

inline

Update check state for a specified rule.

Parameters

[in]	rule_type	The check rule type. Please refer to values starting from foxit.addon.accessibility.RuleType.e_RuleTypeDocPermission and this should be one of these values.
[in]	check_state	The check state. Please refer to values starting from foxit.addon.accessibility.CheckState.e_CheckStateNone and this should be one of these values.

Returns

true means success, while false means not.