类 FSReadingOrder 继承关系图:
详细描述
此类表示用于 PDF 文档辅助功能阅读顺序操作的阅读顺序。 使用此模块中的任何类或方法之前，请确保已通过带有 "Accessibility" 模块授权的 key 调用 FSLibrary::initialize:key: 函数成功初始化 Foxit PDF SDK。
函数文档
◆ addOrderDataForRect:rect:()
| - (FSRectFArray *) addOrderDataForRect: | (int) | page_index | |
| rect: | (FSRectF*) | rect | |
根据选中的矩形区域添加顺序数据。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] rect 选中的矩形区域。
- 返回
- 矩形数组。
◆ applyReadingOrder:selected_rect:()
| - (BOOL) applyReadingOrder: | (int) | page_index | |
| selected_rect: | (FSRectFArray*) | selected_rect | |
根据选中的矩形区域，为指定页面应用阅读顺序。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] selected_rect 用于应用阅读顺序的选中矩形区域数组。
- 返回
- YES 表示成功，NO 表示不成功。
◆ canMoveDataOrder:select_info_array:dest_move_item:()
| - (BOOL) canMoveDataOrder: | (int) | page_index | |
| select_info_array: | (FSTreeItemInfoArray*) | select_info_array | |
| dest_move_item: | (FSTreeItemInfo*) | dest_move_item | |
检查数据顺序是否可以移动。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] select_info_array 选中信息数组。
[in] dest_move_item 目标移动项。
- 返回
- YES 表示数据顺序可以移动，NO 表示不可以移动。
◆ canSelectTableCellAtPoint:point:()
| - (FSReadingOrderTableSelectResult) canSelectTableCellAtPoint: | (FSPDFPage*) | page | |
| point: | (FSPointF*) | point | |
检查鼠标在给定点按下时是否可以选择表格单元格。
- 参数
-
[in] page PDF 页面对象。
[in] point 点，采用 PDF 坐标系（PDFPage）。
- 返回
- 表格选择结果。请参见从 FSReadingOrderTableSelectResultNone 开始的值。
◆ clearPageStructInfo:()
| - (void) clearPageStructInfo: | (FSPDFPage*) | page |
清除页面结构信息。
- 参数
-
[in] page PDF 页面对象。
- 返回
- 无。
◆ deleteOrderDataStructInfo:src_order_index_array:is_loaded:()
| - (int) deleteOrderDataStructInfo: | (FSPDFPage*) | page | |
| src_order_index_array: | (FSInt32Array*) | src_order_index_array | |
| is_loaded: | (BOOL) | is_loaded | |
删除顺序数据结构信息。
- 参数
-
[in] page PDF 页面对象。
[in] src_order_index_array 源顺序索引数组。
[in] is_loaded 页面是否已加载。
- 返回
- 已删除的数量。
◆ drawReadingOrderItems:()
| - (BOOL) drawReadingOrderItems: | (int) | page_index |
开始绘制指定页面的阅读顺序项。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
- 返回
- YES 表示成功，NO 表示不成功。
◆ endEditTable()
| - (BOOL) endEditTable |
结束编辑表格。
- 返回
- YES 表示成功，NO 表示不成功。
◆ generateTableHeaderIDs()
| - (BOOL) generateTableHeaderIDs |
自动生成表格表头 ID。
- 返回
- YES 表示成功，NO 表示不成功。
◆ getAllLeafChildrenByContentItemID:content_item_id:()
| - (NSArray< NSData * > *) getAllLeafChildrenByContentItemID: | (FSContentTreeItemArray*) | content_tree | |
| content_item_id: | (NSString *) | content_item_id | |
根据内容项 ID 获取所有叶子子项。
- 参数
-
[in] content_tree 内容树。
[in] content_item_id 内容项 ID。
- 返回
- 叶子子项 ID 数组。
◆ getContentTree()
| - (FSContentTreeItemArray *) getContentTree |
获取内容树。
- 返回
- 内容树项数组。
◆ getCurrentTableHeaderIDs()
| - (NSArray< NSString * > *) getCurrentTableHeaderIDs |
获取当前表格的所有表头 ID。
- 返回
- 表头 ID 数组。
◆ getReadingOrderTreeItems()
| - (FSTreeItemArray *) getReadingOrderTreeItems |
获取阅读顺序树项。
- 返回
- 阅读顺序树项数组。
◆ getSelectedTableCellAttributes()
| - (FSTableCellAttributeArray *) getSelectedTableCellAttributes |
获取选中的表格单元格属性。
- 返回
- 单元格属性对象数组。
◆ getTableSummary:()
| - (NSString *) getTableSummary: | (FSPDFPage*) | page |
获取表格摘要。
- 参数
-
[in] page PDF 页面对象。
- 返回
- 表格摘要文本。
◆ hasHeaderID:()
| - (BOOL) hasHeaderID: | (NSString *) | header_id |
检查当前表格表头 ID 是否已存在。
- 参数
-
[in] header_id 要检查的表头 ID。
- 返回
- YES 表示该表头 ID 已存在，NO 表示不存在。
◆ hasMissingHeaderIDs()
| - (BOOL) hasMissingHeaderIDs |
检查当前表格是否缺少表头 ID。
- 返回
- YES 表示当前表格缺少表头 ID，NO 表示未缺少。
◆ initWithOther:()
| - (id) initWithOther: | (FSReadingOrder*) | other |
构造函数，使用另一个阅读顺序对象。
- 参数
-
[in] other 另一个阅读顺序对象。
◆ initWithPdf_doc:()
| - (id) initWithPdf_doc: | (FSPDFDoc*) | pdf_doc |
构造函数。
- 参数
-
[in] pdf_doc 有效的 PDF 文档对象。
◆ isEditingTable()
| - (BOOL) isEditingTable |
检查是否已开始表格编辑。
- 返回
- YES 表示已开始表格编辑，NO 表示未开始。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
- 返回
- YES 表示当前对象为空，NO 表示非空。
◆ moveOrderData:src_order_index_array:dest_order_index:()
| - (int) moveOrderData: | (int) | page_index | |
| src_order_index_array: | (FSInt32Array*) | src_order_index_array | |
| dest_order_index: | (int) | dest_order_index | |
移动数据顺序。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] src_order_index_array 源顺序索引数组。
[in] dest_order_index 目标顺序索引。
- 返回
- 已移动的数量。
◆ removeOrderDataForRect:rect:()
| - (FSRectFArray *) removeOrderDataForRect: | (int) | page_index | |
| rect: | (FSRectF*) | rect | |
根据选中的矩形区域移除顺序数据。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] rect 选中的矩形区域。
- 返回
- 矩形数组。
◆ selectTableAtPoint:point:()
| - (BOOL) selectTableAtPoint: | (int) | page_index | |
| point: | (FSPointF*) | point | |
选中页面上指定点处的表格（如果存在）。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] point 用于定位表格的点，使用 PDF 页面坐标系。
- 返回
- YES 表示在指定点处找到并选中了表格，NO 表示未找到。
◆ selectTableCellAtPoint:point:region_selected:appended:()
| - (FSReadingOrderTableSelectResult) selectTableCellAtPoint: | (FSPDFPage*) | page | |
| point: | (FSPointF*) | point | |
| region_selected: | (FSRectFArray*) | region_selected | |
| appended: | (BOOL) | appended | |
鼠标抬起时通过点选择表格单元格。
- 参数
-
[in] page PDF 页面对象。
[in] point 点。
[out] region_selected 选中区域数组。
[in] appended 是否追加选择。
- 返回
- 表格选择结果。请参见从 FSReadingOrderTableSelectResultNone 开始的值。
◆ selectTableCellAtRect:rect:region_selected:appended:()
| - (FSReadingOrderTableSelectResult) selectTableCellAtRect: | (FSPDFPage*) | page | |
| rect: | (FSRectF*) | rect | |
| region_selected: | (FSRectFArray*) | region_selected | |
| appended: | (BOOL) | appended | |
鼠标抬起时通过矩形区域选择表格单元格。
- 参数
-
[in] page PDF 页面对象。
[in] rect 矩形区域。
[out] region_selected 选中区域数组。
[in] appended 是否追加选择。
- 返回
- 表格选择结果。请参见从 FSReadingOrderTableSelectResultNone 开始的值。
◆ setOrderTypeForSelectedContent:()
| - (BOOL) setOrderTypeForSelectedContent: | (FSReadingOrderStructureType) | structure_type |
根据选中的矩形区域设置顺序类型。
- 参数
-
[in] structure_type 结构类型。请参见从 开始的值， 该值应为其中之一。
- 返回
- YES 表示成功，NO 表示不成功。
◆ setOrderTypeForSelectedTreeItems:select_info_array:()
| - (BOOL) setOrderTypeForSelectedTreeItems: | (FSReadingOrderStructureType) | structure_type | |
| select_info_array: | (FSTreeItemInfoArray*) | select_info_array | |
根据选中的树项设置顺序类型。
- 参数
-
[in] structure_type 结构类型。请参见 。
[in] select_info_array 选中信息数组。
- 返回
- YES 表示成功，NO 表示不成功。
◆ setReadingOrderOptions:()
| - (void) setReadingOrderOptions: | (FSReadingOrderOptions*) | options |
◆ setSelectedTableCellAttributes:change_id_enabled:need_change_ids:()
| - (BOOL) setSelectedTableCellAttributes: | (FSTableCellAttribute*) | cell_attribute | |
| change_id_enabled: | (BOOL) | change_id_enabled | |
| need_change_ids: | (BOOL) | need_change_ids | |
设置选中的表格单元格属性。
- 参数
-
[in] cell_attribute 要设置的单元格属性。
[in] change_id_enabled 是否允许更改 ID。
[in] need_change_ids 是否更改 ID。
- 返回
- YES 表示成功，NO 表示不成功。
◆ setTableSummary:table_summary:()
| - (BOOL) setTableSummary: | (FSPDFPage*) | page | |
| table_summary: | (NSString *) | table_summary | |
设置表格摘要。
- 参数
-
[in] page PDF 页面对象。
[in] table_summary 表格摘要文本。
- 返回
- YES 表示成功，NO 表示不成功。
◆ startEditTable:()
| - (BOOL) startEditTable: | (FSPDFPage*) | page |
开始编辑表格。
- 参数
-
[in] page PDF 页面对象。
- 返回
- YES 表示成功，NO 表示不成功。
◆ startEditTableAtPoint:point:()
开始编辑页面上指定点处的表格（如果存在）。
- 参数
-
[in] page PDF 页面对象。
[in] point 用于定位待编辑表格的点，采用 PDF 坐标系（PDFPage）。
- 返回
- YES 表示在指定点处找到表格并成功开始编辑，NO 表示未找到或开始编辑失败。
◆ synchronizeTable()
| - (void) synchronizeTable |
同步表格。
- 返回
- 无。
