Action (PDFTron PDFNet SDK API Reference)

java.lang.Object
- pdftron.PDF.Action

```
public class Action
extends java.lang.Object
```
Actions are typically what happens when a user clicks on a link or bookmark. Instead of simply jumping to a destination in the document, an annotation or outline item can specify an action for the viewer application to perform, such as launching an application, playing a sound, or changing an annotation’s appearance state.

Note:

Although the Action class provides utility functions for most commonly used action types, it is possible to read, write, and edit any action type using SDF API and dictionary entries described in Section 8.5 in the PDF Reference Manual.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`e_canonical_format` The Constant e_canonical_format.
`static int`	`e_embed_form` The Constant e_embed_form.
`static int`	`e_excl_F_key` The Constant e_excl_F_key.
`static int`	`e_excl_non_user_annots` The Constant e_excl_non_user_annots.
`static int`	`e_exclude` Flags used by submit form actions.
`static int`	`e_export_format` The Constant e_export_format.
`static int`	`e_get_method` The Constant e_get_method.
`static int`	`e_GoTo` PDF supports the standard action types listed in the following table.
`static int`	`e_GoTo3DView` The Constant e_GoTo3DView.
`static int`	`e_GoToE` The Constant e_GoToE.
`static int`	`e_GoToR` The Constant e_GoToR.
`static int`	`e_Hide` The Constant e_Hide.
`static int`	`e_ImportData` The Constant e_ImportData.
`static int`	`e_include_annotations` The Constant e_include_annotations.
`static int`	`e_include_append_saves` The Constant e_include_append_saves.
`static int`	`e_include_no_value_fields` The Constant e_include_no_value_fields.
`static int`	`e_JavaScript` The Constant e_JavaScript.
`static int`	`e_Launch` The Constant e_Launch.
`static int`	`e_Movie` The Constant e_Movie.
`static int`	`e_Named` The Constant e_Named.
`static int`	`e_Rendition` The Constant e_Rendition.
`static int`	`e_ResetForm` The Constant e_ResetForm.
`static int`	`e_SetOCGState` The Constant e_SetOCGState.
`static int`	`e_Sound` The Constant e_Sound.
`static int`	`e_submit_coordinates` The Constant e_submit_coordinates.
`static int`	`e_submit_pdf` The Constant e_submit_pdf.
`static int`	`e_SubmitForm` The Constant e_SubmitForm.
`static int`	`e_Thread` The Constant e_Thread.
`static int`	`e_Trans` The Constant e_Trans.
`static int`	`e_Unknown` The Constant e_Unknown.
`static int`	`e_URI` The Constant e_URI.
`static int`	`e_xfdf` The Constant e_xfdf.

Constructor Summary

Constructors
Constructor and Description

Action(Obj in_obj)
A constructor.

Constructors
Constructor and Description
`Action(Obj in_obj)` A constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`static Action`	`__Create(long impl, java.lang.Object ref)`
`long`	`__GetHandle()`
`java.lang.Object`	`__GetRefHandle()`
`static Action`	`createGoto(byte[] key, Destination dest)` Creates a new 'GoTo' action using a 'Named Destination'.
`static Action`	`createGoto(Destination dest)` Creates a new 'GoTo'action.
`static Action`	`createGotoRemote(FileSpec file, int page_num)` Creates a new 'GoToR' action.
`static Action`	`createGotoRemote(FileSpec file, int page_num, boolean new_window)` Creates a new 'GoToR' action.
`static Action`	`createHideField(PDFDoc doc, java.lang.String[] field_list)` Creates a new 'Show/Hide Field' action.
`static Action`	`createImportData(PDFDoc doc, java.lang.String path)` Creates a new 'Import Data' action.
`static Action`	`createJavaScript(PDFDoc doc, java.lang.String script)` Creates a new 'JavaScript' action.
`static Action`	`createLaunch(PDFDoc doc, java.lang.String path)` Creates a new 'Launch' action.
`static Action`	`createResetForm(PDFDoc doc)` Creates a new 'Reset Form' action.
`static Action`	`createSubmitForm(FileSpec url)` Creates a new 'SubmitForm' action.
`static Action`	`createURI(PDFDoc doc, java.lang.String uri)` Create a new URI action.
`boolean`	`equals(java.lang.Object in_action)` Compares two Action objects for equality.
`void`	`Execute()` Executes current action; this will only work for some action types that can be executed only using the information contained in the action object or the associated PDF doc.
`Destination`	`getDest()` Get the destination view of the Action
`int`	`getFormActionFlag(int flag)` Get the form action flag.
`Obj`	`GetNext()` Get the next action dictionary or dictionaries in an array.
`Obj`	`getSDFObj()` Get the SDFObj.
`int`	`getType()` Get the action type.
`int`	`hashCode()`
`boolean`	`isValid()` Indicates whether the Action is valid (non-null).
`void`	`setFormActionFlag(int flag, boolean value)` Set the value of a given field flag.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - e_GoTo
```
public static final int e_GoTo
```
    PDF supports the standard action types listed in the following table. Plug-in extensions may add new action types.
    
    See Also:
    Constant Field Values
  - e_GoToR
