Class PDActionSubmitForm
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.action.PDAction
org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
- All Implemented Interfaces:
COSObjectable
,PDDestinationOrAction
This represents a Submit-Form action that can be executed in a PDF document.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault ConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionAn array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entrygetFile()
This will get the file in which the destination is located.int
getFlags()
A set of flags specifying various characteristics of the actionvoid
void
This will set the file in which the destination is located.void
setFlags
(int flags) Methods inherited from class org.apache.pdfbox.pdmodel.interactive.action.PDAction
getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType
-
Field Details
-
SUB_TYPE
This type of action this object represents.- See Also:
-
-
Constructor Details
-
PDActionSubmitForm
public PDActionSubmitForm()Default Constructor -
PDActionSubmitForm
Constructor- Parameters:
a
- the action dictionary
-
-
Method Details
-
getFile
This will get the file in which the destination is located.- Returns:
- The F entry of the specific Submit-From action dictionary.
- Throws:
IOException
- If there is an error creating the file spec.
-
setFile
This will set the file in which the destination is located.- Parameters:
fs
- The file specification.
-
getFields
An array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entry- Returns:
- the array of fields
-
setFields
- Parameters:
array
- the array of fields
-
getFlags
public int getFlags()A set of flags specifying various characteristics of the action- Returns:
- the flags
-
setFlags
public void setFlags(int flags) - Parameters:
flags
- the flags
-