Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.action

public abstract Class PDAction

extends Object
implements PDDestinationOrAction
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.PDDestinationOrAction, org.apache.pdfbox.pdmodel.common.COSObjectable
Known Direct Subclasses
org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo, org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo, org.apache.pdfbox.pdmodel.interactive.action.PDActionHide, org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData, org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript, org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch, org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie, org.apache.pdfbox.pdmodel.interactive.action.PDActionNamed, org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo, org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm, org.apache.pdfbox.pdmodel.interactive.action.PDActionSound, org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm, org.apache.pdfbox.pdmodel.interactive.action.PDActionThread, org.apache.pdfbox.pdmodel.interactive.action.PDActionURI
Imports
java.util.ArrayList, .List, org.apache.pdfbox.cos.COSArray, .COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSArrayList, .PDDestinationOrAction

This represents an action that can be executed in a PDF document.
Authors
Ben Litchfield, Panagiotis Toumasis

Field Summary

Modifier and TypeField and Description
protected final COSDictionary
action

The action dictionary.

public static final String
TYPE

The type of PDF object.

Constructor Summary

AccessConstructor and Description
public
PDAction()

Default constructor.

public
PDAction(COSDictionary
The action dictionary.
a
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject
()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public List<PDAction>

Returns:

The Next action or sequence of actions.
getNext
()

This will get the next action, or sequence of actions, to be performed after this one.

public final String

Returns:

The S entry of actions dictionary.
getSubType
()

This will get the type of action that the actions dictionary describes.

public final String

Returns:

The Type of PDF object.
getType
()

This will get the type of PDF object that the actions dictionary describes.

public void
setNext(List<PDAction>
The Next action or sequence of actions.
next
)

This will set the next action, or sequence of actions, to be performed after this one.

protected final void
setSubType(String
The new type of action.
s
)

This will set the type of action that the actions dictionary describes.

protected final void
setType(String
The new Type for the PDF object.
type
)

This will set the type of PDF object that the actions dictionary describes.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actionback to summary
protected final COSDictionary action

The action dictionary.

TYPEback to summary
public static final String TYPE

The type of PDF object.

Constructor Detail

PDActionback to summary
public PDAction()

Default constructor.

PDActionback to summary
public PDAction(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getNextback to summary
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:List<PDAction>

The Next action or sequence of actions.

getSubTypeback to summary
public final String getSubType()

This will get the type of action that the actions dictionary describes.

Returns:String

The S entry of actions dictionary.

getTypeback to summary
public final 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:String

The Type of PDF object.

setNextback to summary
public void setNext(List<PDAction> 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:List<PDAction>

The Next action or sequence of actions.

setSubTypeback to summary
protected final void setSubType(String s)

This will set the type of action that the actions dictionary describes.

Parameters
s:String

The new type of action.

setTypeback to summary
protected 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:String

The new Type for the PDF object.