Public Member Functions | |
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... | |
Static Public Member Functions | |
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException |
Create a new action, for specified action type. More... | |
Static Public Attributes | |
static final int | e_NewWindowFlagFalse = 0 |
"NewWindow" flag is false. | |
static final int | e_NewWindowFlagNone = 2 |
No "NewWindow" flag. | |
static final int | e_NewWindowFlagTrue = 1 |
"NewWindow" flag is true. | |
static final int | e_TypeGoto = 1 |
Action type: go-to action. | |
static final int | e_TypeGoTo3DView = 18 |
Action type: go-to-3D-view action. | |
static final int | e_TypeGoToE = 3 |
Action type: embedded go-to action. | |
static final int | e_TypeGoToR = 2 |
Action type: remote go-to action. | |
static final int | e_TypeHide = 9 |
Action type: hide action. | |
static final int | e_TypeImportData = 13 |
Action type: import-data action. | |
static final int | e_TypeJavaScript = 14 |
Action type: JavaScript action. | |
static final int | e_TypeLaunch = 4 |
Action type: launch action. | |
static final int | e_TypeMovie = 8 |
Action type: movie action. | |
static final int | e_TypeNamed = 10 |
Action type: named action. | |
static final int | e_TypeRendition = 16 |
Action type: rendition action. | |
static final int | e_TypeResetForm = 12 |
Action type: reset-form action. | |
static final int | e_TypeSetOCGState = 15 |
Action type: set-OCG-state action. | |
static final int | e_TypeSound = 7 |
Action type: sound action. | |
static final int | e_TypeSubmitForm = 11 |
Action type: submit-form action. | |
static final int | e_TypeThread = 5 |
Action type: thread action. | |
static final int | e_TypeTrans = 17 |
Action type: transition action. | |
static final int | e_TypeUnknown = 0 |
Action type: unknown action. | |
static final int | e_TypeURI = 6 |
Action type: uniform resource identifier (URI) action. | |
PDF supports following standard action types:
"Go-To Action", "Remote Go-To Action", "Embedded Go-To Action", "Launch Action", "Thread Action", "URI
Action", "Sound Action","Movie Action", "Hide Action", "Named Action", "Submit-Form Action", "Reset-Form
Action", "Import-Data Action", "JavaScript Action", "Set-OCG-State Action", "Rendition Action","Transition
Action","Go-To-3D-View Action".
A PDF action may have sub-actions. When this action is triggered, its sub-actions should also be triggered in turn.
Class Action is the base class for all kinds of PDF actions. For concrete action types, please refer to derived classes. Function Action::create can be used to create a new action – currently only support some action types. Please refer to comment of this function for more details. This class also offers functions to modify sub-actions.
com.foxit.sdk.pdf.actions.Action.Action | ( | PDFDoc | document, |
PDFDictionary | action_dict | ||
) |
Constructor, with parameters.
document | A valid PDF document object. |
action_dict | A PDF dictionary object that represents an action. |
com.foxit.sdk.pdf.actions.Action.Action | ( | Action | action | ) |
|
static |
Create a new action, for specified action type.
The newly created action has no action data (except action type) yet. User needs to call the functions in concrete action classes to set action data.
document | A valid PDF document, to which the new action belongs. |
action_type | Action type, used to specify which type of action is to be created. Currently only support: actions::e_TypeGoto, actions::e_TypeURI, actions::e_TypeJavaScript, actions::e_TypeNamed, actions::e_TypeGoToR, actions::e_TypeGoToE, actions::e_TypeSubmitForm, actions::e_TypeResetForm, actions::e_TypeHide, actions::e_TypeLaunch, actions::e_TypeImportData, actions::e_TypeRendition. |
PDFDictionary com.foxit.sdk.pdf.actions.Action.getDict | ( | ) | throws com.foxit.sdk.PDFException |
Get PDF dictionary of current object.
PDFDoc com.foxit.sdk.pdf.actions.Action.getDocument | ( | ) | throws com.foxit.sdk.PDFException |
Get the PDF document, to which current action belongs.
Action com.foxit.sdk.pdf.actions.Action.getSubAction | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get a sub-action by index.
index | Index of sub-action to be retrieved. Valid range: from 0 to (count-1). count is returned by function Action::getSubActionCount. |
int com.foxit.sdk.pdf.actions.Action.getSubActionCount | ( | ) | throws com.foxit.sdk.PDFException |
Get the count of sub-actions.
int com.foxit.sdk.pdf.actions.Action.getType | ( | ) | throws com.foxit.sdk.PDFException |
Get action type.
void com.foxit.sdk.pdf.actions.Action.insertSubAction | ( | int | index, |
Action | sub_action | ||
) | throws com.foxit.sdk.PDFException |
Insert a new sub-action to the location specified by index.
index | Index of the location, where the new sub-action is inserted. If this index value is below zero, the new sub-action will be inserted to be the first. If this index value equals or larger than current sub-action count, the new sub-action will be inserted to be the last. |
sub_action | New sub-action to be inserted. Currently only support following types as the new sub-action: actions::e_TypeGoto, actions::e_TypeURI, actions::e_TypeJavaScript, actions::e_TypeNamed, actions::e_TypeGoToR, actions::e_TypeGoToE, actions::e_TypeSubmitForm, actions::e_TypeResetForm, actions::e_TypeHide, actions::e_TypeLaunch, actions::e_TypeImportData, actions::e_TypeRendition. |
boolean com.foxit.sdk.pdf.actions.Action.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void com.foxit.sdk.pdf.actions.Action.removeAllSubActions | ( | ) | throws com.foxit.sdk.PDFException |
Remove all the sub-actions.
void com.foxit.sdk.pdf.actions.Action.removeSubAction | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Remove a sub-action, specified by index.
index | Index of sub-action to be retrieved. Valid range: from 0 to (count-1). count is returned by function Action::getSubActionCount. |
void com.foxit.sdk.pdf.actions.Action.setSubAction | ( | int | index, |
Action | sub_action | ||
) | throws com.foxit.sdk.PDFException |
Set a sub-action by index.
index | Index of sub-action to be retrieved. Valid range: from 0 to (count-1). count is returned by function Action::getSubActionCount. |
sub_action | An Action object to be set as a sub-action. Currently only support following types as sub-action: actions::e_TypeGoto, actions::e_TypeURI, actions::e_TypeJavaScript, actions::e_TypeNamed, actions::e_TypeGoToR, actions::e_TypeGoToE, actions::e_TypeSubmitForm, actions::e_TypeResetForm, actions::e_TypeHide, actions::e_TypeLaunch, actions::e_TypeImportData, actions::e_TypeRendition. |