Foxit PDF SDK

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

## Public 成员函数
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
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 成员函数
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
| 为指定的动作类型创建新动作。 更多...

## 静态 Public 属性
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)动作。

## 详细描述

PDF支持以下标准动作类型：
"转到动作"、"远程转到动作"、"嵌入转到动作"、"启动动作"、"线程动作"、 "URI动作"、"声音动作"、"电影动作"、"隐藏动作"、"命名动作"、"提交表单动作"、 "重置表单动作"、"导入数据动作"、"JavaScript动作"、"设置OCG状态动作"、 "演示动作"、"过渡动作"、"转到3D视图动作"。
PDF动作可能有子动作。当此动作被触发时，其子动作也应依次被触发。
类Action 是所有类型PDF动作的基类。对于具体的动作类型，请参考 派生类。函数Action.create 可用于创建新动作 – 目前仅支持 某些动作类型。请参考此函数的注释以获取更多详细信息。此类还提供了修改子动作的函数。

## 构造及析构函数说明

## ◆ Action() [1/2]

com.foxit.sdk.pdf.actions.Action.Action | ( | PDFDoc | document,
|  | PDFDictionary | action_dict
| ) |  |

构造函数，带参数。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | action_dict | 表示动作的PDF字典对象。

## ◆ Action() [2/2]

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

构造函数，使用另一个动作对象。

参数

  [in] | action | 另一个动作对象。

## 成员函数说明

## ◆ create()

static Action com.foxit.sdk.pdf.actions.Action.create | ( | PDFDoc | document,
|  | int | action_type
| ) |  | throws com.foxit.sdk.PDFException
| static

为指定的动作类型创建新动作。

新创建的动作尚未有动作数据（除了动作类型）。 用户需要调用具体动作类中的函数来设置动作数据。

参数

  [in] | document | 新动作所属的有效PDF文档。
  [in] | action_type | 动作类型，用于指定要创建的动作类型。 目前仅支持： com.foxit.sdk.pdf.actions.Action.e_TypeGoto 、com.foxit.sdk.pdf.actions.Action.e_TypeURI 、 com.foxit.sdk.pdf.actions.Action.e_TypeJavaScript 、com.foxit.sdk.pdf.actions.Action.e_TypeNamed 、 com.foxit.sdk.pdf.actions.Action.e_TypeGoToR 、com.foxit.sdk.pdf.actions.Action.e_TypeGoToE 、 com.foxit.sdk.pdf.actions.Action.e_TypeSubmitForm 、com.foxit.sdk.pdf.actions.Action.e_TypeResetForm 、 com.foxit.sdk.pdf.actions.Action.e_TypeHide 、com.foxit.sdk.pdf.actions.Action.e_TypeLaunch 、 com.foxit.sdk.pdf.actions.Action.e_TypeImportData 、com.foxit.sdk.pdf.actions.Action.e_TypeRendition 、 com.foxit.sdk.pdf.actions.Action.e_TypeSetOCGState 、com.foxit.sdk.pdf.actions.Action.e_TypeThread ，

返回
  没有动作数据的新动作对象。

## ◆ delete()

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

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

返回
  无。

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

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

被 com.foxit.sdk.pdf.actions.SetOCGStateAction, com.foxit.sdk.pdf.actions.EmbeddedGotoAction, com.foxit.sdk.pdf.actions.HideAction, com.foxit.sdk.pdf.actions.ImportDataAction, com.foxit.sdk.pdf.actions.LaunchAction, com.foxit.sdk.pdf.actions.RemoteGotoAction, com.foxit.sdk.pdf.actions.RenditionAction, com.foxit.sdk.pdf.actions.ResetFormAction, com.foxit.sdk.pdf.actions.SubmitFormAction, com.foxit.sdk.pdf.actions.GotoAction, com.foxit.sdk.pdf.actions.JavaScriptAction, com.foxit.sdk.pdf.actions.NamedAction , 以及 com.foxit.sdk.pdf.actions.URIAction 重载.

## ◆ getDict()

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

获取当前对象的PDF字典。

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

## ◆ getDocument()

PDFDoc com.foxit.sdk.pdf.actions.Action.getDocument | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前动作所属的PDF文档。

返回
  PDF文档对象。

## ◆ getSubAction()

Action com.foxit.sdk.pdf.actions.Action.getSubAction | ( | int | index | ) | throws com.foxit.sdk.PDFException

