Foxit PDF SDK

Public 成员函数 | 所有成员列表
com.foxit.sdk.addon.layoutrecognition.LRContext类 参考
类 com.foxit.sdk.addon.layoutrecognition.LRContext 继承关系图:

## Public 成员函数
| LRContext (PDFPage page) throws com.foxit.sdk.PDFException
| 构造函数，基于PDF页面对象。 更多...
| LRContext (LRContext other)
| 构造函数，使用另一个上下文对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
LRStructureElement | getRootElement () throws com.foxit.sdk.PDFException
| 获取结构树的根元素。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
Progressive | startParse (PauseCallback pause) throws com.foxit.sdk.PDFException
| 开始解析相关PDF页面的布局识别。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void | delete ()
| 直接清除C++相关资源。 更多...

## 详细描述

此类可用于解析布局识别以获取根元素。

## 构造及析构函数说明

## ◆ LRContext() [1/2]

com.foxit.sdk.addon.layoutrecognition.LRContext.LRContext | ( | PDFPage | page | ) | throws com.foxit.sdk.PDFException

构造函数，基于PDF页面对象。

参数

  [in] | page | 有效的PDF页面对象。

注解
  如果在函数common.Library.initialize 中使用的许可证信息中未定义模块"LayoutRecognition"， 这意味着用户无权使用布局识别相关函数，此构造函数将抛出异常com.foxit.sdk.common.Constants.e_ErrNoLayoutRecognitionModuleRight 。

## ◆ LRContext() [2/2]

com.foxit.sdk.addon.layoutrecognition.LRContext.LRContext | ( | LRContext | other | ) |

构造函数，使用另一个上下文对象。

参数

  [in] | other | 另一个上下文对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.addon.layoutrecognition.LRContext.delete | ( |  | ) |

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

返回
  无。

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

## ◆ getRootElement()

LRStructureElement com.foxit.sdk.addon.layoutrecognition.LRContext.getRootElement | ( |  | ) | throws com.foxit.sdk.PDFException

获取结构树的根元素。

在调用此函数之前，请确保当前上下文对象已成功解析； 否则，无法检索有效的根结构元素。

返回
  根元素。

## ◆ isEmpty()

boolean com.foxit.sdk.addon.layoutrecognition.LRContext.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

返回
  true表示当前对象为空，false表示非空。

## ◆ startParse()

Progressive com.foxit.sdk.addon.layoutrecognition.LRContext.startParse | ( | PauseCallback | pause | ) | throws com.foxit.sdk.PDFException

开始解析相关PDF页面的布局识别。

解析可能需要很长时间，所以Foxit PDF SDK使用渐进式处理过程来完成。 如果在解析过程中发生任何错误，此函数将抛出异常。 请参考类 com.foxit.sdk.PDFException 和从 com.foxit.sdk.common.Constants.e_ErrFile 开始的值。

参数

  [in] | pause | 暂停回调对象，决定是否需要暂停解析过程。 这可以是 null，表示在解析过程中不暂停。 如果不是 null，它应该是用户实现的有效暂停对象。 默认值：null。

返回
  渐进对象。请通过函数 common.Progressive.getRateOfProgress 检查当前进度的比率。 如果比率还不是100，调用函数 common.Progressive.resume 继续进度直到完成。