Foxit PDF SDK

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

## Public 成员函数
| SetOCGStateAction (Action action)
| 构造函数，使用父类对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getOCGState (int index) throws com.foxit.sdk.PDFException
| 获取OCG的状态。 更多...
PDFDictionaryArray | getOCGStateArray (int index) throws com.foxit.sdk.PDFException
| 获取OCG字典数组。 更多...
int | getOCGStateCount () throws com.foxit.sdk.PDFException
| 获取OCG状态的数量。 更多...
int | insertOCGStates (PDFDoc document, int index, int state, PDFDictionaryArray ocg_dict_array) throws com.foxit.sdk.PDFException
| 将OCG状态插入到动作中。 更多...
boolean | isRadioButtonStatePreserved () throws com.foxit.sdk.PDFException
| 获取单选按钮保留状态。 更多...
void | removeOCGStates (int index) throws com.foxit.sdk.PDFException
| 移除OCG状态。 更多...
boolean | replaceOCGStates (PDFDoc document, int index, PDFDictionaryArray ocg_dict_array) throws com.foxit.sdk.PDFException
| 替换OCG状态数组。 更多...
void | setRadioButtonStatePreserved (boolean is_preserved) throws com.foxit.sdk.PDFException
| 设置单选按钮保留状态。 更多...
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 属性
static final int | e_OCGStateOff = 1
| 将后续组的状态设置为OFF。
static final int | e_OCGStateOn = 0
| 将后续组的状态设置为ON。
static final int | e_OCGStateToggle = 2
| 反转后续组的状态。
静态 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)动作。

## 额外继承的成员函数
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
| 为指定的动作类型创建新动作。 更多...

## 详细描述

设置OCG状态动作是设置一个或多个可选内容组的状态。(更多详情，请参考 <PDF参考1.7> P667 "设置OCG状态动作") 类com.foxit.sdk.pdf.actions.SetOCGStateAction 派生自Action ，提供用于 获取/设置设置OCG状态动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ SetOCGStateAction()

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

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ delete()

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

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

返回
  无。

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

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

## ◆ getOCGState()

int com.foxit.sdk.pdf.actions.SetOCGStateAction.getOCGState | ( | int | index | ) | throws com.foxit.sdk.PDFException

获取OCG的状态。

参数

  [in] | index | OCG状态的索引。 有效范围：从0到(count-1)。 count由函数SetOCGStateAction.getOCGStateCount 返回。

返回
  OCG的状态。

## ◆ getOCGStateArray()

PDFDictionaryArray com.foxit.sdk.pdf.actions.SetOCGStateAction.getOCGStateArray | ( | int | index | ) | throws com.foxit.sdk.PDFException

获取OCG字典数组。

参数

  [in] | index | OCG状态的索引。 有效范围：从0到(count-1)。 count由函数SetOCGStateAction.getOCGStateCount 返回。

返回
  OCG字典数组。

## ◆ getOCGStateCount()

int com.foxit.sdk.pdf.actions.SetOCGStateAction.getOCGStateCount | ( |  | ) | throws com.foxit.sdk.PDFException

获取OCG状态的数量。

返回
  OCG状态的数量。

## ◆ insertOCGStates()

int com.foxit.sdk.pdf.actions.SetOCGStateAction.insertOCGStates | ( | PDFDoc | document,
|  | int | index,
|  | int | state,
|  | PDFDictionaryArray | ocg_dict_array
| ) |  | throws com.foxit.sdk.PDFException

将OCG状态插入到动作中。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | index | 要插入的OCG的索引。OCG状态将在该索引之后插入。 有效范围：从0到(count-1)。 count由函数SetOCGStateAction.getOCGStateCount 返回。 如果此值小于0或当前动作中OCG状态的数量为0， 参数state将被插入到第一个位置。 如果此值大于当前动作中OCG状态的数量， 参数state将被添加到末尾。
  [in] | state | 要插入的OCG状态。
  [in] | ocg_dict_array | 要插入的OCG字典数组。

返回
  插入的OCG状态的索引。

## ◆ isRadioButtonStatePreserved()

boolean com.foxit.sdk.pdf.actions.SetOCGStateAction.isRadioButtonStatePreserved | ( |  | ) | throws com.foxit.sdk.PDFException

获取单选按钮保留状态。

如果为true，表示当应用State数组中的状态时，应保留可选内容组之间的单选按钮状态关系。 如果为false，则忽略单选按钮状态关系（如果有的话）。 默认值：true。

返回
  保留状态值。

## ◆ removeOCGStates()

void com.foxit.sdk.pdf.actions.SetOCGStateAction.removeOCGStates | ( | int | index | ) | throws com.foxit.sdk.PDFException

移除OCG状态。

参数

  [in] | index | 要移除的OCG的索引。 有效范围：从0到(count-1)。 count由函数SetOCGStateAction.getOCGStateCount 返回。

返回
  无。

## ◆ replaceOCGStates()

boolean com.foxit.sdk.pdf.actions.SetOCGStateAction.replaceOCGStates | ( | PDFDoc | document,
|  | int | index,
|  | PDFDictionaryArray | ocg_dict_array
| ) |  | throws com.foxit.sdk.PDFException

替换OCG状态数组。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | index | 要替换的OCG的索引。 有效范围：从0到(count-1)。 count由函数SetOCGStateAction.getOCGStateCount 返回。
  [in] | ocg_dict_array | 要插入的OCG字典数组。

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

## ◆ setRadioButtonStatePreserved()

void com.foxit.sdk.pdf.actions.SetOCGStateAction.setRadioButtonStatePreserved | ( | boolean | is_preserved | ) | throws com.foxit.sdk.PDFException

设置单选按钮保留状态。

参数

  [in] | is_preserved | 保留状态值。

返回
  无。