Foxit PDF SDK

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

## Public 成员函数
| Portfolio (Portfolio other)
| 构造函数，使用另一个PDF作品集对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
String | getInitialFileSpecKeyName () throws com.foxit.sdk.PDFException
| 获取应作为初始文档的附件（作为文件规范）的键名。 更多...
int | getInitialViewMode () throws com.foxit.sdk.PDFException
| 获取初始视图模式。 更多...
PDFDoc | getPortfolioPDFDoc () throws com.foxit.sdk.PDFException
| 获取相关的作品集PDF文档对象。 更多...
PortfolioNode | getRootNode () throws com.foxit.sdk.PDFException
| 获取始终为文件夹节点的根节点。 更多...
SchemaFieldArray | getSchemaFields () throws com.foxit.sdk.PDFException
| 获取架构字段。 更多...
String | getSortingFieldKeyName () throws com.foxit.sdk.PDFException
| 获取用于排序的架构字段的键名。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
boolean | isSortedInAscending () throws com.foxit.sdk.PDFException
| 检查节点是否应按升序排序。 更多...
void | setInitialFileSpecKeyName (String name) throws com.foxit.sdk.PDFException
| 设置应作为初始文档的附件（作为文件规范）的键名。 更多...
void | setInitialViewMode (int mode) throws com.foxit.sdk.PDFException
| 设置初始视图模式。 更多...
void | setSchemaFields (SchemaFieldArray field_array) throws com.foxit.sdk.PDFException
| 设置架构字段。 更多...
void | setSortingFieldKeyName (String name) throws com.foxit.sdk.PDFException
| 设置用于排序的架构字段的键名。 更多...
void | setSortingOrder (boolean use_ascending_order) throws com.foxit.sdk.PDFException
| 设置布尔值以决定节点是否应按升序排序。 更多...

## 静态 Public 成员函数
static Portfolio | createPortfolio () throws com.foxit.sdk.PDFException
| 使用自动创建的新空白PDF文档创建PDF作品集。 更多...
static Portfolio | createPortfolio (PDFDoc portfolio_pdf_doc) throws com.foxit.sdk.PDFException
| 使用现有的作品集PDF文档创建PDF作品集。 更多...

## 静态 Public 属性
static final int | e_InitialViewDetailMode = 1
| 初始视图模式：详细模式，以多列格式呈现所有信息（由架构字段指定）。 更多...
static final int | e_InitialViewHidden = 3
| 初始视图模式：隐藏模式。
static final int | e_InitialViewTileMode = 2
| 初始视图模式：平铺模式，每个文件和文件夹节点用小图标和 信息子集（由架构字段指定）表示。 更多...
static final int | e_InitialViewUnknownMode = 0
| 未知初始视图模式。

## 详细描述

PDF作品集是不同格式文件的组合。PDF作品集本身是一个PDF文档， 然后可以将不同格式的文件嵌入到这种类型的PDF文档中。
类 Portfolio 可用于创建新的空白PDF作品集或访问现有的作品集PDF文档， 然后获取/设置作品集属性并访问根节点以枚举所有节点或添加/删除节点。

## 构造及析构函数说明

## ◆ Portfolio()

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

构造函数，使用另一个PDF作品集对象。

参数

  [in] | other | 另一个书签对象。

## 成员函数说明

## ◆ createPortfolio() [1/2]

static Portfolio com.foxit.sdk.pdf.Portfolio.createPortfolio | ( |  | ) | throws com.foxit.sdk.PDFException
| static

使用自动创建的新空白PDF文档创建PDF作品集。

此函数将自动创建一个新的空白PDF文档作为作品集PDF文档。 函数 Portfolio.getPortfolioPDFDoc 可用于检索相关的PDF文档对象。 函数 Portfolio.getSchemaFields 可用于检索默认架构字段。

返回
  PDF作品集对象。

## ◆ createPortfolio() [2/2]

static Portfolio com.foxit.sdk.pdf.Portfolio.createPortfolio | ( | PDFDoc | portfolio_pdf_doc | ) | throws com.foxit.sdk.PDFException
| static

使用现有的作品集PDF文档创建PDF作品集。

此函数只是创建一个PDF作品集对象以与 现有的作品集PDF文档关联，以便访问作品集信息。

参数

  [in] | portfolio_pdf_doc | 作品集PDF文档。

返回
  PDF作品集对象。

## ◆ delete()

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

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

返回
  无。

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

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

## ◆ getInitialFileSpecKeyName()

String com.foxit.sdk.pdf.Portfolio.getInitialFileSpecKeyName | ( |  | ) | throws com.foxit.sdk.PDFException

获取应作为初始文档的附件（作为文件规范）的键名。

类 Attachments 可用于通过键名检索文件规范对象。

返回
  附件（作为文件规范）的键名。如果返回空字符串， 表示相关的作品集PDF文档应作为初始文档。

## ◆ getInitialViewMode()

int com.foxit.sdk.pdf.Portfolio.getInitialViewMode | ( |  | ) | throws com.foxit.sdk.PDFException