按索引获取子动作。

参数

  [in] | index | 要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数Action.getSubActionCount 返回。

返回
  表示指定子动作的动作对象。

## ◆ getSubActionCount()

int com.foxit.sdk.pdf.actions.Action.getSubActionCount | ( |  | ) | throws com.foxit.sdk.PDFException

获取子动作的数量。

返回
  子动作的数量。

## ◆ getType()

int com.foxit.sdk.pdf.actions.Action.getType | ( |  | ) | throws com.foxit.sdk.PDFException

获取动作类型。

返回
  动作类型。请参考从com.foxit.sdk.pdf.actions.Action.e_TypeGoto 开始的值， 这将是这些值中的一个。

## ◆ insertSubAction()

void com.foxit.sdk.pdf.actions.Action.insertSubAction | ( | int | index,
|  | Action | sub_action
| ) |  | throws com.foxit.sdk.PDFException

在指定索引位置插入新的子动作。

参数

  [in] | index | 要插入新子动作的位置索引。 如果此索引值小于零，新子动作将被插入为第一个。 如果此索引值等于或大于当前子动作数量，新子动作将 被插入为最后一个。
  [in] | sub_action | 要插入的新子动作。当前仅支持以下类型 作为新子动作： com.foxit.sdk.pdf.actions.Action.e_TypeGoto ，com.foxit.sdk.pdf.actions.Action.e_TypeURI ， com.foxit.sdk.pdf.actions.Action.e_TypeJavaScript ，com.foxit.sdk.pdf.actions.Action.e_TypeNamed ， com.foxit.sdk.pdf.actions.Action.e_TypeGoToR ，com.foxit.sdk.pdf.actions.Action.e_TypeGoToE ， com.foxit.sdk.pdf.actions.Action.e_TypeSubmitForm ，com.foxit.sdk.pdf.actions.Action.e_TypeResetForm ， com.foxit.sdk.pdf.actions.Action.e_TypeHide ，com.foxit.sdk.pdf.actions.Action.e_TypeLaunch ， com.foxit.sdk.pdf.actions.Action.e_TypeImportData ，com.foxit.sdk.pdf.actions.Action.e_TypeRendition 。

返回
  无。

## ◆ isEmpty()

boolean com.foxit.sdk.pdf.actions.Action.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ removeAllSubActions()

void com.foxit.sdk.pdf.actions.Action.removeAllSubActions | ( |  | ) | throws com.foxit.sdk.PDFException

移除所有子动作。

返回
  无。

## ◆ removeSubAction()

void com.foxit.sdk.pdf.actions.Action.removeSubAction | ( | int | index | ) | throws com.foxit.sdk.PDFException

移除指定索引的子动作。

参数

  [in] | index | 要移除的子动作的索引。有效范围：从0到（count-1）。 count由函数Action.getSubActionCount 返回。

返回
  无。

## ◆ setSubAction()

void com.foxit.sdk.pdf.actions.Action.setSubAction | ( | int | index,
|  | Action | sub_action
| ) |  | throws com.foxit.sdk.PDFException

按索引设置子动作。

参数

  [in] | index | 要检索的子动作的索引。有效范围：从0到(count-1)。 count由函数Action.getSubActionCount 返回。
  [in] | sub_action | 要设置为子动作的动作对象。目前仅支持以下类型 作为子动作： com.foxit.sdk.pdf.actions.Action.e_TypeGoto 、com.foxit.sdk.pdf.actions.Action.e_TypeURI 、 com.foxit.sdk.pdf.actions.Action.e_TypeJavaScript 、com.foxit.sdk.pdf.actions.Action.e_TypeNamed 、 com.foxit.sdk.pdf.actions.Action.e_TypeGoToR 、com.foxit.sdk.pdf.actions.Action.e_TypeGoToE 、 com.foxit.sdk.pdf.actions.Action.e_TypeSubmitForm 、com.foxit.sdk.pdf.actions.Action.e_TypeResetForm 、 com.foxit.sdk.pdf.actions.Action.e_TypeHide 、com.foxit.sdk.pdf.actions.Action.e_TypeLaunch 、 com.foxit.sdk.pdf.actions.Action.e_TypeImportData 、com.foxit.sdk.pdf.actions.Action.e_TypeRendition 、 com.foxit.sdk.pdf.actions.Action.e_TypeSetOCGState 。

返回
  无。