Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.objects.StructElement类 参考
类 com.foxit.sdk.pdf.objects.StructElement 继承关系图:

## Public 成员函数
| StructElement ()
| 构造函数。
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
StructTreeEntity | getChild (int index) throws com.foxit.sdk.PDFException
| 通过索引获取子结构树实体。 更多...
int | getChildCount () throws com.foxit.sdk.PDFException
| 获取当前结构元素中子结构树实体的数量。 更多...
String | getElementInfo (int type) throws com.foxit.sdk.PDFException
| 获取结构元素信息。 更多...
StructElement | getParentElement () throws com.foxit.sdk.PDFException
| 获取父结构元素。 更多...
String | getStructureTypeName () throws com.foxit.sdk.PDFException
| 获取结构类型名称。 更多...
boolean | hasElementInfo (int type) throws com.foxit.sdk.PDFException
| 检查特定类型的结构元素信息是否存在。 更多...
void | removeChild (int index) throws com.foxit.sdk.PDFException
| 通过索引删除子结构树实体。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.objects.StructTreeEntity
| StructTreeEntity ()
| 构造函数。
| StructTreeEntity (StructTreeEntity other)
| 拷贝构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
PDFPage | getPage () throws com.foxit.sdk.PDFException
| 获取相关的PDF页面。 更多...
int | getType () throws com.foxit.sdk.PDFException
| 获取结构树实体类型。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void | delete ()
| 直接清除C++相关资源。 更多...

## 静态 Public 属性
static final int | e_ElementInfoTypeActualText = 4
| 结构元素信息类型：Actual Text，表示结构元素的实际文本。
static final int | e_ElementInfoTypeAltDescription = 2
| 结构元素信息类型：Alternative Description，表示结构元素的替代描述。
static final int | e_ElementInfoTypeExpandedForm = 3
| 结构元素信息类型：Expanded Form，表示结构元素的扩展形式。
static final int | e_ElementInfoTypeLanguage = 1
| 结构元素信息类型：Language，表示结构元素中所有文本的 自然语言，除非被嵌套结构元素或标记内容的语言规范覆盖。
static final int | e_ElementInfoTypeTitle = 0
| 结构元素信息类型：Title，表示结构元素的标题。以人类可读形式表示的文本字符串。
静态 Public 属性 继承自 com.foxit.sdk.pdf.objects.StructTreeEntity
static final int | e_StructTreeEntityTypeElement = 0
| 结构树实体类型：Element，表示结构元素。
static final int | e_StructTreeEntityTypeMarkedContent = 1
| 结构树实体类型：MarkedContent，表示标记内容项。
static final int | e_StructTreeEntityTypeObjectContent = 2
| 结构树实体类型：ObjectContent，表示PDF对象内容项， 如注释和XObject。
static final int | e_UnknownType = -1
| 结构树实体类型：未知。

## 详细描述

此类表示结构元素。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.objects.StructElement.delete | ( |  | ) |

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

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getChild()

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

通过索引获取子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数StructElement.getChildCount 返回。

返回
  一个子结构树实体对象。

## ◆ getChildCount()

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

获取当前结构元素中子结构树实体的数量。

返回
  子结构树实体的数量。

## ◆ getElementInfo()

String com.foxit.sdk.pdf.objects.StructElement.getElementInfo | ( | int | type | ) | throws com.foxit.sdk.PDFException

获取结构元素信息。

在获取结构元素信息之前，请确保已调用函数StructElement.hasElementInfo 并返回true（使用相应的类型）。

参数

  [in] | type | 结构元素信息类型。请参考从com.foxit.sdk.pdf.objects.StructElement.e_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。

返回
  结构元素信息字符串。

## ◆ getParentElement()

StructElement com.foxit.sdk.pdf.objects.StructElement.getParentElement | ( |  | ) | throws com.foxit.sdk.PDFException

获取父结构元素。

返回
  父结构元素。如果返回对象的函数StructElement::IsEmpty返回true， 这意味着当前元素没有父元素。

## ◆ getStructureTypeName()

String com.foxit.sdk.pdf.objects.StructElement.getStructureTypeName | ( |  | ) | throws com.foxit.sdk.PDFException

获取结构类型名称。

每个结构元素都应该有一个结构类型，这是一个名称对象，用于标识 结构元素的性质及其在文档中的角色（例如章节、段落或脚注）。 有关更多详细信息，请参考<PDF Reference 1.7>第10.7.3节中对"标准结构类型"的描述或 <PDF Reference 2.0>第14.8.4节中对"标准结构类型"的描述。

返回
  表示当前结构元素的结构类型名称的字符串。

## ◆ hasElementInfo()

boolean com.foxit.sdk.pdf.objects.StructElement.hasElementInfo | ( | int | type | ) | throws com.foxit.sdk.PDFException

检查特定类型的结构元素信息是否存在。

参数

  [in] | type | 结构元素信息类型。请参考从com.foxit.sdk.pdf.objects.StructElement.e_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。

返回
  true表示元素信息类型有元素信息， 而false表示元素信息类型没有元素信息。

## ◆ removeChild()

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

通过索引删除子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数StructElement.getChildCount 返回。

返回
  无。