com.foxit.sdk.pdf.actions.EmbeddedGotoAction Class Reference
Inheritance diagram for com.foxit.sdk.pdf.actions.EmbeddedGotoAction:
com.foxit.sdk.pdf.actions.Action com.foxit.sdk.common.Base

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...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.actions.Action
 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 Public Member Functions inherited from com.foxit.sdk.pdf.actions.Action
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 inherited from com.foxit.sdk.pdf.actions.Action
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.

 

Detailed Description

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 EmbeddedGotoTarget is derived from Action and offers functions to get/set embedded go-to action data.

See also
Action

Constructor & Destructor Documentation

◆ EmbeddedGotoAction()

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

Constructor, with parent class object.

Parameters
actionParent class object.

Member Function Documentation

◆ getDestination()

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 it is a Destination object, function EmbeddedGotoAction::getDestination would return a valid Destination object.
If it is a destination name, function EmbeddedGotoAction::getDestinationName would return a valid string, and the destination name would be defined in the final target PDF file.
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.

Returns
A Destination object. If the return value of function Destination::isEmpty for the returned Destination object is true, please try function EmbeddedGotoAction::getDestinationName.

◆ getDestinationName()

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 it is a Destination object, function EmbeddedGotoAction::getDestination would return a valid Destination object.
If it is a destination name, function EmbeddedGotoAction::getDestinationName would return a valid string, and the destination name would be defined in the target PDF file.
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.

Returns
The destination name. If this function returns an empty string, please try function EmbeddedGotoAction::getDestination.

◆ getNewWindowFlag()

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.

Returns
The new windows flag. It would be one of following values:

e_NewWindowFlagTrue means to open the destination document in a new window.
e_NewWindowFlagFalse means that the destination document replaces current document in the same window.
e_NewWindowFlagNone means that no such flag and the viewer application should behave in accordance with the current user preference.

◆ getRootFile()

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.

Returns
A non-embedded FileSpec object. If the return value of function FileSpec::isEmpty for the returned FileSpec object is true, that means the PDF file which contains current embedded goto action is just the root file for target object.

◆ getTarget()

EmbeddedGotoTarget com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getTarget ( ) throws com.foxit.sdk.PDFException

Get the target.

Returns
A EmbeddedGotoTarget object. If the return value of function EmbeddedGotoTarget::isEmpty for the returned EmbeddedGotoTarget object is true, that means no target.

◆ setDestination()

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.

Parameters
destinationA valid Destination object to be set.
Returns
None.

◆ setDestinationName()

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.

Parameters
dest_nameA destination name to be set. It should not be an empty string.
Returns
None.

◆ setNewWindowFlag()

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.

Parameters
flagThe new window flag. It should be one of following values:

e_NewWindowFlagTrue means to open the destination document in a new window.
e_NewWindowFlagFalse means that the destination document replaces current document in the same window.
e_NewWindowFlagNone means that no such flag and the viewer application should behave in accordance with the current user preference.

Returns
None.

◆ setRootFile()

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.

Parameters
file_specificationThe FileSpec object:

It can be constructed by default constructor and not set any value. In this case, that means the PDF file which contains current embedded goto action is also the root file for target.
Otherwise, this should be a valid FileSpec object, and should represent another file, not an embedded file. The FileSpec object should be in the same PDF file as current action.

Returns
None.

◆ setTarget()

void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setTarget ( EmbeddedGotoTarget  target) throws com.foxit.sdk.PDFException

Set the target.

Parameters
targetA EmbeddedGotoTarget object. If this is constructed by default constructor and has not been set any value, that means no target.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.