```
public static final int e_GoToR
```
    The Constant e_GoToR.
    
    See Also:
    Constant Field Values
  - e_GoToE
```
public static final int e_GoToE
```
    The Constant e_GoToE.
    
    See Also:
    Constant Field Values
  - e_Launch
```
public static final int e_Launch
```
    The Constant e_Launch.
    
    See Also:
    Constant Field Values
  - e_Thread
```
public static final int e_Thread
```
    The Constant e_Thread.
    
    See Also:
    Constant Field Values
  - e_URI
```
public static final int e_URI
```
    The Constant e_URI.
    
    See Also:
    Constant Field Values
  - e_Sound
```
public static final int e_Sound
```
    The Constant e_Sound.
    
    See Also:
    Constant Field Values
  - e_Movie
```
public static final int e_Movie
```
    The Constant e_Movie.
    
    See Also:
    Constant Field Values
  - e_Hide
```
public static final int e_Hide
```
    The Constant e_Hide.
    
    See Also:
    Constant Field Values
  - e_Named
```
public static final int e_Named
```
    The Constant e_Named.
    
    See Also:
    Constant Field Values
  - e_SubmitForm
```
public static final int e_SubmitForm
```
    The Constant e_SubmitForm.
    
    See Also:
    Constant Field Values
  - e_ResetForm
```
public static final int e_ResetForm
```
    The Constant e_ResetForm.
    
    See Also:
    Constant Field Values
  - e_ImportData
```
public static final int e_ImportData
```
    The Constant e_ImportData.
    
    See Also:
    Constant Field Values
  - e_JavaScript
```
public static final int e_JavaScript
```
    The Constant e_JavaScript.
    
    See Also:
    Constant Field Values
  - e_SetOCGState
```
public static final int e_SetOCGState
```
    The Constant e_SetOCGState.
    
    See Also:
    Constant Field Values
  - e_Rendition
```
public static final int e_Rendition
```
    The Constant e_Rendition.
    
    See Also:
    Constant Field Values
  - e_Trans
```
public static final int e_Trans
```
    The Constant e_Trans.
    
    See Also:
    Constant Field Values
  - e_GoTo3DView
```
public static final int e_GoTo3DView
```
    The Constant e_GoTo3DView.
    
    See Also:
    Constant Field Values
  - e_Unknown
```
public static final int e_Unknown
```
    The Constant e_Unknown.
    
    See Also:
    Constant Field Values
  - e_exclude
```
public static final int e_exclude
```
    Flags used by submit form actions. Exclude flag is also used by reset form action. No other action types use flags in the current version of PDF standard (ISO 2300).
    
    See Also:
    Constant Field Values
  - e_include_no_value_fields
```
public static final int e_include_no_value_fields
```
    The Constant e_include_no_value_fields.
    
    See Also:
    Constant Field Values
  - e_export_format
```
public static final int e_export_format
```
    The Constant e_export_format.
    
    See Also:
    Constant Field Values
  - e_get_method
```
public static final int e_get_method
```
    The Constant e_get_method.
    
    See Also:
    Constant Field Values
  - e_submit_coordinates
```
public static final int e_submit_coordinates
```
    The Constant e_submit_coordinates.
    
    See Also:
    Constant Field Values
  - e_xfdf
```
public static final int e_xfdf
```
    The Constant e_xfdf.
    
    See Also:
    Constant Field Values
  - e_include_append_saves
```
public static final int e_include_append_saves
```
    The Constant e_include_append_saves.
    
    See Also:
    Constant Field Values
  - e_include_annotations
```
public static final int e_include_annotations
```
    The Constant e_include_annotations.
    
    See Also:
    Constant Field Values
  - e_submit_pdf
```
public static final int e_submit_pdf
```
    The Constant e_submit_pdf.
    
    See Also:
    Constant Field Values
  - e_canonical_format
```
public static final int e_canonical_format
```
    The Constant e_canonical_format.
    
    See Also:
    Constant Field Values
  - e_excl_non_user_annots
```
public static final int e_excl_non_user_annots
```
    The Constant e_excl_non_user_annots.
    
    See Also:
    Constant Field Values
  - e_excl_F_key
```
public static final int e_excl_F_key
```
    The Constant e_excl_F_key.
    
    See Also:
    Constant Field Values
  - e_embed_form