获取初始视图模式。

返回
  初始视图模式。请参考从 com.foxit.sdk.pdf.Portfolio.e_InitialViewUnknownMode 开始的值，将是这些值中的一个。

## ◆ getPortfolioPDFDoc()

PDFDoc com.foxit.sdk.pdf.Portfolio.getPortfolioPDFDoc | ( |  | ) | throws com.foxit.sdk.PDFException

获取相关的作品集PDF文档对象。

返回
  相关的作品集PDF文档对象。

## ◆ getRootNode()

PortfolioNode com.foxit.sdk.pdf.Portfolio.getRootNode | ( |  | ) | throws com.foxit.sdk.PDFException

获取始终为文件夹节点的根节点。

PDF作品集将文件组织成层次结构——一个具有单个根文件夹（也称为根节点）的树， 作为所有其他文件夹和文件的共同祖先。

返回
  表示根节点的作品集节点对象。

## ◆ getSchemaFields()

SchemaFieldArray com.foxit.sdk.pdf.Portfolio.getSchemaFields | ( |  | ) | throws com.foxit.sdk.PDFException

获取架构字段。

架构字段用于决定在应用程序中显示文件节点或文件夹节点的哪些属性。

返回
  架构字段。这些字段的顺序由它们在返回数组中的索引顺序决定。

## ◆ getSortingFieldKeyName()

String com.foxit.sdk.pdf.Portfolio.getSortingFieldKeyName | ( |  | ) | throws com.foxit.sdk.PDFException

获取用于排序的架构字段的键名。

返回
  用于排序的架构字段的键名。

## ◆ isEmpty()

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

检查当前对象是否为空。

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

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

## ◆ isSortedInAscending()

boolean com.foxit.sdk.pdf.Portfolio.isSortedInAscending | ( |  | ) | throws com.foxit.sdk.PDFException

检查节点是否应按升序排序。

返回
  true 表示节点应使用指定字段按升序排序， false 表示节点应使用指定字段按降序排序。

## ◆ setInitialFileSpecKeyName()

void com.foxit.sdk.pdf.Portfolio.setInitialFileSpecKeyName | ( | String | name | ) | throws com.foxit.sdk.PDFException

设置应作为初始文档的附件（作为文件规范）的键名。

函数 PortfolioFileNode.getKeyName 可用于获取与文件节点关联的文件规范的键名。 或者使用类 Attachments 检索文件规范的键名。

参数

  [in] | name | 附件（作为文件规范）的键名。如果返回空字符串， 表示相关的作品集PDF文档应作为初始文档。

返回
  无。

## ◆ setInitialViewMode()

void com.foxit.sdk.pdf.Portfolio.setInitialViewMode | ( | int | mode | ) | throws com.foxit.sdk.PDFException

设置初始视图模式。

参数

  [in] | mode | 初始视图模式。请参考从 com.foxit.sdk.pdf.Portfolio.e_InitialViewDetailMode 开始的值， 应该是这些值中的一个，除了 com.foxit.sdk.pdf.Portfolio.e_InitialViewUnknownMode 。

返回
  无。

## ◆ setSchemaFields()

void com.foxit.sdk.pdf.Portfolio.setSchemaFields | ( | SchemaFieldArray | field_array | ) | throws com.foxit.sdk.PDFException

设置架构字段。

架构字段用于决定在应用程序中显示文件节点或文件夹节点的哪些属性。
当此函数成功时，所有旧的架构字段将被移除，输入的字段将被使用。

参数

  [in] | field_array | 新的架构字段数组。这些字段的顺序由它们在此数组中的索引顺序决定。

返回
  无。

## ◆ setSortingFieldKeyName()

void com.foxit.sdk.pdf.Portfolio.setSortingFieldKeyName | ( | String | name | ) | throws com.foxit.sdk.PDFException

设置用于排序的架构字段的键名。

参数

  [in] | name | 用于排序的架构字段的键名。

返回
  无。

## ◆ setSortingOrder()

void com.foxit.sdk.pdf.Portfolio.setSortingOrder | ( | boolean | use_ascending_order | ) | throws com.foxit.sdk.PDFException

设置布尔值以决定节点是否应按升序排序。

参数

  [in] | use_ascending_order | 决定排序顺序的布尔值： true 表示节点应使用指定字段按升序排序， false 表示节点应使用指定字段按降序排序。

返回
  无。

## 类成员变量说明

## ◆ e_InitialViewDetailMode

final int com.foxit.sdk.pdf.Portfolio.e_InitialViewDetailMode = 1
| static

初始视图模式：详细模式，以多列格式呈现所有信息（由架构字段指定）。

注解
  此模式为用户提供最多的信息。

## ◆ e_InitialViewTileMode

final int com.foxit.sdk.pdf.Portfolio.e_InitialViewTileMode = 2
| static

初始视图模式：平铺模式，每个文件和文件夹节点用小图标和 信息子集（由架构字段指定）表示。

注解
  此模式为用户提供有关嵌入文件的顶级信息。