com.foxit.sdk.addon.comparison.Comparison类 参考

类 com.foxit.sdk.addon.comparison.Comparison 继承关系图:

Public 成员函数
	Comparison (Comparison other)
	带另一个比较对象的构造函数。 更多...
	Comparison (PDFDoc base_doc, PDFDoc compared_doc) throws com.foxit.sdk.PDFException
	从PDF文档对象构造。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
CompareResults	doCompare (int base_page_index, int compared_page_index, int compare_flags) throws com.foxit.sdk.PDFException
	比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。 更多...
PDFDoc	generateComparedDoc (int compare_flags) throws com.foxit.sdk.PDFException
	比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
PDFDoc	generateComparedDoc (int compare_flags, boolean is_show_all_layers) throws com.foxit.sdk.PDFException
	比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...

静态 Public 属性
static final int	e_CompareTypeAll = 0x00000000
	比较所有内容。此值应单独使用。
static final int	e_CompareTypeAnnotation = 0x00000002
	仅比较注释。
static final int	e_CompareTypeText = 0x00000001
	仅比较文本。

详细描述

此类可用于逐页比较一个PDF文件（作为"基本文档"）与另一个PDF文件（作为"比较文档"）。

构造及析构函数说明

Comparison() [1/2]

com.foxit.sdk.addon.comparison.Comparison.Comparison	(	PDFDoc	base_doc,
		PDFDoc	compared_doc
	)		throws com.foxit.sdk.PDFException

从PDF文档对象构造。

参数

[in]	base_doc	作为基本文档的有效PDF文档对象。
[in]	compared_doc	作为比较文档的有效PDF文档对象。

注解

如果在函数common.Library.initialize 中使用的许可证信息中未定义 "Comparison"模块，意味着用户无权使用比较相关功能， 此构造函数将抛出异常com.foxit.sdk.common.Constants.e_ErrNoComparisonModuleRight 。

Comparison() [2/2]

com.foxit.sdk.addon.comparison.Comparison.Comparison

(

Comparison

other

)

带另一个比较对象的构造函数。

参数

[in]

other

另一个比较对象。

成员函数说明

delete()

synchronized void com.foxit.sdk.addon.comparison.Comparison.delete

(

)

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

返回

无。

注解

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

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

doCompare()

CompareResults com.foxit.sdk.addon.comparison.Comparison.doCompare	(	int	base_page_index,
		int	compared_page_index,
		int	compare_flags
	)		throws com.foxit.sdk.PDFException

比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。

参数

[in]	base_page_index	基本文档中的页面索引。有效范围：从0到(base_page_count-1)。 base_page_count由基本文档的函数pdf.PDFDoc.getPageCount 返回。
[in]	compared_page_index	比较文档中的页面索引。有效范围：从0到(compared_page_count-1)。 compared_page_count由比较文档的函数pdf.PDFDoc.getPageCount 返回。
[in]	compare_flags	比较类型，指定在PDF页面中要比较的内容。请参考从 com.foxit.sdk.addon.comparison.Comparison.e_CompareTypeAll 开始的值，这可以是这些值中的一个或某些值的组合。

返回

com.foxit.sdk.addon.comparison.CompareResults 对象。

generateComparedDoc() [1/2]

PDFDoc com.foxit.sdk.addon.comparison.Comparison.generateComparedDoc

(

int

compare_flags

)

throws com.foxit.sdk.PDFException

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

[in]

compare_flags

比较类型，指定在PDF页面中要比较的内容。请参考从 com.foxit.sdk.addon.comparison.Comparison.e_CompareTypeAll 开始的值，这可以是这些值中的一个或组合。

返回

com.foxit.sdk.pdf.PDFDoc 对象，表示输出的比较PDF文档。

generateComparedDoc() [2/2]

PDFDoc com.foxit.sdk.addon.comparison.Comparison.generateComparedDoc	(	int	compare_flags,
		boolean	is_show_all_layers
	)		throws com.foxit.sdk.PDFException

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

[in]	compare_flags	比较类型，指定在PDF页面中要比较的内容。请参考从 com.foxit.sdk.addon.comparison.Comparison.e_CompareTypeAll 开始的值，这可以是这些值中的一个或组合。
[in]	is_show_all_layers	布尔值，用于决定是否显示所有比较结果图层。 true表示默认显示所有比较结果图层，false表示默认仅显示 "文本"和"图像"比较结果图层。

返回

com.foxit.sdk.pdf.PDFDoc 对象，表示输出的比较PDF文档。

isEmpty()

boolean com.foxit.sdk.addon.comparison.Comparison.isEmpty

(

)

检查当前对象是否为空。

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

返回

true表示当前对象为空，false表示不为空。