Foxit PDF SDK

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

## Public 成员函数
| LaunchAction (Action action)
| 构造函数，使用父类对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
FileSpec | getFileSpec () throws com.foxit.sdk.PDFException
| 获取指定要启动的应用程序或要打开或打印的文档的文件规范。 更多...
int | getNewWindowFlag () throws com.foxit.sdk.PDFException
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
String | getWinAppOperation () throws com.foxit.sdk.PDFException
| (Windows特定启动参数) 获取操作名称。 更多...
String | getWinAppParameter () throws com.foxit.sdk.PDFException
| (Windows特定启动参数) 获取传递给指定应用程序的参数字符串。 更多...
String | getWinDefaultDirectory () throws com.foxit.sdk.PDFException
| (Windows特定启动参数) 获取标准DOS语法的默认目录。 更多...
String | getWinFileName () throws com.foxit.sdk.PDFException
| (Windows特定启动参数) 获取要启动的应用程序或 要打开或打印的文档的文件名。 更多...
void | setFileSpec (FileSpec file_specification) throws com.foxit.sdk.PDFException
| 设置指定要启动的应用程序或要打开或打印的文档的文件规范。 更多...
void | setNewWindowFlag (int flag) throws com.foxit.sdk.PDFException
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
void | setWinLaunchParameter (String file_name, String default_directory, String operation, String app_parameter) throws com.foxit.sdk.PDFException
| (Windows特定启动参数)设置Windows特定启动参数。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
PDFDictionary | getDict () throws com.foxit.sdk.PDFException
| 获取当前对象的PDF字典。 更多...
PDFDoc | getDocument () throws com.foxit.sdk.PDFException
| 获取当前动作所属的PDF文档。 更多...
Action | getSubAction (int index) throws com.foxit.sdk.PDFException
| 按索引获取子动作。 更多...
int | getSubActionCount () throws com.foxit.sdk.PDFException
| 获取子动作的数量。 更多...
int | getType () throws com.foxit.sdk.PDFException
| 获取动作类型。 更多...
void | insertSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
| 在指定索引位置插入新的子动作。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
void | removeAllSubActions () throws com.foxit.sdk.PDFException
| 移除所有子动作。 更多...
void | removeSubAction (int index) throws com.foxit.sdk.PDFException
| 移除指定索引的子动作。 更多...
void | setSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
| 按索引设置子动作。 更多...

## 额外继承的成员函数
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
| 为指定的动作类型创建新动作。 更多...
静态 Public 属性 继承自 com.foxit.sdk.pdf.actions.Action
static final int | e_NewWindowFlagFalse = 0
| "NewWindow"标志为false。
static final int | e_NewWindowFlagNone = 2
| 无"NewWindow"标志。
static final int | e_NewWindowFlagTrue = 1
| "NewWindow"标志为true。
static final int | e_TypeGoto = 1
| 动作类型：转到动作。
static final int | e_TypeGoTo3DView = 18
| 动作类型：转到3D视图动作。
static final int | e_TypeGoToE = 3
| 动作类型：嵌入转到动作。
static final int | e_TypeGoToR = 2
| 动作类型：远程转到动作。
static final int | e_TypeHide = 9
| 动作类型：隐藏动作。
static final int | e_TypeImportData = 13
| 动作类型：导入数据动作。
static final int | e_TypeJavaScript = 14
| 动作类型：JavaScript动作。
static final int | e_TypeLaunch = 4
| 动作类型：启动动作。
static final int | e_TypeMovie = 8
| 动作类型：电影动作。
static final int | e_TypeNamed = 10
| 动作类型：命名动作。
static final int | e_TypeRendition = 16
| 动作类型：演示动作。
static final int | e_TypeResetForm = 12
| 动作类型：重置表单动作。
static final int | e_TypeSetOCGState = 15
| 动作类型：设置OCG状态动作。
static final int | e_TypeSound = 7
| 动作类型：声音动作。
static final int | e_TypeSubmitForm = 11
| 动作类型：提交表单动作。
static final int | e_TypeThread = 5
| 动作类型：线程动作。
static final int | e_TypeTrans = 17
| 动作类型：过渡动作。
static final int | e_TypeUnknown = 0
| 动作类型：未知动作。
static final int | e_TypeURI = 6
| 动作类型：统一资源标识符(URI)动作。

## 详细描述