```
public static final int e_embed_form
```
    The Constant e_embed_form.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Action
```
public Action(Obj in_obj)
       throws PDFNetException
```
    A constructor. Creates an Action and initializes it using given Cos/SDF object.
    
    Parameters:
    in_obj - Pointer to the Cos/SDF object.
    
    Throws:
    
    PDFNetException
    Note:
    
    The constructor does not copy any data, but is instead the logical equivalent of a type cast.
- Method Detail
  - createGoto
```
public static Action createGoto(Destination dest)
                         throws PDFNetException
```
    Creates a new 'GoTo'action. GoTo action takes the user to the specified Destination view located in the same document.
    
    Parameters:
    dest - A Destination for the new Action.
    
    Returns:
    the created 'GoTo' action
    
    Throws:
    
    PDFNetException
    Note:
    
    This method can only be used for destinations in the same document as the source document. For cross-document links use Action::CreateGotoRemote().
  - createGoto
```
public static Action createGoto(byte[] key,
                Destination dest)
                         throws PDFNetException
```
    Creates a new 'GoTo' action using a 'Named Destination'. GoTo action takes the user to the specified 'Named Destination' view located in the same document.
    
    Parameters:
    key - - a string buffer representing the destination name. The named destination will be stored in document's '/Dest' SDF::NameTree.
    dest - The explicit destination used to create the named destination.
    
    Returns:
    the created 'GoTo' action
    
    Throws:
    
    PDFNetException
  - createGotoRemote
```
public static Action createGotoRemote(FileSpec file,
                      int page_num)
                               throws PDFNetException
```
    Creates a new 'GoToR' action. A remote go-to action is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file.
    
    Parameters:
    file - The file referred to by the action.
    page_num - A page number within the remote document. The first page is numbered 0.
    
    Returns:
    the created 'GoToR' action
    
    Throws:
    
    PDFNetException
  - createGotoRemote
```
public static Action createGotoRemote(FileSpec file,
                      int page_num,
                      boolean new_window)
                               throws PDFNetException
```
    Creates a new 'GoToR' action. See the above method for details.
    
    Parameters:
    file - The file referred to by the action.
    page_num - A page number within the remote document. The first page is numbered 0.
    new_window - the new_window
    
    Returns:
    the created 'GoToR' action
    
    Throws:
    
    PDFNetException
  - createURI
