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
public abstract class PDAction extends java.lang.Object implements PDDestinationOrAction
This represents an action that can be executed in a PDF document.
-
-
Field Summary
Fields Modifier and Type Field Description protected COSDictionary
action
The action dictionary.static java.lang.String
TYPE
The type of PDF object.
-
Constructor Summary
Constructors Constructor Description PDAction()
Default constructor.PDAction(COSDictionary a)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description COSDictionary
getCOSObject()
Convert this standard java object to a COS object.java.util.List<PDAction>
getNext()
This will get the next action, or sequence of actions, to be performed after this one.java.lang.String
getSubType()
This will get the type of action that the actions dictionary describes.java.lang.String
getType()
This will get the type of PDF object that the actions dictionary describes.void
setNext(java.util.List<?> next)
This will set the next action, or sequence of actions, to be performed after this one.void
setSubType(java.lang.String s)
This will set the type of action that the actions dictionary describes.void
setType(java.lang.String type)
This will set the type of PDF object that the actions dictionary describes.
-
-
-
Field Detail
-
TYPE
public static final java.lang.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 interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getType
public java.lang.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(java.lang.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 java.lang.String getSubType()
This will get the type of action that the actions dictionary describes.- Returns:
- The S entry of actions dictionary.
-
setSubType
public void setSubType(java.lang.String s)
This will set the type of action that the actions dictionary describes.- Parameters:
s
- The new type of action.
-
getNext
public java.util.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(java.util.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.
-
-