启动动作是启动应用程序，通常用于打开文件。 类com.foxit.sdk.pdf.actions.LaunchAction 派生自Action ，提供用于 获取/设置启动动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ LaunchAction()

com.foxit.sdk.pdf.actions.LaunchAction.LaunchAction | ( | Action | action | ) |

构造函数，使用父类对象。

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.actions.LaunchAction.delete | ( |  | ) |

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

返回
  无。

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

重载 com.foxit.sdk.pdf.actions.Action .

## ◆ getFileSpec()

FileSpec com.foxit.sdk.pdf.actions.LaunchAction.getFileSpec | ( |  | ) | throws com.foxit.sdk.PDFException

获取指定要启动的应用程序或要打开或打印的文档的文件规范。

返回
  文件规范对象。如果返回的文件规范对象的函数FileSpec.isEmpty 的返回值为true，则表示未找到此类属性。

## ◆ getNewWindowFlag()

int com.foxit.sdk.pdf.actions.LaunchAction.getNewWindowFlag | ( |  | ) | throws com.foxit.sdk.PDFException

获取用于决定是否在新窗口中打开目标文档的标志。

返回
  新窗口标志。将是以下值之一：
  - com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。
  - com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。
  - com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据 当前用户首选项行为。

## ◆ getWinAppOperation()

String com.foxit.sdk.pdf.actions.LaunchAction.getWinAppOperation | ( |  | ) | throws com.foxit.sdk.PDFException

(Windows特定启动参数) 获取操作名称。

操作名称的标准字符串为：

- "open"：打开文档。
- "print"：打印文档

如果Windows特定启动参数的文件名表示应用程序， 操作名称对当前动作将无用。

返回
  操作名称。

## ◆ getWinAppParameter()

String com.foxit.sdk.pdf.actions.LaunchAction.getWinAppParameter | ( |  | ) | throws com.foxit.sdk.PDFException

(Windows特定启动参数) 获取传递给指定应用程序的参数字符串。

如果Windows特定启动参数的文件名表示文档， 应用程序参数字符串将被忽略。

返回
  参数字符串。

## ◆ getWinDefaultDirectory()

String com.foxit.sdk.pdf.actions.LaunchAction.getWinDefaultDirectory | ( |  | ) | throws com.foxit.sdk.PDFException

(Windows特定启动参数) 获取标准DOS语法的默认目录。

返回
  默认目录。

## ◆ getWinFileName()

String com.foxit.sdk.pdf.actions.LaunchAction.getWinFileName | ( |  | ) | throws com.foxit.sdk.PDFException

(Windows特定启动参数) 获取要启动的应用程序或 要打开或打印的文档的文件名。

返回
  文件名。

## ◆ setFileSpec()

void com.foxit.sdk.pdf.actions.LaunchAction.setFileSpec | ( | FileSpec | file_specification | ) | throws com.foxit.sdk.PDFException

设置指定要启动的应用程序或要打开或打印的文档的文件规范。

参数

  [in] | file_specification | 有效的文件规范对象。此对象应与当前动作对象 在同一个文档中。

返回
  无。

## ◆ setNewWindowFlag()

void com.foxit.sdk.pdf.actions.LaunchAction.setNewWindowFlag | ( | int | flag | ) | throws com.foxit.sdk.PDFException

设置用于决定是否在新窗口中打开目标文档的标志。

参数

  [in] | flag | 新窗口标志。应为以下值之一： com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagNone 表示 不需要此类标志，查看器应用程序应根据 当前用户首选项行为。

返回
  无。

## ◆ setWinLaunchParameter()

void com.foxit.sdk.pdf.actions.LaunchAction.setWinLaunchParameter | ( | String | file_name,
|  | String | default_directory,
|  | String | operation,
|  | String | app_parameter
| ) |  | throws com.foxit.sdk.PDFException

(Windows特定启动参数)设置Windows特定启动参数。

此函数用于设置Windows特定启动参数。 参数file_name是必需的，可以表示应用程序或文档。 当参数file_name表示应用程序时，参数operation和 app_parameter无用。

参数

  [in] | file_name | 要启动的应用程序或要打开或打印的文档的文件名。 不应为空字符串。
  [in] | default_directory | 标准DOS语法的默认目录。
  [in] | operation | 操作名称。这可以是空字符串。如果不是空字符串， 应为以下字符串之一： "open"：打开文档。 "print"：打印文档
  [in] | app_parameter | 传递给指定应用程序的参数字符串。

返回
  无。