```
public static Action createURI(PDFDoc doc,
               java.lang.String uri)
                        throws PDFNetException
```
    Create a new URI action. The URL action is typically resolved by opening a URL in the default web browser.
    
    Parameters:
    doc - The document in which to create the action.
    uri - The uniform resource identifier to resolve, encoded in 7-bit ASCII. A uniform resource identifier (URI) is a string that identifies (resolves to) a resource on the Internet—typically a file that is the destination of a hypertext link, although it can also resolve to a query or other entity. (URIs are described in Internet RFC 2396, Uniform Resource Identifiers (URI).
    
    Returns:
    the created URI action
    
    Throws:
    
    PDFNetException
  - createSubmitForm
```
public static Action createSubmitForm(FileSpec url)
                               throws PDFNetException
```
    Creates a new 'SubmitForm' action. A submit-form action transmits the names and values of selected interactive form fields to a specified uniform resource locator (URL), presumably the address of a Web server that will process them and send back a response.
    
    Parameters:
    url - A URL file specification giving the uniform resource locator (URL) of the script at the Web server that will process the submission.
    
    Returns:
    the created 'SubmitForm' action
    
    Throws:
    
    PDFNetException
  - createLaunch
```
public static Action createLaunch(PDFDoc doc,
                  java.lang.String path)
```
    Creates a new 'Launch' action. A launch action opens up a file using the most appropriate program.
    
    Parameters:
    doc - the document in which to create the action
    path - the full path of the file to be opened
    
    Returns:
    the created 'Launch' action
  - createHideField
```
public static Action createHideField(PDFDoc doc,
                     java.lang.String[] field_list)
```
    Creates a new 'Show/Hide Field' action. A show/hide field action shows or hide certain fields when it's invoked.
    
    Parameters:
    doc - the document in which to create the action
    field_list - field the list of fields to hide
    
    Returns:
    the created 'Show/Hide Field' action
  - createImportData
```
public static Action createImportData(PDFDoc doc,
                      java.lang.String path)
```
    Creates a new 'Import Data' action. An import data action imports form data from a FDF file into a PDF document.
    
    Parameters:
    doc - the document in which to create the action
    path - the full path of the FDF file
    
    Returns:
    the created 'Import Data' action
  - createResetForm
```
public static Action createResetForm(PDFDoc doc)
```
    Creates a new 'Reset Form' action. A reset form action reset choosen form fields to their default value.
    
    Parameters:
    doc - the document in which to create the action
    
    Returns:
    the created 'Reset Form' action
  - createJavaScript
```
public static Action createJavaScript(PDFDoc doc,
                      java.lang.String script)
```
    Creates a new 'JavaScript' action. A javascript action executes a JavaScript script when it's invoked.
    
    Parameters:
    doc - the document in which to create the action
    script - the JavaScript script to be executed
    
    Returns:
    the created 'JavaScript' action
  - Execute
```
public void Execute()
             throws PDFNetException
```
    Executes current action; this will only work for some action types that can be executed only using the information contained in the action object or the associated PDF doc. See also PDFViewCtrl::ExecuteAction()
    
    Throws:
    
    PDFNetException
  - GetNext
```
public Obj GetNext()
            throws PDFNetException
```
    Get the next action dictionary or dictionaries in an array.
    
    Returns:
    The next action dictionary, an array of action dictionaries, or NULL if there are no additional actions. Sequences of actions can be chained together. For example, the effect of clicking a link annotation with the mouse might be to play a sound, jump to a new page, and start up a movie. Note that the Next entry is not restricted to a single action but may contain an array of actions, each of which in turn may have a Next entry of its own. The actions may thus form a tree instead of a simple linked list. Actions within each Next array are executed in order, each followed in turn by any actions specified in its Next entry, and so on recursively.
    
    Throws:
    
    PDFNetException
  - equals
```
public boolean equals(java.lang.Object in_action)
```
    Compares two Action objects for equality.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    in_action - A reference to an existing Action object.
    
    Returns:
    True if the both Actions share the same underlying SDF/Cos object; otherwise false.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isValid
```
public boolean isValid()
                throws PDFNetException
```
    Indicates whether the Action is valid (non-null).
    
    Returns:
    True if this is a valid (non-null) Action; otherwise false.
    
    Throws:
    
    PDFNetException
    Note:
    
    If this method returns false the underlying SDF/Cos object is null and the Action object should be treated as null as well.
  - getType
```
public int getType()
            throws PDFNetException
```
    Get the action type.
    
    Returns:
    The type of this Action.
    
    Throws:
    
    PDFNetException
  - getDest
```
public Destination getDest()
                    throws PDFNetException
```
    Get the destination view of the Action
    
    Returns:
    The Action's Destination view.
    
    Throws:
    
    PDFNetException
    Note:
    
    This only applies for Actions whose subtype is "GoTo"., All named destinations are automatically resolved to the explicit destination so you can access destination members directly.
  - getFormActionFlag
```
public int getFormActionFlag(int flag)
                      throws PDFNetException
```
    Get the form action flag.
    
    Parameters:
    flag - the flag
    
    Returns:
    value of the given action flag.
    
    Throws:
    
    PDFNetException
    Note:
    
    Action flags are currently only used by submit and reset form actions.
  - setFormActionFlag
```
public void setFormActionFlag(int flag,
                     boolean value)
                       throws PDFNetException
```
    Set the value of a given field flag. Action flags are currently only used by submit and reset form actions.
    
    Parameters:
    flag - given field flag
    value - value of the flag
    
    Throws:
    
    PDFNetException
  - getSDFObj
```
public Obj getSDFObj()
```
    Get the SDFObj.
    
    Returns:
    Pointer to the underlying SDF/Cos object.
  - __Create
```
public static Action __Create(long impl,
              java.lang.Object ref)
```
  - __GetHandle
```
public long __GetHandle()
```
  - __GetRefHandle
```
public java.lang.Object __GetRefHandle()
```

Class Action

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

e_GoTo

e_GoToR

e_GoToE

e_Launch

e_Thread

e_URI

e_Sound

e_Movie

e_Hide

e_Named

e_SubmitForm

e_ResetForm

e_ImportData

e_JavaScript

e_SetOCGState

e_Rendition

e_Trans

e_GoTo3DView

e_Unknown

e_exclude

e_include_no_value_fields

e_export_format

e_get_method

e_submit_coordinates

e_xfdf

e_include_append_saves

e_include_annotations

e_submit_pdf

e_canonical_format

e_excl_non_user_annots

e_excl_F_key

e_embed_form

Constructor Detail

Action

Method Detail

createGoto

createGoto

createGotoRemote

createGotoRemote

createURI

createSubmitForm

createLaunch

createHideField

createImportData

createResetForm

createJavaScript

Execute

GetNext

equals

hashCode

isValid

getType

getDest

getFormActionFlag

setFormActionFlag

getSDFObj

__Create

__GetHandle

__GetRefHandle