Foxit PDF SDK

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

## Public 成员函数
| FileSpec (PDFDoc document) throws com.foxit.sdk.PDFException
| 构造函数。 更多...
| FileSpec (PDFDoc document, PDFObject pdf_object) throws com.foxit.sdk.PDFException
| 构造函数，从PDF文档中的现有文件规范PDF对象构造。 更多...
| FileSpec (FileSpec other)
| 构造函数，使用另一个文件规范对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | embed (String file_path) throws com.foxit.sdk.PDFException
| 嵌入由文件路径指定的文件的全部内容。 更多...
boolean | embed (PDFObject pdf_object) throws com.foxit.sdk.PDFException
| （仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时， 嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。 更多...
boolean | embed (StreamCallback stream) throws com.foxit.sdk.PDFException
| 使用 com.foxit.sdk.common.fxcrt.StreamCallback 嵌入文件。 更多...
boolean | exportToFile (String path) throws com.foxit.sdk.PDFException
| 将当前文件规范中表示的文件数据直接导出到文件中。 更多...
boolean | exportToFileStream (StreamCallback stream) throws com.foxit.sdk.PDFException
| 通过流回调对象导出当前文件规范中表示的文件数据。 更多...
int | getAssociteFileRelationship () throws com.foxit.sdk.PDFException
| （仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。 更多...
byte [] | getChecksum () throws com.foxit.sdk.PDFException
| 获取嵌入文件的校验和。 更多...
int | getCompressedEmbeddedFileSize () throws com.foxit.sdk.PDFException
| 获取嵌入文件的压缩文件大小。 更多...
DateTime | getCreationDateTime () throws com.foxit.sdk.PDFException
| 获取关于嵌入文件创建时间的创建日期和时间。 更多...
String | getDescription () throws com.foxit.sdk.PDFException
| 获取与当前文件规范关联的描述性文本。 更多...
PDFDictionary | getDict () throws com.foxit.sdk.PDFException
| 获取当前文件规范的PDF字典。 更多...
FileReaderCallback | getFileData () throws com.foxit.sdk.PDFException
| 获取嵌入文件的文件数据。 更多...
String | getFileName () throws com.foxit.sdk.PDFException
| 获取文件名。 更多...
int | getFileSize () throws com.foxit.sdk.PDFException
| 获取嵌入文件的大小（未压缩文件大小）。 更多...
DateTime | getModifiedDateTime () throws com.foxit.sdk.PDFException
| 获取关于嵌入文件最后修改时间的修改日期和时间。 更多...
String | getSubtype () throws com.foxit.sdk.PDFException
| （仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 获取嵌入文件的"Subtype"键的MIME类型值。 更多...
boolean | isEmbedded () throws com.foxit.sdk.PDFException
| 检查当前文件规范对象是否表示嵌入文件。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
void | setAssociteFileRelationship (int associfile_relationship) throws com.foxit.sdk.PDFException
| （仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。 更多...
void | setChecksum (byte[] checksum) throws com.foxit.sdk.PDFException
| 为嵌入文件设置校验和。（不影响本地文件） 更多...
void | setCreationDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
| 为嵌入文件设置创建日期和时间。（不影响本地文件） 更多...
void | setDescription (String description) throws com.foxit.sdk.PDFException
| 设置与当前文件规范关联的描述性文本。 更多...
void | setFileName (String file_name) throws com.foxit.sdk.PDFException
| 设置文件名。 更多...
void | setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
| 为嵌入文件设置最后修改日期和时间。（不影响本地文件） 更多...
void | setSubtype (String subtype) throws com.foxit.sdk.PDFException
| （仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件） 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void | delete ()
| 直接清除C++相关资源。 更多...

## 详细描述

PDF文件可以通过使用文件规范来引用另一个文件的内容。 文件规范可以简单地表示另一个文件的文件路径，或表示另一个文件的全部内容， 该内容被嵌入到当前PDF文件中。

## 构造及析构函数说明

## ◆ FileSpec() [1/3]

com.foxit.sdk.pdf.FileSpec.FileSpec | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException

构造函数。

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

参数

  [in] | document | 一个有效的PDF文档对象，新的文件规范对象将属于该文档。

## ◆ FileSpec() [2/3]

com.foxit.sdk.pdf.FileSpec.FileSpec | ( | PDFDoc | document,
|  | PDFObject | pdf_object
| ) |  | throws com.foxit.sdk.PDFException

构造函数，从PDF文档中的现有文件规范PDF对象构造。

