Class PDAction
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
- Direct Known Subclasses:
PDActionEmbeddedGoTo
,PDActionGoTo
,PDActionHide
,PDActionImportData
,PDActionJavaScript
,PDActionLaunch
,PDActionMovie
,PDActionNamed
,PDActionRemoteGoTo
,PDActionResetForm
,PDActionSound
,PDActionSubmitForm
,PDActionThread
,PDActionURI
This represents an action that can be executed in a PDF document.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected COSDictionary
The action dictionary.static final String
The type of PDF object. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.getNext()
This will get the next action, or sequence of actions, to be performed after this one.This will get the type of action that the actions dictionary describes.getType()
This will get the type of PDF object that the actions dictionary describes.void
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.final void
This will set the type of PDF object that the actions dictionary describes.
-
Field Details
-
TYPE
The type of PDF object.- See Also:
-
action
The action dictionary.
-
-
Constructor Details
-
PDAction
public PDAction()Default constructor. -
PDAction
Constructor.- Parameters:
a
- The action dictionary.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
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
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
This will get the type of action that the actions dictionary describes.- Returns:
- The S entry of actions dictionary.
-
setSubType
This will set the type of action that the actions dictionary describes.- Parameters:
s
- The new type of action.
-
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
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.
-