FSAccessibilityChecker Class Reference

Inheritance diagram for FSAccessibilityChecker:

Instance Methods
(BOOL)	- canCheck
	Check whether the current PDF document can be full checked. More...
(FSAccessibilityCheckResultItemData *)	- changeCheckStateInResultTree:sub_item_data:new_check_state:
	Change check state in result tree. More...
(NSString *)	- getTagTreeNodeIDByCheckResultItemID:item_id:
	Get tag tree node ID by check result item ID. More...
(id)	- initWithOther:
	Constructor, with another checker object. More...
(id)	- initWithPdf_doc:
	Constructor. More...
(BOOL)	- isEmpty
	Check whether current object is empty or not. More...
(FSAccessibilityCheckResultItemData *)	- recheckResult:root_data:
	Recheck by result root. More...
(FSAccessibilityCheckResultItemData *)	- removeSkippedStateInResultTree:root_data:sub_item_data:
	Remove skipped state in result tree. More...
(FSProgressive *)	- startCheck:report_callback:provider:pause:
	Start check for accessibility. More...
(BOOL)	- updateCheckResultReport
	Update check result report. More...
(BOOL)	- updateCheckState: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 FSLibrary::initialize:key: with a key including "Accessibility" module.

See also

FSLibrary

Method Documentation

canCheck()

- (BOOL) canCheck

Check whether the current PDF document can be full checked.

Returns

YES means the document can be full checked, while NO means not.

changeCheckStateInResultTree:sub_item_data:new_check_state:()

- (FSAccessibilityCheckResultItemData *) changeCheckStateInResultTree:		(FSAccessibilityCheckResultItemData*)	root_data
sub_item_data:		(FSAccessibilityCheckResultSubItemData*)	sub_item_data
new_check_state:		(FSCheckState)	new_check_state

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

- (NSString *) getTagTreeNodeIDByCheckResultItemID:		(int)	page_index
item_id:		(NSString *)	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.

initWithOther:()

- (id) initWithOther:

(FSAccessibilityChecker*)

other

Constructor, with another checker object.

Parameters

[in]

other

Another checker object.

initWithPdf_doc:()

- (id) initWithPdf_doc:

(FSPDFDoc*)

pdf_doc

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

isEmpty()

- (BOOL) isEmpty

Check whether current object is empty or not.

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

Returns

YES means current object is empty, while NO means not.

recheckResult:root_data:()

- (FSAccessibilityCheckResultItemData *) recheckResult:		(FSAccessibilityCheckOptions*)	check_options
root_data:		(FSAccessibilityCheckResultItemData*)	root_data

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.

removeSkippedStateInResultTree:root_data:sub_item_data:()

- (FSAccessibilityCheckResultItemData *) removeSkippedStateInResultTree:		(FSAccessibilityCheckOptions*)	check_options
root_data:		(FSAccessibilityCheckResultItemData*)	root_data
sub_item_data:		(FSAccessibilityCheckResultSubItemData*)	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:report_callback:provider:pause:()

- (FSProgressive *) startCheck:		(FSAccessibilityCheckOptions*)	check_options
report_callback:		(id<FSFileStreamCallback>)	report_callback
provider:		(id<FSAccessibilityCheckResultsCallback>)	provider
pause:		(id<FSPauseCallback>)	pause

Start check for accessibility.

Parameters

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

Returns

A progressive object.

updateCheckResultReport()

- (BOOL) updateCheckResultReport

Update check result report.

Returns

YES means success, while NO means not.

updateCheckState:check_state:()

- (BOOL) updateCheckState:		(FSRuleType)	rule_type
check_state:		(FSCheckState)	check_state

Update check state for a specified rule.

Parameters

[in]	rule_type	The check rule type. Please refer to values starting from FSRuleTypeDocPermission and this should be one of these values.
[in]	check_state	The check state. Please refer to values starting from FSCheckStateNone and this should be one of these values.

Returns

YES means success, while NO means not.