com.foxit.sdk.fdf.FDFDoc类 参考

类 com.foxit.sdk.fdf.FDFDoc 继承关系图:

Public 成员函数
	FDFDoc (FileReaderCallback file_read) throws com.foxit.sdk.PDFException
	构造函数，使用文件读取回调对象。 更多...
	FDFDoc (int type) throws com.foxit.sdk.PDFException
	构造函数。 更多...
	FDFDoc (String path) throws com.foxit.sdk.PDFException
	构造函数，从现有的FDF或XFDF文件路径。 更多...
	FDFDoc (byte[] buffer) throws com.foxit.sdk.PDFException
	构造函数，从内存缓冲区。 更多...
	FDFDoc (FDFDoc other)
	构造函数，使用另一个FDF文档对象。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
PDFDictionary	getCatalog () throws com.foxit.sdk.PDFException
	获取目录字典。 更多...
PDFDictionary	getFDFDict () throws com.foxit.sdk.PDFException
	从目录字典获取"FDF"条目的字典。 更多...
String	getPDFPath () throws com.foxit.sdk.PDFException
	获取相关PDF文档的路径。 更多...
int	getType () throws com.foxit.sdk.PDFException
	获取当前文档对象的类型。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
boolean	saveAs (String file_path) throws com.foxit.sdk.PDFException
	将当前文档另存为另一个FDF或XFDF文件。 更多...
boolean	saveAs (FileWriterCallback file) throws com.foxit.sdk.PDFException
	将当前文档另存为另一个FDF或XFDF文件。 更多...
boolean	setPDFPath (String pdf_path) throws com.foxit.sdk.PDFException
	设置相关PDF文档的路径。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。 更多...

静态 Public 属性
static final int	e_FDF = 0
	FDF文档类型：FDF。
static final int	e_XFDF = 1
	FDF文档类型：XFDF。

详细描述

FDF（表单数据格式）是一种文件格式，用于交互式表单数据。FDF可用于 向服务器提交表单数据、接收响应并将其合并到交互式表单中。 它还可用于将表单数据导出到独立文件中，这些文件可以存储、电子传输， 并导入回相应的PDF交互式表单。除此之外，FDF还可用于 定义一个容器，用于存放与其应用的PDF文档分离的注释。
XFDF（XML表单数据格式）是基于XML的FDF版本。它具有与FDF相似的功能。
总之，FDF和XFDF包含PDF文档的子集，用于描述交互式表单和注释。
类 FDFDoc 可用于表示FDF或XFDF。FDF文档对象可以通过 文件路径、内存缓冲区、用户自定义实现的 com.foxit.sdk.common.fxcrt.FileReaderCallback 对象和 输入文件流从现有文件构造。FDF文档对象也可以构造为新的FDF或XFDF文档。 此类还提供从FDF或XFDF文件获取或设置某些信息的函数， 并将当前FDF/XFDF保存为另一个文件。
要导入或导出表单字段或注释，请参考函数 pdf.PDFDoc.importFromFDF 、 pdf.PDFDoc.exportToFDF 和 pdf.PDFDoc.exportAnnotToFDF 。

参见

com.foxit.sdk.pdf.PDFDoc

构造及析构函数说明

FDFDoc() [1/5]

com.foxit.sdk.fdf.FDFDoc.FDFDoc

(

FileReaderCallback

file_read

)

throws com.foxit.sdk.PDFException

构造函数，使用文件读取回调对象。

参数

[in]

file_read

指向用户实现的com.foxit.sdk.common.fxcrt.FileReaderCallback 对象的指针， 用于加载FDF或XFDF文档。不应为null。

FDFDoc() [2/5]

com.foxit.sdk.fdf.FDFDoc.FDFDoc

(

int

type

)

throws com.foxit.sdk.PDFException

构造函数。

此构造函数用于构造一个新的FDF文档对象（不包含任何数据）。

参数

[in]

type

FDF文档类型。应为以下值之一： com.foxit.sdk.fdf.FDFDoc.e_FDF , com.foxit.sdk.fdf.FDFDoc.e_XFDF

FDFDoc() [3/5]

com.foxit.sdk.fdf.FDFDoc.FDFDoc

