Foxit PDF SDK
com.foxit.sdk.pdf.actions.RenditionAction类 参考
类 com.foxit.sdk.pdf.actions.RenditionAction 继承关系图:
com.foxit.sdk.pdf.actions.Action com.foxit.sdk.common.Base

Public 成员函数

 RenditionAction (Action action)
 构造函数,使用父类对象。
更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
String getJavaScript () throws com.foxit.sdk.PDFException
 获取要执行的JavaScript脚本。
更多...
 
int getOperationType () throws com.foxit.sdk.PDFException
 获取当前再现动作在被触发时的操作类型。
更多...
 
Rendition getRendition (int index) throws com.foxit.sdk.PDFException
 通过索引获取再现。
更多...
 
int getRenditionCount () throws com.foxit.sdk.PDFException
 获取再现对象的数量。
更多...
 
Screen getScreenAnnot () throws com.foxit.sdk.PDFException
 获取相关的屏幕注释。
更多...
 
void insertRendition (Rendition rendition, int index) throws com.foxit.sdk.PDFException
 在索引指定的位置将再现插入到当前再现动作中。
更多...
 
void removeRendition (Rendition rendition) throws com.foxit.sdk.PDFException
 从当前再现动作中移除再现对象。
更多...
 
void setJavaScript (String script) throws com.foxit.sdk.PDFException
 设置要执行的JavaScript脚本。
更多...
 
void setOperationType (int op_type) throws com.foxit.sdk.PDFException
 设置当前再现动作在被触发时的操作类型。
更多...
 
void setScreenAnnot (Screen screen_annot) 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_OpTypeAssociate = 0
 将再现关联到相关的屏幕注释。
更多...
 
static final int e_OpTypeNone = -1
 未指定操作。

 
static final int e_OpTypePause = 2
 暂停与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放,则没有效果。

 
static final int e_OpTypePlay = 4
 播放再现(在再现动作中指定),将其与相关屏幕注释关联。 如果再现已经与注释关联,如果它被暂停则恢复该再现; 否则,什么都不做。

 
static final int e_OpTypeResume = 3
 恢复与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放或再现未暂停,则没有效果。

 
static final int e_OpTypeStop = 1
 停止与相关屏幕注释关联播放的任何再现并移除关联。 如果没有再现正在播放,则没有效果。

 
- 静态 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
 为指定的动作类型创建新动作。
更多...
 

详细描述

再现动作是控制多媒体内容的播放。(更多详情,请参考 <PDF参考1.7> P668 "再现动作") 类com.foxit.sdk.pdf.actions.RenditionAction 派生自Action ,提供用于 获取/设置再现动作数据的函数。

参见
Action

构造及析构函数说明

◆ RenditionAction()

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

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

参数
[in]action父类对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.actions.RenditionAction.delete ( )

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

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

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

◆ getJavaScript()

String com.foxit.sdk.pdf.actions.RenditionAction.getJavaScript ( ) throws com.foxit.sdk.PDFException

获取要执行的JavaScript脚本。

作为一个有用的再现动作,它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在,应用程序应该执行JavaScript;如果应用程序无法 执行JavaScript脚本,则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效,那意味着动作无效。

返回
JavaScript脚本。

◆ getOperationType()

int com.foxit.sdk.pdf.actions.RenditionAction.getOperationType ( ) throws com.foxit.sdk.PDFException

获取当前再现动作在被触发时的操作类型。

作为一个有用的再现动作,它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在,应用程序应该执行JavaScript;如果应用程序无法 执行JavaScript脚本,则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效,那意味着动作无效。

返回
操作类型。请参考com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeNone 开始的值, 这将是这些值中的一个。

◆ getRendition()

Rendition com.foxit.sdk.pdf.actions.RenditionAction.getRendition ( int  index) throws com.foxit.sdk.PDFException

通过索引获取再现。

参数
[in]index要检索的再现对象的索引。有效范围:从0到(count-1)。 count由函数RenditionAction.getRenditionCount 返回。
返回
再现对象。

◆ getRenditionCount()

int com.foxit.sdk.pdf.actions.RenditionAction.getRenditionCount ( ) throws com.foxit.sdk.PDFException

获取再现对象的数量。

返回
再现对象的数量。

◆ getScreenAnnot()

Screen com.foxit.sdk.pdf.actions.RenditionAction.getScreenAnnot ( ) throws com.foxit.sdk.PDFException

获取相关的屏幕注释。

返回
屏幕注释对象。

◆ insertRendition()

void com.foxit.sdk.pdf.actions.RenditionAction.insertRendition ( Rendition  rendition,
int  index 
) throws com.foxit.sdk.PDFException

在索引指定的位置将再现插入到当前再现动作中。

当操作类型为com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeAssociate com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeAssociate 时,再现对象对于再现动作是必需的。

参数
[in]rendition要插入的再现对象。
[in]index指定插入再现对象位置的索引。 如果索引小于0或大于(count-1),输入的再现将被 插入到末尾。count由函数 RenditionAction.getRenditionCount 返回。
返回
无。

◆ removeRendition()

void com.foxit.sdk.pdf.actions.RenditionAction.removeRendition ( Rendition  rendition) throws com.foxit.sdk.PDFException

从当前再现动作中移除再现对象。

参数
[in]rendition要从当前再现动作中移除的再现对象。
返回
无。

◆ setJavaScript()

void com.foxit.sdk.pdf.actions.RenditionAction.setJavaScript ( String  script) throws com.foxit.sdk.PDFException

设置要执行的JavaScript脚本。

作为一个有用的再现动作,它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在,应用程序应该执行JavaScript;如果应用程序无法 执行JavaScript脚本,则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效,那意味着动作无效。

参数
[in]script要设置的JavaScript脚本。
返回
无。

◆ setOperationType()

void com.foxit.sdk.pdf.actions.RenditionAction.setOperationType ( int  op_type) throws com.foxit.sdk.PDFException

设置当前再现动作在被触发时的操作类型。

作为一个有用的再现动作,它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在,应用程序应该执行JavaScript;如果应用程序无法 执行JavaScript脚本,则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效,那意味着动作无效。

参数
[in]op_type操作类型。请参考com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeAssociate 开始的值, 这应该是这些值中的一个。如果设置值com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeNone , 那意味着没有指定操作类型。
返回
无。

◆ setScreenAnnot()

void com.foxit.sdk.pdf.actions.RenditionAction.setScreenAnnot ( Screen  screen_annot) throws com.foxit.sdk.PDFException

设置相关的屏幕注释。

当操作类型设置为有效值时,此属性是必需的。

参数
[in]screen_annot要设置为相关屏幕注释的屏幕注释对象。
返回
无。

类成员变量说明

◆ e_OpTypeAssociate

final int com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeAssociate = 0
static

将再现关联到相关的屏幕注释。

如果没有再现与相关屏幕注释关联, 播放再现(在再现动作中指定),将其与注释关联。 如果再现已经与相关屏幕注释关联,停止它,并且 新的再现(在再现动作中指定)与注释关联。