com.foxit.sdk.addon.compliance.Preflight类 参考

类 com.foxit.sdk.addon.compliance.Preflight 继承关系图:

Public 成员函数
	Preflight ()
	构造函数。
	Preflight (Preflight other)
	带另一个预检对象的构造函数。 更多...
ResultInformation	analyze (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
	分析PDF文件。 更多...
ResultInformation	analyzeAndFixup (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
	分析并修复PDF文件。 更多...
boolean	canFixup (String item_key) throws com.foxit.sdk.PDFException
	检查项目密钥是否可以修复。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
boolean	generateReport (PreflightReportSettingData preflight_report_setting_data, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
	在分析或修复后生成报告。 更多...
boolean	generateXMLReport (String xml_report_file_path, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
	在分析或修复后生成XML报告。 更多...
String	getGroupItemComment (String key) throws com.foxit.sdk.PDFException
	通过密钥获取组项的注释。 更多...
String	getGroupItemName (String key) throws com.foxit.sdk.PDFException
	通过密钥获取组项的名称。 更多...
java.util.ArrayList< java.lang.String >	getGroupNamesArray (int library_type, int operate_type) throws com.foxit.sdk.PDFException
	获取与库类型和操作类型对应的所有组名数组。 更多...
java.util.ArrayList< java.lang.String >	getItemKeysArray (String group_name) throws com.foxit.sdk.PDFException
	使用特定组名获取项目密钥数组。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
void	setPreflightGroupLocalCallback (PreflightGroupLocalCallback callback) throws com.foxit.sdk.PDFException
	为预检组项设置本地化名称和注释回调。 更多...

详细描述

此类表示与指定行业配置文件匹配的分析和修复功能，并执行检查或修复。

构造及析构函数说明

Preflight()

com.foxit.sdk.addon.compliance.Preflight.Preflight

(

Preflight

other

)

带另一个预检对象的构造函数。

参数

[in]

other

另一个预检对象。

成员函数说明

analyze()

ResultInformation com.foxit.sdk.addon.compliance.Preflight.analyze	(	PreflightSettingData	preflight_setting_data,
		ProgressCallback	progress_callback
	)		throws com.foxit.sdk.PDFException

分析PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回

一个 ResultInformation 对象。

analyzeAndFixup()

ResultInformation com.foxit.sdk.addon.compliance.Preflight.analyzeAndFixup	(	PreflightSettingData	preflight_setting_data,
		ProgressCallback	progress_callback
	)		throws com.foxit.sdk.PDFException

分析并修复PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回

一个 ResultInformation 对象。

canFixup()

boolean com.foxit.sdk.addon.compliance.Preflight.canFixup

(

String

item_key

)

throws com.foxit.sdk.PDFException

检查项目密钥是否可以修复。

参数

[in]

item_key

项目密钥。可以通过 Preflight.getItemKeysArray 检索。

返回

true表示可以修复，false表示不能修复。

delete()

synchronized void com.foxit.sdk.addon.compliance.Preflight.delete

(

)

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

返回

无。

注解

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

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

generateReport()

boolean com.foxit.sdk.addon.compliance.Preflight.generateReport	(	PreflightReportSettingData	preflight_report_setting_data,
		ProgressCallback	progress_callback
	)		throws com.foxit.sdk.PDFException

在分析或修复后生成报告。

此方法应在 Preflight.analyze 或 Preflight.analyzeAndFixup 之后调用。

参数

[in]	preflight_report_setting_data	预检报告设置数据。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。

返回

true表示成功，false表示失败。

generateXMLReport()

boolean com.foxit.sdk.addon.compliance.Preflight.generateXMLReport	(	String	xml_report_file_path,
		ProgressCallback	progress_callback
	)		throws com.foxit.sdk.PDFException

在分析或修复后生成XML报告。

此方法应在 Preflight.analyze 或 Preflight.analyzeAndFixup 之后调用。

参数

[in]	xml_report_file_path	用于保存XML报告文件的完整路径。这不应该是空字符串。
[in]	progress_callback	由用户实现的 ProgressCallback 对象，可用于获取进度数据。 可以为null。默认值：null。

返回

true表示成功，false表示失败。

getGroupItemComment()

String com.foxit.sdk.addon.compliance.Preflight.getGroupItemComment

(

String

key

)

throws com.foxit.sdk.PDFException

通过密钥获取组项的注释。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 Preflight.getGroupNamesArray 和 Preflight.getItemKeysArray 接口获取的组项的注释。

getGroupItemName()

String com.foxit.sdk.addon.compliance.Preflight.getGroupItemName

(

String

key

)

throws com.foxit.sdk.PDFException

通过密钥获取组项的名称。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 Preflight.getGroupNamesArray 和 Preflight.getItemKeysArray 接口获取的组项的名称。

getGroupNamesArray()

java.util.ArrayList< java.lang.String > com.foxit.sdk.addon.compliance.Preflight.getGroupNamesArray	(	int	library_type,
		int	operate_type
	)		throws com.foxit.sdk.PDFException

获取与库类型和操作类型对应的所有组名数组。

参数

[in]	library_type	库类型。请参考从 com.foxit.sdk.addon.compliance.PreflightSettingData.e_LibraryTypeFoxit 开始的值， 这应该是这些值之一。
[in]	operate_type	操作类型。请参考从 com.foxit.sdk.addon.compliance.PreflightSettingData.e_OperateTypeProfiles 开始的值， 这应该是这些值之一。

返回

组名数组。

getItemKeysArray()

java.util.ArrayList< java.lang.String > com.foxit.sdk.addon.compliance.Preflight.getItemKeysArray

(

String

group_name

)

throws com.foxit.sdk.PDFException

使用特定组名获取项目密钥数组。

参数

[in]

group_name

可以从函数 Preflight.getGroupNamesArray 获取的组名。

返回

项目密钥数组。

isEmpty()

boolean com.foxit.sdk.addon.compliance.Preflight.isEmpty

(

)

检查当前对象是否为空。

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

返回

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

setPreflightGroupLocalCallback()

void com.foxit.sdk.addon.compliance.Preflight.setPreflightGroupLocalCallback

(

PreflightGroupLocalCallback

callback

)

throws com.foxit.sdk.PDFException

为预检组项设置本地化名称和注释回调。

此回调由 Preflight.getGroupItemName 和 Preflight.getGroupItemComment 使用，以提供组项的本地化名称和注释。当回调中有给定密钥的本地化字符串时， 将使用它；否则将使用默认的库字符串。

参数

[in]

callback

提供 PreflightGroupLocalCallback 本地化名称和注释的回调对象。

返回

无。