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

public Class PDActionSubmitForm

extends PDAction
Class Inheritance
Imports
org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification, java.io.IOException
This represents a Submit-Form action that can be executed in a PDF document.
Author
Evgeniy Muravitskiy

Field Summary

Modifier and TypeField and Description
public static final String
SUB_TYPE

This type of action this object represents.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
actionTYPE

Constructor Summary

AccessConstructor and Description
public
PDActionSubmitForm()

Default Constructor

public
PDActionSubmitForm(COSDictionary
the action dictionary
a)

Constructor

Method Summary

Modifier and TypeMethod and Description
public COSArray

Returns:

the array of fields
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

public PDFileSpecification

Returns:

The F entry of the specific Submit-From action dictionary.
getFile()

This will get the file in which the destination is located.

public int

Returns:

the flags
getFlags()

A set of flags specifying various characteristics of the action

public void
setFields(COSArray
the array of fields
array)

public void
setFile(PDFileSpecification
The file specification.
fs)

This will set the file in which the destination is located.

public void
setFlags(int
the flags
flags)

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:
getCOSObjectgetNextgetSubTypegetTypesetNextsetSubTypesetType

Field Detail

SUB_TYPEback to summary
public static final String SUB_TYPE

This type of action this object represents.

Constructor Detail

PDActionSubmitFormback to summary
public PDActionSubmitForm()

Default Constructor

PDActionSubmitFormback to summary
public PDActionSubmitForm(COSDictionary a)

Constructor

Parameters
a:COSDictionary

the action dictionary

Method Detail

getFieldsback to summary
public COSArray 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:COSArray

the array of fields

getFileback to summary
public PDFileSpecification getFile() throws IOException

This will get the file in which the destination is located.

Returns:PDFileSpecification

The F entry of the specific Submit-From action dictionary.

Exceptions
IOException:
If there is an error creating the file spec.
getFlagsback to summary
public int getFlags()

A set of flags specifying various characteristics of the action

Returns:int

the flags

setFieldsback to summary
public void setFields(COSArray array)
Parameters
array:COSArray

the array of fields

setFileback to summary
public void setFile(PDFileSpecification fs)

This will set the file in which the destination is located.

Parameters
fs:PDFileSpecification

The file specification.

setFlagsback to summary
public void setFlags(int flags)
Parameters
flags:int

the flags