org.pdfbox.pdmodel.interactive.action.type

Class PDAction

Implemented Interfaces:
COSObjectable, PDDestinationOrAction
Known Direct Subclasses:
PDActionGoTo, PDActionJavaScript, PDActionLaunch, PDActionRemoteGoTo, PDActionURI

public abstract class PDAction
extends java.lang.Object
implements PDDestinationOrAction

This represents an action that can be executed in a PDF document.
Version:
$Revision: 1.3 $
Authors:
Ben Litchfield
Panagiotis Toumasis (ptoumasis@mail.gr)

Field Summary

static String
TYPE
The type of PDF object.
protected COSDictionary
action
The action dictionary.

Constructor Summary

PDAction()
Default constructor.
PDAction(COSDictionary a)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
List
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.

Field Details

TYPE

public static final String TYPE
The type of PDF object.

action

protected COSDictionary action
The action dictionary.

Constructor Details

PDAction

public PDAction()
Default constructor.

PDAction

public PDAction(COSDictionary a)
Constructor.
Parameters:
a - The action dictionary.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase 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.

getNext

public List 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.

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.

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.

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.

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.

setType

public 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.