|
| RenditionAction (Action action) |
| Constructor, with parent class object. More...
|
|
String | getJavaScript () throws com.foxit.sdk.PDFException |
| Get the JavaScript script to be executed. More...
|
|
int | getOperationType () throws com.foxit.sdk.PDFException |
| Get the operation type of current rendition action when being triggered. More...
|
|
Rendition | getRendition (int index) throws com.foxit.sdk.PDFException |
| Get a rendition by index. More...
|
|
int | getRenditionCount () throws com.foxit.sdk.PDFException |
| Get the count of rendition objects. More...
|
|
Screen | getScreenAnnot () throws com.foxit.sdk.PDFException |
| Get the related screen annotation. More...
|
|
void | insertRendition (Rendition rendition, int index) throws com.foxit.sdk.PDFException |
| Insert a rendition to current rendition action, at the position specified by index. More...
|
|
void | removeRendition (Rendition rendition) throws com.foxit.sdk.PDFException |
| Remove a rendition object from current rendition action. More...
|
|
void | setJavaScript (String script) throws com.foxit.sdk.PDFException |
| Set the JavaScript script to be executed. More...
|
|
void | setOperationType (int op_type) throws com.foxit.sdk.PDFException |
| Set the operation type of current rendition action when being triggered. More...
|
|
void | setScreenAnnot (Screen screen_annot) throws com.foxit.sdk.PDFException |
| Set related screen annotation. More...
|
|
| Action (PDFDoc document, PDFDictionary action_dict) |
| Constructor, with parameters. More...
|
|
| Action (Action action) |
| Constructor, with another Action object. More...
|
|
PDFDictionary | getDict () throws com.foxit.sdk.PDFException |
| Get PDF dictionary of current object. More...
|
|
PDFDoc | getDocument () throws com.foxit.sdk.PDFException |
| Get the PDF document, to which current action belongs. More...
|
|
Action | getSubAction (int index) throws com.foxit.sdk.PDFException |
| Get a sub-action by index. More...
|
|
int | getSubActionCount () throws com.foxit.sdk.PDFException |
| Get the count of sub-actions. More...
|
|
int | getType () throws com.foxit.sdk.PDFException |
| Get action type. More...
|
|
void | insertSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException |
| Insert a new sub-action to the location specified by index. More...
|
|
boolean | isEmpty () |
| Check whether current object is empty or not. More...
|
|
void | removeAllSubActions () throws com.foxit.sdk.PDFException |
| Remove all the sub-actions. More...
|
|
void | removeSubAction (int index) throws com.foxit.sdk.PDFException |
| Remove a sub-action, specified by index. More...
|
|
void | setSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException |
| Set a sub-action by index. More...
|
|
Rendition action is to control the playing of multimedia content. (For more details, please refer to <PDF Reference 1.7> P668 "Rendition Actions") Class LaunchAction is derived from Action and offers functions to get/set rendition action data.
- See also
- Action
Get the JavaScript script to be executed.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
- Returns
- A JavaScript script.
Get the operation type of current rendition action when being triggered.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
- Returns
- Operation type. Please refer to values starting from e_OpTypeNone and this would be one of these values.
Set the JavaScript script to be executed.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
- Parameters
-
script | A JavaScript script to be set.
|
- Returns
- None.
Set the operation type of current rendition action when being triggered.
As a useful rendition action, it should contain a JavaScript script to be executed or is specified an operation type to be performed when triggered. If both JavaScript script and operation type exist, application should execute JavaScript; if application is unable to execute JavaScript script, then perform as operation type defines. If no JavaScript script and operation type is invalid, that means the action is invalid.
- Parameters
-
op_type | Operation type. Please refer to values starting from e_OpTypeAssociate and this should be one of these values. If set value e_OpTypeNone, that means no operation type is specified.
|
- Returns
- None.
static final int com.foxit.sdk.pdf.actions.RenditionAction.e_OpTypeAssociate = 0 |
|
static |
Associate rendition to related screen annotation.
If no rendition is associated with related screen annotation, play rendition (which is specified in rendition action), associating it with the annotation. If a rendition is already associated with related screen annotation, it is stopped, and the new rendition (which is specified in rendition action) is associated with the annotation.