参数

  [in] | document | 一个有效的PDF文档对象，文件规范PDF对象属于该文档。
  [in] | pdf_object | 一个有效的PDF对象，表示PDF文档中的现有文件规范对象。 它应该是字典对象或PDF引用对象： 如果是PDF字典对象，它应该是文件规范字典。 如果是PDF引用对象，它应该引用文件规范字典。 此PDF对象可以从类型为 com.foxit.sdk.pdf.objects.PDFNameTree.e_EmbeddedFiles 的 com.foxit.sdk.pdf.objects.PDFNameTree 中检索。

## ◆ FileSpec() [3/3]

com.foxit.sdk.pdf.FileSpec.FileSpec | ( | FileSpec | other | ) |

构造函数，使用另一个文件规范对象。

参数

  [in] | other | 另一个文件规范对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.FileSpec.delete | ( |  | ) |

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

返回
  无。

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

## ◆ embed() [1/3]

boolean com.foxit.sdk.pdf.FileSpec.embed | ( | String | file_path | ) | throws com.foxit.sdk.PDFException

嵌入由文件路径指定的文件的全部内容。

当此函数成功时，指定文件的全部内容将被嵌入到 当前文件规范所属的PDF文档中。

参数

  [in] | file_path | 现有本地文件的完整路径。

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

## ◆ embed() [2/3]

boolean com.foxit.sdk.pdf.FileSpec.embed | ( | PDFObject | pdf_object | ) | throws com.foxit.sdk.PDFException

（仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时， 嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。

当此函数成功时，指定PDF流对象的全部内容将被嵌入到 当前文件规范所属的PDF文档中。

参数

  [in] | pdf_object | 一个有效的PDF对象。它应该是PDF流对象或引用PDF流对象的PDF引用对象。

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

## ◆ embed() [3/3]

boolean com.foxit.sdk.pdf.FileSpec.embed | ( | StreamCallback | stream | ) | throws com.foxit.sdk.PDFException

使用 com.foxit.sdk.common.fxcrt.StreamCallback 嵌入文件。

当此函数成功时，请保持输入的流回调对象有效， 直到PDF文件（当前文件规范所属的）被保存或关闭。

参数

  [in] | stream | 用户实现的 com.foxit.sdk.common.fxcrt.StreamCallback 对象， 用于读取文件内容。

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

## ◆ exportToFile()

boolean com.foxit.sdk.pdf.FileSpec.exportToFile | ( | String | path | ) | throws com.foxit.sdk.PDFException

将当前文件规范中表示的文件数据直接导出到文件中。

参数

  [in] | path | 将保存数据的文件的完整路径。

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

## ◆ exportToFileStream()

boolean com.foxit.sdk.pdf.FileSpec.exportToFileStream | ( | StreamCallback | stream | ) | throws com.foxit.sdk.PDFException

通过流回调对象导出当前文件规范中表示的文件数据。

参数

  [in] | stream | 用户实现的 com.foxit.sdk.common.fxcrt.StreamCallback 对象，用于保存文件数据。

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

## ◆ getAssociteFileRelationship()

int com.foxit.sdk.pdf.FileSpec.getAssociteFileRelationship | ( |  | ) | throws com.foxit.sdk.PDFException

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。

返回
  关联文件关系。请参考从 com.foxit.sdk.pdf.AssociatedFiles.e_RelationshipSource 开始的值，这应该是这些值中的一个。

## ◆ getChecksum()

DX_BYTE_ARRAY com.foxit.sdk.pdf.FileSpec.getChecksum | ( |  | ) | throws com.foxit.sdk.PDFException

获取嵌入文件的校验和。

此函数仅在当前文件规范对象表示嵌入文件时有用。 16字节字符串，是未压缩嵌入文件字节的校验和。 校验和通过对嵌入文件流的字节应用标准MD5消息摘要算法来计算。
如果当前文件规范对象不表示嵌入文件，此函数将返回空字符串。

返回
  校验和字符串。

## ◆ getCompressedEmbeddedFileSize()

int com.foxit.sdk.pdf.FileSpec.getCompressedEmbeddedFileSize | ( |  | ) | throws com.foxit.sdk.PDFException

获取嵌入文件的压缩文件大小。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回
  嵌入文件的压缩文件大小。

## ◆ getCreationDateTime()

DateTime com.foxit.sdk.pdf.FileSpec.getCreationDateTime | ( |  | ) | throws com.foxit.sdk.PDFException

获取关于嵌入文件创建时间的创建日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将 返回一个所有值都为0的日期和时间对象。

返回
  嵌入文件的创建日期时间。

## ◆ getDescription()

String com.foxit.sdk.pdf.FileSpec.getDescription | ( |  | ) | throws com.foxit.sdk.PDFException

获取与当前文件规范关联的描述性文本。

返回
  描述性文本。

## ◆ getDict()

