类 com.foxit.sdk.pdf.AnnotationSummary 继承关系图:

Public 成员函数
	AnnotationSummary (PDFDoc document) throws com.foxit.sdk.PDFException
	构造函数。更多...

	AnnotationSummary (AnnotationSummary other)
	构造函数，使用另一个注释摘要对象。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

void	setCallback (AnnotationSummaryCallback callback) throws com.foxit.sdk.PDFException
	为注释摘要设置回调对象。更多...

Progressive	startSummarize (String dest_file_path, AnnotationSummarySettings settings, PauseCallback pause) throws com.foxit.sdk.PDFException
	开始摘要注释。更多...

Progressive	startSummarize (FileWriterCallback dest_file, AnnotationSummarySettings settings, PauseCallback pause) throws com.foxit.sdk.PDFException
	开始摘要注释。更多...

Public 成员函数继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。更多...

详细描述

此类可用于摘要注释并生成 PDF 文件作为结果文档。

构造及析构函数说明

◆ AnnotationSummary() [1/2]

com.foxit.sdk.pdf.AnnotationSummary.AnnotationSummary ( PDFDoc document ) throws com.foxit.sdk.PDFException

构造函数。

参数

[in] document 有效的 PDF 文档。它应该已成功加载。

◆ AnnotationSummary() [2/2]

com.foxit.sdk.pdf.AnnotationSummary.AnnotationSummary ( AnnotationSummary other )

构造函数，使用另一个注释摘要对象。

参数

[in] other 另一个注释摘要对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.AnnotationSummary.delete ( )

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

返回: 无。

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

◆ isEmpty()

boolean com.foxit.sdk.pdf.AnnotationSummary.isEmpty ( )

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

◆ setCallback()

void com.foxit.sdk.pdf.AnnotationSummary.setCallback ( AnnotationSummaryCallback callback ) throws com.foxit.sdk.PDFException

为注释摘要设置回调对象。

如果不调用此函数，表示不使用回调。

参数

[in] callback 用户实现的 AnnotationSummaryCallback 对象。用户可以通过此回调在摘要注释期间更改某些信息/数据。请确保回调对象在当前 AnnotationSummary 对象的生命周期结束前保持有效。
如果这是 null，表示使用默认信息/数据。

返回: 无。

◆ startSummarize() [1/2]

Progressive com.foxit.sdk.pdf.AnnotationSummary.startSummarize	(	String	dest_file_path,
		AnnotationSummarySettings	settings,
		PauseCallback	pause
	)		throws com.foxit.sdk.PDFException

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 AnnotationSummarySettings.setAnnotType 的注释），或相关源 PDF 文档没有任何注释，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnknown 。

参数

[in]	dest_file_path	保存注释摘要结果 PDF 文件的完整路径。这不应该是空字符串。
[in]	settings	用于摘要注释的设置数据。
[in]	pause	决定是否需要暂停摘要过程的暂停对象。这可以是 null，表示在解析过程中不暂停。如果这不是 null，它应该是用户实现的有效暂停对象。默认值：null。

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

◆ startSummarize() [2/2]

Progressive com.foxit.sdk.pdf.AnnotationSummary.startSummarize	(	FileWriterCallback	dest_file,
		AnnotationSummarySettings	settings,
		PauseCallback	pause
	)		throws com.foxit.sdk.PDFException

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 AnnotationSummarySettings.setAnnotType 的注释），或相关源 PDF 文档没有任何注释，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnknown 。

参数

[in]	dest_file	用户实现的 com.foxit.sdk.common.fxcrt.FileWriterCallback 对象，用于以自定义方法将注释摘要数据存储到 PDF 文件作为结果。
[in]	settings	用于摘要注释的设置数据。
[in]	pause	决定是否需要暂停摘要过程的暂停对象。这可以是 null，表示在解析过程中不暂停。如果这不是 null，它应该是用户实现的有效暂停对象。默认值：null。

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

Public 成员函数

详细描述

构造及析构函数说明

◆ AnnotationSummary() [1/2]

◆ AnnotationSummary() [2/2]

成员函数说明

◆ delete()

◆ isEmpty()

◆ setCallback()

◆ startSummarize() [1/2]

◆ startSummarize() [2/2]