类 FSTagTreeEditor 继承关系图:
详细描述
此类用于让用户编辑 PDF 文档的标签树（结构树）：查询和修改标签 属性、添加/删除/移动标签、根据选中内容创建标签、将标签更改为人工元素以及 将文档标记为已标记 PDF。 在使用此模块中的任何类或方法之前，请确保已通过 FSLibrary::initialize:key: 函数并使用包含 "Accessibility" 模块的密钥成功初始化福昕 PDF SDK。
函数文档
◆ addNewTag:type:title:()
| - (FSTagTreeItemArray *) addNewTag: | (NSString *) | selected_tag_id | |
| type: | (NSString *) | type | |
| title: | (NSString *) | title | |
向标签树添加一个新标签。
- 参数
-
[in] selected_tag_id 作为父级的已选中标签 ID。
[in] type 标签类型。
[in] title 标签标题。
- 返回
- 更新后的标签树项数组。
◆ addTagForAnnotation:annot:page_index:selected_tag_id:()
| - (FSTagTreeItemArray *) addTagForAnnotation: | (BOOL) | is_tag_annotations | |
| annot: | (FSAnnot*) | annot | |
| page_index: | (int) | page_index | |
| selected_tag_id: | (NSString *) | selected_tag_id | |
为注释添加标签。
- 参数
-
[in] is_tag_annotations 是否为注释添加标签。
[in] annot 注释对象。
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 更新后的标签树项数组。
◆ changeTagToArtifact:artifact_type:artifact_to_side:()
| - (BOOL) changeTagToArtifact: | (NSArray<NSData *> *) | selected_tag_ids | |
| artifact_type: | (FSTagTreeEditorArtifactType) | artifact_type | |
| artifact_to_side: | (FSTagTreeEditorArtifactAttachToSideType) | artifact_to_side | |
将标签更改为人工元素。
- 参数
-
[in] selected_tag_ids 已选中的标签 ID 集合。
[in] artifact_type 人工元素类型。请参考 。
[in] artifact_to_side 人工元素附着边类型。 请参考 。
- 返回
- YES 表示成功，NO 表示失败。
◆ createTagFromSelectionByContent:selected_tag_id:()
| - (FSTagTreeItemArray *) createTagFromSelectionByContent: | (NSArray<NSData *> *) | selected_content_ids | |
| selected_tag_id: | (NSString *) | selected_tag_id | |
根据内容从选中内容创建标签。
- 参数
-
[in] selected_content_ids 已选中的内容 ID 集合。
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 更新后的标签树项数组。
◆ createTagFromSelectionByElement:selected_tag_id:()
| - (FSTagTreeItemArray *) createTagFromSelectionByElement: | (int) | page_index | |
| selected_tag_id: | (NSString *) | selected_tag_id | |
根据元素从选中内容创建标签。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 更新后的标签树项数组。
◆ createTagFromSelectionByTag:last_selected_tag_id:()
| - (FSTagTreeItemArray *) createTagFromSelectionByTag: | (NSArray<NSData *> *) | selected_tag_ids | |
| last_selected_tag_id: | (NSString *) | last_selected_tag_id | |
根据标签从选中内容创建标签。
- 参数
-
[in] selected_tag_ids 已选中的标签 ID 集合。
[in] last_selected_tag_id 最后一个被选中的标签 ID。
- 返回
- 更新后的标签树项数组。
◆ createTagFromSelectionByText:selected_text_rects:selected_tag_id:()
| - (FSTagTreeItemArray *) createTagFromSelectionByText: | (int) | page_index | |
| selected_text_rects: | (FSRectFArray*) | selected_text_rects | |
| selected_tag_id: | (NSString *) | selected_tag_id | |
根据文本从选中内容创建标签。
- 参数
-
[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FSPDFDoc::getPageCount 返回的页面总数。
[in] selected_text_rects 已选中文本的矩形集合。
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 更新后的标签树项数组。
◆ deleteEmptyTags:()
| - (FSTagTreeItemArray *) deleteEmptyTags: | (NSArray<NSData *> *) | selected_tag_ids |
从标签树中删除空标签。
- 参数
-
[in] selected_tag_ids 用于检查空标签的标签 ID 数组。
- 返回
- 更新后的标签树项数组。
◆ deleteTags:()
| - (FSTagTreeItemArray *) deleteTags: | (NSArray<NSData *> *) | selected_tag_ids |
从标签树中删除指定的标签。
- 参数
-
[in] selected_tag_ids 待删除标签 ID 的数组。
- 返回
- 更新后的标签树项数组。
◆ findTagFromSelection:()
| - (NSArray< NSData * > *) findTagFromSelection: | (NSArray<NSData *> *) | selected_tag_ids |
根据选中内容查找标签。
- 参数
-
[in] selected_tag_ids 已选中的标签 ID 集合。
- 返回
- 找到的标签 ID 数组。
◆ getAllContents:()
| - (NSString *) getAllContents: | (NSString *) | selected_tag_id |
获取指定标签项的所有内容。
- 参数
-
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 内容文本。
◆ getContentTreeItemIDsByTagItemID:()
| - (NSArray< NSData * > *) getContentTreeItemIDsByTagItemID: | (NSString *) | selected_tag_id |
根据标签项 ID 获取内容树项 ID。
- 参数
-
[in] selected_tag_id 已选中的标签 ID。
- 返回
- 内容树项 ID 的数组。
◆ getTagPropertyByID:()
| - (FSTagProperty *) getTagPropertyByID: | (NSString *) | item_id |
根据标签项 ID 获取标签属性。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
- 返回
- 标签属性对象。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
◆ getTagTree()
| - (FSTagTreeItemArray *) getTagTree |
获取当前 PDF 文档的标签树。
- 返回
- 标签树项数组。
◆ getTagTreeContextMenuItems:()
| - (FSTagTreeMenuItemDataArray *) getTagTreeContextMenuItems: | (FSTagTreeMenuInputData*) | input_data |
获取标签树的右键菜单项。
- 参数
-
[in] input_data 右键菜单的输入数据。
- 返回
- 菜单项数据的数组。
◆ initWithOther:()
| - (id) initWithOther: | (FSTagTreeEditor*) | other |
构造函数，使用另一个标签编辑器对象构造。
- 参数
-
[in] other 另一个标签编辑器对象。
◆ initWithPdf_doc:()
| - (id) initWithPdf_doc: | (FSPDFDoc*) | pdf_doc |
构造函数。
- 参数
-
[in] pdf_doc 有效的 PDF 文档对象。
◆ isEmpty()
| - (BOOL) isEmpty |
检查当前对象是否为空。
当前对象为空时，表示当前对象不可用。
- 返回
- YES 表示当前对象为空，NO 表示不为空。
◆ moveTags:dest_tag_id:is_moved_as_child:()
| - (FSTagTreeItemArray *) moveTags: | (NSArray<NSData *> *) | source_tag_ids | |
| dest_tag_id: | (NSString *) | dest_tag_id | |
| is_moved_as_child: | (BOOL) | is_moved_as_child | |
在标签树中移动标签。
- 参数
-
[in] dest_tag_id 目标标签 ID。
[in] is_moved_as_child 是否作为目标的子项移动。
- 返回
- 更新后的标签树项数组。
◆ setDocAsTaggedPDF()
| - (BOOL) setDocAsTaggedPDF |
将当前 PDF 文档设置为已标记 PDF。
- 返回
- YES 表示成功，NO 表示失败。
◆ setTagPropertyActualText:actual_text:()
| - (BOOL) setTagPropertyActualText: | (NSString *) | item_id | |
| actual_text: | (NSString *) | actual_text | |
为指定标签项设置标签属性的实际文本。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
[in] actual_text 要设置的实际文本。
- 返回
- YES 表示成功，NO 表示失败。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
◆ setTagPropertyAlternateText:alternate_text:()
| - (BOOL) setTagPropertyAlternateText: | (NSString *) | item_id | |
| alternate_text: | (NSString *) | alternate_text | |
为指定标签项设置标签属性的替代文本。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
[in] alternate_text 要设置的替代文本。
- 返回
- YES 表示成功，NO 表示失败。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
◆ setTagPropertyLanguage:language:()
| - (BOOL) setTagPropertyLanguage: | (NSString *) | item_id | |
| language: | (NSString *) | language | |
为指定标签项设置标签属性的语言。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
[in] language 要设置的语言。
- 返回
- YES 表示成功，NO 表示失败。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
◆ setTagPropertyTitle:title:()
| - (BOOL) setTagPropertyTitle: | (NSString *) | item_id | |
| title: | (NSString *) | title | |
为指定标签项设置标签属性的标题。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
[in] title 要设置的标签标题。
- 返回
- YES 表示成功，NO 表示失败。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
◆ setTagPropertyType:type:()
| - (BOOL) setTagPropertyType: | (NSString *) | item_id | |
| type: | (NSString *) | type | |
为指定标签项设置标签属性的类型。
- 参数
-
[in] item_id 标签项 ID，通过 FSTagTreeEditor::getTagTree 返回的条目中的 FSTagTreeItemData::item_id 获取。
[in] type 要设置的标签类型。
- 返回
- YES 表示成功，NO 表示失败。
- 注解
- item_id 所引用的标签项必须是结构元素（FSTagTreeItemDataTagNodeTypeElement）节点； 标记内容引用（FSTagTreeItemDataTagNodeTypeMarkedContentSeq）、 对象引用（FSTagTreeItemDataTagNodeTypeObject）等引用类节点不具有该属性，将导致调用失败。