PDFDictionary com.foxit.sdk.pdf.FileSpec.getDict | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前文件规范的PDF字典。

返回
  PDF字典对象。如果有任何错误，此函数将返回null。

## ◆ getFileData()

FileReaderCallback com.foxit.sdk.pdf.FileSpec.getFileData | ( |  | ) | throws com.foxit.sdk.PDFException

获取嵌入文件的文件数据。

返回
  一个 com.foxit.sdk.common.fxcrt.FileReaderCallback 对象。用户可以调用 com.foxit.sdk.common.fxcrt.FileReaderCallback 类中的函数来读取文件数据。

## ◆ getFileName()

String com.foxit.sdk.pdf.FileSpec.getFileName | ( |  | ) | throws com.foxit.sdk.PDFException

获取文件名。

返回
  文件名。如果找不到文件名，此函数将返回空字符串。

## ◆ getFileSize()

int com.foxit.sdk.pdf.FileSpec.getFileSize | ( |  | ) | throws com.foxit.sdk.PDFException

获取嵌入文件的大小（未压缩文件大小）。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回
  嵌入文件的文件大小（未压缩文件大小）。

## ◆ getModifiedDateTime()

DateTime com.foxit.sdk.pdf.FileSpec.getModifiedDateTime | ( |  | ) | throws com.foxit.sdk.PDFException

获取关于嵌入文件最后修改时间的修改日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将 返回一个所有值都为0的日期和时间对象。

返回
  嵌入文件的修改日期时间。

## ◆ getSubtype()

String com.foxit.sdk.pdf.FileSpec.getSubtype | ( |  | ) | throws com.foxit.sdk.PDFException

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 获取嵌入文件的"Subtype"键的MIME类型值。

此函数仅在当前文件规范对象表示嵌入文件且用作关联文件时有用。

返回
  子类型字符串。

## ◆ isEmbedded()

boolean com.foxit.sdk.pdf.FileSpec.isEmbedded | ( |  | ) | throws com.foxit.sdk.PDFException

检查当前文件规范对象是否表示嵌入文件。

返回
  true表示当前文件规范对象表示嵌入文件。 false表示当前文件规范对象不表示嵌入文件。

## ◆ isEmpty()

boolean com.foxit.sdk.pdf.FileSpec.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ setAssociteFileRelationship()

void com.foxit.sdk.pdf.FileSpec.setAssociteFileRelationship | ( | int | associfile_relationship | ) | throws com.foxit.sdk.PDFException

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。

对于新创建的关联文件规范对象，此函数是必需的。

参数

  [in] | associfile_relationship | 要设置的关联文件关系。请参考从 com.foxit.sdk.pdf.AssociatedFiles.e_RelationshipSource 开始的值， 这将是这些值中的一个。

返回
  无。

## ◆ setChecksum()

void com.foxit.sdk.pdf.FileSpec.setChecksum | ( | byte [] | checksum | ) | throws com.foxit.sdk.PDFException

为嵌入文件设置校验和。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。
16字节字符串，是未压缩嵌入文件字节的校验和。 校验和通过对嵌入文件流的字节应用标准MD5消息摘要算法来计算。

参数

  [in] | checksum | 要设置的校验和。

返回
  无。

## ◆ setCreationDateTime()

void com.foxit.sdk.pdf.FileSpec.setCreationDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException

为嵌入文件设置创建日期和时间。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。

参数

  [in] | date_time | 要设置的创建日期和时间。

返回
  无。

## ◆ setDescription()

void com.foxit.sdk.pdf.FileSpec.setDescription | ( | String | description | ) | throws com.foxit.sdk.PDFException

设置与当前文件规范关联的描述性文本。

参数

  [in] | description | 要设置的描述性文本。不应该是空字符串。

返回
  无。

## ◆ setFileName()

void com.foxit.sdk.pdf.FileSpec.setFileName | ( | String | file_name | ) | throws com.foxit.sdk.PDFException

设置文件名。

对于新的文件规范对象（不是从现有文件规范PDF对象构造的），此函数是必需的。

参数

  [in] | file_name | 要设置的文件名。不应该是空字符串。

返回
  无。

## ◆ setModifiedDateTime()

void com.foxit.sdk.pdf.FileSpec.setModifiedDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException

为嵌入文件设置最后修改日期和时间。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。

参数

  [in] | date_time | 要设置的最后修改日期和时间。

返回
  无。

## ◆ setSubtype()

void com.foxit.sdk.pdf.FileSpec.setSubtype | ( | String | subtype | ) | throws com.foxit.sdk.PDFException

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件且用作关联文件时有用。

参数

  [in] | subtype | 有效的MIME类型值。默认值："application/octet-stream"。

返回
  无。