Foxit PDF SDK
com.foxit.sdk.pdf.objects.PDFStructTree类 参考
类 com.foxit.sdk.pdf.objects.PDFStructTree 继承关系图:
com.foxit.sdk.common.Base

Public 成员函数

 PDFStructTree (PDFDoc document) throws com.foxit.sdk.PDFException
 带参数的构造函数。
更多...
 
 PDFStructTree (PDFStructTree other)
 拷贝构造函数。
更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
StructElement getChild (int index) throws com.foxit.sdk.PDFException
 通过索引获取结构元素。
更多...
 
int getChildCount () throws com.foxit.sdk.PDFException
 获取当前PDF结构树中结构元素的数量。
更多...
 
boolean isEmpty ()
 检查当前对象是否为空。
更多...
 
void removeChild (int index) throws com.foxit.sdk.PDFException
 通过索引删除结构元素。
更多...
 

详细描述

PDF结构树是标记PDF文档中的一种常见数据结构。结构树用于 表示文档内容的组织和层次结构。 PDF结构树具有以下特点:

  • PDF结构树也是一个层次结构,顶部节点表示 整个文档,较低的节点表示页面、段落、标题和其他元素。
  • PDF结构树包含有关文档内容的语义信息, 例如标题、段落、表格和列表。此信息用于增强文档的可访问性 和可用性,以及优化其显示和打印;

PDFStructTree 用于与现有的PDF结构树关联。 它提供了在PDF结构树中获取结构元素的函数。

构造及析构函数说明

◆ PDFStructTree() [1/2]

com.foxit.sdk.pdf.objects.PDFStructTree.PDFStructTree ( PDFDoc  document) throws com.foxit.sdk.PDFException

带参数的构造函数。

如果PDF文档中存在PDF结构树, 此函数只是构造一个PDF结构树对象以与该结构树关联。

参数
[in]document有效的PDF文档对象。

◆ PDFStructTree() [2/2]

com.foxit.sdk.pdf.objects.PDFStructTree.PDFStructTree ( PDFStructTree  other)

拷贝构造函数。

参数
[in]other另一个PDF结构树对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.objects.PDFStructTree.delete ( )

直接清除C++相关资源。

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

重载 com.foxit.sdk.common.Base .

◆ getChild()

StructElement com.foxit.sdk.pdf.objects.PDFStructTree.getChild ( int  index) throws com.foxit.sdk.PDFException

通过索引获取结构元素。

参数
[in]index要检索的结构元素的索引。有效范围:从0到(count-1)。 count由函数PDFStructTree.getChildCount 返回。
返回
一个StructElement 对象。

◆ getChildCount()

int com.foxit.sdk.pdf.objects.PDFStructTree.getChildCount ( ) throws com.foxit.sdk.PDFException

获取当前PDF结构树中结构元素的数量。

返回
结构元素数量。

◆ isEmpty()

boolean com.foxit.sdk.pdf.objects.PDFStructTree.isEmpty ( )

检查当前对象是否为空。

当当前对象为空时,这意味着当前对象无用。

返回
true表示当前对象为空,而false表示不为空。

◆ removeChild()

void com.foxit.sdk.pdf.objects.PDFStructTree.removeChild ( int  index) throws com.foxit.sdk.PDFException

通过索引删除结构元素。

参数
[in]index要检索的结构元素的索引。有效范围:从0到(count-1)。 count由函数PDFStructTree.getChildCount 返回。
返回
无。