类 FSAccessibilityChecker 继承关系图:
构造函数 | |
| (BOOL) | - canCheck |
| 检查当前 PDF 文档是否可以进行完整检查。 更多... | |
| (FSAccessibilityCheckResultItemData *) | - changeCheckStateInResultTree:sub_item_data:new_check_state: |
| 更改结果树中的检查状态。 更多... | |
| (NSString *) | - getTagTreeNodeIDByCheckResultItemID:item_id: |
| 根据检查结果项 ID 获取标签树节点 ID。 更多... | |
| (id) | - initWithOther: |
| 构造函数，使用另一个检查器对象构造。 更多... | |
| (id) | - initWithPdf_doc: |
| 构造函数。 更多... | |
| (BOOL) | - isEmpty |
| 检查当前对象是否为空。 更多... | |
| (FSAccessibilityCheckResultItemData *) | - recheckResult:root_data: |
| 按结果根节点重新检查。 更多... | |
| (FSAccessibilityCheckResultItemData *) | - removeSkippedStateInResultTree:root_data:sub_item_data: |
| 移除结果树中的"已跳过"状态。 更多... | |
| (FSProgressive *) | - startCheck:report_callback:provider:pause: |
| 开始进行可访问性检查。 更多... | |
| (BOOL) | - updateCheckResultReport |
| 更新检查结果报告。 更多... | |
| (BOOL) | - updateCheckState:check_state: |
| 更新指定规则的检查状态。 更多... | |
详细描述
此类表示用于 PDF 文档的可访问性检查器：执行完整的可访问性 检查、对结果树的部分内容重新检查、更改/移除检查状态以及更新检查 结果报告。 在使用此模块中的任何类或方法之前，请确保已通过 FSLibrary::initialize:key: 函数并使用包含 "Accessibility" 模块的密钥成功初始化福昕 PDF SDK。
函数文档
◆ canCheck()
| - (BOOL) canCheck |
检查当前 PDF 文档是否可以进行完整检查。
- 返回
- YES 表示该文档可以进行完整检查，NO 表示不可以。
◆ 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 | |
更改结果树中的检查状态。
- 参数
-
[in] root_data 检查结果树的根数据。
[in] sub_item_data 子项数据。
[in] new_check_state 新的检查状态。
- 返回
- 更新后的检查结果项数据。
◆ getTagTreeNodeIDByCheckResultItemID:item_id:()
| - (NSString *) getTagTreeNodeIDByCheckResultItemID: | (int) | page_index | |
| item_id: | (NSString *) | item_id | |
根据检查结果项 ID 获取标签树节点 ID。
- 参数
-
[in] page_index 页面索引。
[in] item_id 检查结果项 ID。
- 返回
- 标签树节点 ID。
◆ initWithOther:()
| - (id) initWithOther: | (FSAccessibilityChecker*) | other |
构造函数，使用另一个检查器对象构造。
- 参数
-
[in] other 另一个检查器对象。
◆ initWithPdf_doc:()
| - (id) initWithPdf_doc: | (FSPDFDoc*) | pdf_doc |
构造函数。
- 参数
-
[in] pdf_doc 有效的 PDF 文档对象。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当前对象为空时，表示当前对象不可用。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
◆ recheckResult:root_data:()
| - (FSAccessibilityCheckResultItemData *) recheckResult: | (FSAccessibilityCheckOptions*) | check_options | |
| root_data: | (FSAccessibilityCheckResultItemData*) | root_data | |
按结果根节点重新检查。
- 参数
-
[in] check_options 检查选项。
[in] root_data 检查结果树的根数据。
- 返回
- 更新后的检查结果项数据。
◆ removeSkippedStateInResultTree:root_data:sub_item_data:()
| - (FSAccessibilityCheckResultItemData *) removeSkippedStateInResultTree: | (FSAccessibilityCheckOptions*) | check_options | |
| root_data: | (FSAccessibilityCheckResultItemData*) | root_data | |
| sub_item_data: | (FSAccessibilityCheckResultSubItemData*) | sub_item_data | |
移除结果树中的"已跳过"状态。
- 参数
-
[in] check_options 检查选项。
[in] root_data 检查结果树的根数据。
[in] sub_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 | |
开始进行可访问性检查。
- 参数
-
[in] check_options 检查选项。请参考 FSAccessibilityCheckOptions 。
[in] report_callback 用于报告输出的流回调对象。此参数可为 nil。
[in] provider 用于获取检查结果的 对象。
[in] pause 暂停对象。此参数可为 nil。
- 返回
- 一个渐进式（Progressive）对象。
◆ updateCheckResultReport()
| - (BOOL) updateCheckResultReport |
更新检查结果报告。
- 返回
- YES 表示成功，NO 表示失败。
◆ updateCheckState:check_state:()
| - (BOOL) updateCheckState: | (FSRuleType) | rule_type | |
| check_state: | (FSCheckState) | check_state | |
更新指定规则的检查状态。
- 参数
-
[in] rule_type 检查规则类型。请参考从 FSRuleTypeDocPermission 开始的值，本参数应为其中之一。
[in] check_state 检查状态。请参考从 FSCheckStateNone 开始的值，本参数应为其中之一。
- 返回
- YES 表示成功，NO 表示失败。