(

String

path

)

throws com.foxit.sdk.PDFException

构造函数，从现有的FDF或XFDF文件路径。

参数

[in]

path

现有FDF/XFDF文件的完整路径。不应为空字符串。

FDFDoc() [4/5]

com.foxit.sdk.fdf.FDFDoc.FDFDoc

(

byte []

buffer

)

throws com.foxit.sdk.PDFException

构造函数，从内存缓冲区。

参数

[in]

buffer

内存缓冲区。FDF或XFDF文件数据应完全加载到此内存缓冲区中。 不应为null。

FDFDoc() [5/5]

com.foxit.sdk.fdf.FDFDoc.FDFDoc

(

FDFDoc

other

)

构造函数，使用另一个FDF文档对象。

参数

[in]

other

另一个FDF文档对象。

成员函数说明

delete()

synchronized void com.foxit.sdk.fdf.FDFDoc.delete

(

)

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

返回

无。

注解

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

getCatalog()

PDFDictionary com.foxit.sdk.fdf.FDFDoc.getCatalog

(

)

throws com.foxit.sdk.PDFException

获取目录字典。

返回

目录字典。如果当前对象表示XFDF文档， 此函数将返回null。

getFDFDict()

PDFDictionary com.foxit.sdk.fdf.FDFDoc.getFDFDict

(

)

throws com.foxit.sdk.PDFException

从目录字典获取"FDF"条目的字典。

返回

目录字典中"FDF"条目的字典。 如果当前对象表示XFDF文档，此函数将返回null。

getPDFPath()

String com.foxit.sdk.fdf.FDFDoc.getPDFPath

(

)

throws com.foxit.sdk.PDFException

获取相关PDF文档的路径。

路径可以是绝对路径或相对路径。

返回

相关PDF文档的文件路径。空字符串表示未找到此类信息。

getType()

int com.foxit.sdk.fdf.FDFDoc.getType

(

)

throws com.foxit.sdk.PDFException

获取当前文档对象的类型。

返回

FDF文档类型。将是以下值之一：
com.foxit.sdk.fdf.FDFDoc.e_FDF , com.foxit.sdk.fdf.FDFDoc.e_XFDF 。

isEmpty()

boolean com.foxit.sdk.fdf.FDFDoc.isEmpty

(

)

检查当前对象是否为空。

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

返回

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

saveAs() [1/2]

boolean com.foxit.sdk.fdf.FDFDoc.saveAs

(

String

file_path

)

throws com.foxit.sdk.PDFException

将当前文档另存为另一个FDF或XFDF文件。

参数

[in]

file_path

新保存的FDF或XFDF文件的完整路径。不应为空字符串。

返回

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

注解

此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此，建议用户按照以下步骤操作：
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。

1. 使用当前函数将当前FDF对象保存到临时文件。此处，此临时文件命名为"temp.tmp"。

2. 确保当前FDF对象已析构。

3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

saveAs() [2/2]

boolean com.foxit.sdk.fdf.FDFDoc.saveAs

(

FileWriterCallback

file

)

throws com.foxit.sdk.PDFException

将当前文档另存为另一个FDF或XFDF文件。

参数

[in]

file

用户实现的 com.foxit.sdk.common.fxcrt.FileWriterCallback 对象，用于保存FDF或XFDF文件。

返回

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

注解

此函数不支持将当前FDF对象直接保存回用于构造当前FDF对象的FDF或XFDF文件。 为此，建议用户按照以下步骤操作：
假设当前FDF对象是从名为"org.fdf"的FDF文件构造的。

1. 使用当前函数将当前FDF对象保存到临时文件。此处，此临时文件命名为"temp.tmp"。

2. 确保当前FDF对象已析构。

3. 删除"org.fdf"并将"temp.tmp"重命名为"org.fdf"。

setPDFPath()

boolean com.foxit.sdk.fdf.FDFDoc.setPDFPath

(

String

pdf_path

)

throws com.foxit.sdk.PDFException

设置相关PDF文档的路径。

参数

[in]

pdf_path

相关PDF文档的路径。可以是绝对路径或相对路径。 不应为空字符串。

返回

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