Public Member Functions | |
EmbeddedGotoAction (Action action) | |
Constructor, with parent class object. More... | |
Destination | getDestination () throws com.foxit.sdk.PDFException |
Get the destination information which specifies where to jump to in the final target file. More... | |
String | getDestinationName () throws com.foxit.sdk.PDFException |
Get the destination name which is defined in final target PDF file. More... | |
int | getNewWindowFlag () throws com.foxit.sdk.PDFException |
Get the flag which is used to decide whether to open the destination document in a new window or not. More... | |
FileSpec | getRootFile () throws com.foxit.sdk.PDFException |
Get the file specification of the root file which is the root file for the target. More... | |
EmbeddedGotoTarget | getTarget () throws com.foxit.sdk.PDFException |
Get the target. More... | |
void | setDestination (Destination destination) throws com.foxit.sdk.PDFException |
Set the destination information which specifies where to jump to in the final target file. More... | |
void | setDestinationName (String dest_name) throws com.foxit.sdk.PDFException |
Set the destination name. More... | |
void | setNewWindowFlag (int flag) throws com.foxit.sdk.PDFException |
Set the flag which is used to decide whether to open the destination document in a new window or not. More... | |
void | setRootFile (FileSpec file_specification) throws com.foxit.sdk.PDFException |
Set the file specification of the root file which is the root file for the target. More... | |
void | setTarget (EmbeddedGotoTarget target) throws com.foxit.sdk.PDFException |
Set the target. 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... | |
Additional Inherited Members | |
![]() | |
static Action | create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException |
Create a new action, for specified action type. More... | |
![]() | |
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. | |
Embedded go-to action is similar to a remote go-to action but allows jumping to or from a PDF file that is embedded in another PDF file. Class com.foxit.sdk.pdf.actions.EmbeddedGotoTarget is derived from Action and offers functions to get/set embedded go-to action data.
com.foxit.sdk.pdf.actions.EmbeddedGotoAction.EmbeddedGotoAction | ( | Action | action | ) |
Constructor, with parent class object.
[in] | action | Parent class object. |
Destination com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getDestination | ( | ) | throws com.foxit.sdk.PDFException |
Get the destination information which specifies where to jump to in the final target file.
For a embedded go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function Destination.isEmpty for the returned destination object is true and function EmbeddedGotoAction.getDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
String com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getDestinationName | ( | ) | throws com.foxit.sdk.PDFException |
Get the destination name which is defined in final target PDF file.
For a remote go-to action, the destination information can be stored as either a destination object or a destination name:
If the return value of function Destination.isEmpty for the returned destination object is true and function EmbeddedGotoAction.getDestinationName returns an empty string, that means the embedded go-to action does not have any destination information.
int com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getNewWindowFlag | ( | ) | throws com.foxit.sdk.PDFException |
Get the flag which is used to decide whether to open the destination document in a new window or not.
FileSpec com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getRootFile | ( | ) | throws com.foxit.sdk.PDFException |
Get the file specification of the root file which is the root file for the target.
EmbeddedGotoTarget com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getTarget | ( | ) | throws com.foxit.sdk.PDFException |
Get the target.
void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setDestination | ( | Destination | destination | ) | throws com.foxit.sdk.PDFException |
Set the destination information which specifies where to jump to in the final target file.
[in] | destination | A valid destination object to be set. |
void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setDestinationName | ( | String | dest_name | ) | throws com.foxit.sdk.PDFException |
Set the destination name.
The destination name should have been in the "Dests" name tree in the target PDF file.
[in] | dest_name | A destination name to be set. It should not be an empty string. |
void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setNewWindowFlag | ( | int | flag | ) | throws com.foxit.sdk.PDFException |
Set the flag which is used to decide whether to open the destination document in a new window or not.
[in] | flag | The new window flag. It should be one of following values:
|
void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setRootFile | ( | FileSpec | file_specification | ) | throws com.foxit.sdk.PDFException |
Set the file specification of the root file which is the root file for the target.
[in] | file_specification | The file specification object:
|
void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setTarget | ( | EmbeddedGotoTarget | target | ) | throws com.foxit.sdk.PDFException |
Set the target.
[in] | target | An embedded goto target object. If this is constructed by default constructor and has not been set any value, that means no target. |