PDAction (Apache PDFBox 2.0.0 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.action.PDAction

All Implemented Interfaces:

COSObjectable, PDDestinationOrAction

Direct Known Subclasses:

PDActionGoTo, PDActionHide, PDActionImportData, PDActionJavaScript, PDActionLaunch, PDActionMovie, PDActionNamed, PDActionRemoteGoTo, PDActionResetForm, PDActionSound, PDActionSubmitForm, PDActionThread, PDActionURI
```
public abstract class PDAction
extends Object
implements PDDestinationOrAction
```
This represents an action that can be executed in a PDF document.

Author:

Ben Litchfield, Panagiotis Toumasis

Field Summary

Fields
Modifier and Type Field and Description

protected COSDictionary action
The action dictionary.

static String TYPE
The type of PDF object.

Fields
Modifier and Type	Field and Description
`protected COSDictionary`	`action` The action dictionary.
`static String`	`TYPE` The type of PDF object.

Constructor Summary

Constructors
Constructor and Description

PDAction()
Default constructor.

PDAction(COSDictionary a)
Constructor.

Constructors
Constructor and Description
`PDAction()` Default constructor.
`PDAction(COSDictionary a)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`COSDictionary`	`getCOSObject()` Convert this standard java object to a COS object.
`List<PDAction>`	`getNext()` This will get the next action, or sequence of actions, to be performed after this one.
`String`	`getSubType()` This will get the type of action that the actions dictionary describes.
`String`	`getType()` This will get the type of PDF object that the actions dictionary describes.
`void`	`setNext(List<?> next)` This will set the next action, or sequence of actions, to be performed after this one.
`void`	`setSubType(String s)` This will set the type of action that the actions dictionary describes.
`void`	`setType(String type)` This will set the type of PDF object that the actions dictionary describes.

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

- Field Detail
  - TYPE
```
public static final String TYPE
```
    The type of PDF object.
    
    See Also:
    Constant Field Values
  - action
```
protected COSDictionary action
```
    The action dictionary.
- Constructor Detail
  - PDAction
```
public PDAction()
```
    Default constructor.
  - PDAction
```
public PDAction(COSDictionary a)
```
    Constructor.
    
    Parameters:
    a - The action dictionary.
- Method Detail
  - getCOSObject
```
public COSDictionary getCOSObject()
```
    Convert this standard java object to a COS object.
    
    Specified by:
    
    getCOSObject in interface COSObjectable
    
    Returns:
    The cos object that matches this Java object.
  - getType
```
public String getType()
```
    This will get the type of PDF object that the actions dictionary describes. If present must be Action for an action dictionary.
    
    Returns:
    The Type of PDF object.
  - setType
```
public final void setType(String type)
```
    This will set the type of PDF object that the actions dictionary describes. If present must be Action for an action dictionary.
    
    Parameters:
    type - The new Type for the PDF object.
  - getSubType
```
public String getSubType()
```
    This will get the type of action that the actions dictionary describes. If present, must be Action for an action dictionary.
    
    Returns:
    The S entry of actions dictionary.
  - setSubType
```
public void setSubType(String s)
```
    This will set the type of action that the actions dictionary describes. If present, must be Action for an action dictionary.
    
    Parameters:
    s - The new type of action.
  - getNext
```
public List<PDAction> getNext()
```
    This will get the next action, or sequence of actions, to be performed after this one. The value is either a single action dictionary or an array of action dictionaries to be performed in order.
    
    Returns:
    The Next action or sequence of actions.
  - setNext
```
public void setNext(List<?> next)
```
    This will set the next action, or sequence of actions, to be performed after this one. The value is either a single action dictionary or an array of action dictionaries to be performed in order.
    
    Parameters:
    next - The Next action or sequence of actions.

Class PDAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE

action

Constructor Detail

PDAction

PDAction

Method Detail

getCOSObject

getType

setType

getSubType

setSubType

getNext

setNext