PdfAction (Gnostice PDFOne (for Java) API Docs)

java.lang.Object
- com.gnostice.pdfone.PdfAction

Direct Known Subclasses:

PdfGotoAction, PdfJavascriptAction, PdfLaunchAction, PdfNamedAction, PdfRemoteGotoAction, PdfURIAction
```
public abstract class PdfAction
extends Object
```
This abstract class represents an action that will be executed by a viewer displaying the document. Actions can also be triggered by events specified in the PdfEvent inner class. One or more actions can be specified for events associated with the whole document, individual pages, bookmarks, annotations and form fields.

Since:

1.0

See Also:

PdfDocument, PdfBookmark, PdfAnnot, PdfFormField, PdfFormPushButton

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PdfAction.PdfEvent
This inner class represents an event inside a viewer displaying a PDF document.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PdfAction.PdfEvent` This inner class represents an event inside a viewer displaying a PDF document.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GOTO` Action for navigating to a destination in current document.
`static int`	`JAVASCRIPT` Action for executing a JavaScript script.
`static int`	`LAUNCH` Action for launching an application, or a displaying or printing a file.
`static int`	`NAMED` Constant specifying any named action.
`static int`	`NAMED_FIND` As yet (2007) undocumented named action for displaying the text search panel.
`static int`	`NAMED_FIRSTPAGE` Named action for navigating to first page in current document.
`static int`	`NAMED_LASTPAGE` Named action for navigating to last page in current document.
`static int`	`NAMED_NEXTPAGE` Named action for navigating to next page in current document.
`static int`	`NAMED_OPEN` As yet (2007) undocumented named action for displaying a file "Open" dialog box.
`static int`	`NAMED_PREVPAGE` Named action for navigating to previous page in current document.
`static int`	`NAMED_PRINT` As yet (2007) undocumented named action for displaying a file "Print" dialog box.
`static int`	`NAMED_SEARCH` As yet (2007) undocumented, named action for displaying the "Search PDF" panel.
`static int`	`REMOTE_GOTO` Action for navigating to a destination in another document.
`static int`	`URI` Action for making the Operating System (OS) shell program to resolve a specified Uniform Resource Identifier (URI).

Constructor Summary

Constructors
Constructor and Description

PdfAction()

Constructors
Constructor and Description
`PdfAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

int getActionType()
Returns action type.
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getActionType()` Returns action type.

- Field Detail
  - LAUNCH
```
public static final int LAUNCH
```
    Action for launching an application, or a displaying or printing a file.
    
    See Also:
    
    Constant Field Values
  - GOTO
```
public static final int GOTO
```
    Action for navigating to a destination in current document.
    
    See Also:
    
    Constant Field Values
  - REMOTE_GOTO
```
public static final int REMOTE_GOTO
```
    Action for navigating to a destination in another document.
    
    See Also:
    
    Constant Field Values
  - URI
```
public static final int URI
```
    Action for making the Operating System (OS) shell program to resolve a specified Uniform Resource Identifier (URI). An URI could be a website address, an email link, or an ftp location. In Windows™, the OS shell is explorer.exe. When it resolves a website address, it might open the website in a window of the default browser. Similarly, the mail link may be opened in a "New Message" window of the default mail client.
    
    See Also:
    
    Constant Field Values
  - JAVASCRIPT
```
public static final int JAVASCRIPT
```
    Action for executing a JavaScript script.
    
    See Also:
    
    Constant Field Values
  - NAMED_NEXTPAGE
```
public static final int NAMED_NEXTPAGE
```
    Named action for navigating to next page in current document.
    
    See Also:
    
    Constant Field Values
  - NAMED_PREVPAGE
```
public static final int NAMED_PREVPAGE
```
    Named action for navigating to previous page in current document.
    
    See Also:
    
    Constant Field Values
  - NAMED_FIRSTPAGE
```
public static final int NAMED_FIRSTPAGE
```
    Named action for navigating to first page in current document.
    
    See Also:
    
    Constant Field Values
  - NAMED_LASTPAGE
```
public static final int NAMED_LASTPAGE
```
    Named action for navigating to last page in current document.
    
    See Also:
    
    Constant Field Values
  - NAMED_OPEN
```
public static final int NAMED_OPEN
```
    As yet (2007) undocumented named action for displaying a file "Open" dialog box.
    
    See Also:
    
    Constant Field Values
  - NAMED_PRINT
```
public static final int NAMED_PRINT
```
    As yet (2007) undocumented named action for displaying a file "Print" dialog box.
    
    See Also:
    
    Constant Field Values
  - NAMED_FIND
```
public static final int NAMED_FIND
```
    As yet (2007) undocumented named action for displaying the text search panel. This panel allows you to search some text or phrase within the current document.
    
    See Also:
    
    Constant Field Values
  - NAMED_SEARCH
```
public static final int NAMED_SEARCH
```
    As yet (2007) undocumented, named action for displaying the "Search PDF" panel. This panel allows you to search text or phrase in the current documet or in other PDF documents in a specified folder or on the Internet.
    
    See Also:
    
    Constant Field Values
  - NAMED
```
public static final int NAMED
```
    Constant specifying any named action.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdfAction
```
public PdfAction()
```
- Method Detail
  - getActionType
```
public int getActionType()
```
    Returns action type.
    
    Returns:
    
    constant specifying action type

Class PdfAction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAUNCH

GOTO

REMOTE_GOTO

URI

JAVASCRIPT

NAMED_NEXTPAGE

NAMED_PREVPAGE

NAMED_FIRSTPAGE

NAMED_LASTPAGE

NAMED_OPEN

NAMED_PRINT

NAMED_FIND

NAMED_SEARCH

NAMED

Constructor Detail

PdfAction

Method Detail

getActionType