| java.lang.Object | |||
| ↳ | com.pspdfkit.annotations.actions.Action | ||
| ↳ | com.pspdfkit.annotations.actions.AbstractFormAction | ||
| ↳ | com.pspdfkit.annotations.actions.SubmitFormAction | ||
Class Overview
PDF action for sending form data to a URI.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | SubmitFormAction.SubmitFormActionFlag | Flags specifying various characteristics of form submit action. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
SubmitFormAction(String uri, List<FormField> formFields, EnumSet<SubmitFormAction.SubmitFormActionFlag> flags)
Creates action instance.
| |||||||||||
|
SubmitFormAction(String uri, List<String> fieldNames, EnumSet<SubmitFormAction.SubmitFormActionFlag> flags, List<Action> subActions)
Creates action instance.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object o) | ||||||||||
| EnumSet<SubmitFormAction.SubmitFormActionFlag> |
getFlags()
A set of flags specifying various characteristics of this action.
| ||||||||||
| Observable<List<FormField>> |
getFormFieldsAsync(PdfDocument document)
Resolves target form fields that should be submitted.
| ||||||||||
| ActionType |
getType()
Returns type of action to make down-casting easier.
| ||||||||||
| String |
getUri()
The target URI for form submission.
| ||||||||||
| int | hashCode() | ||||||||||
| boolean |
shouldExcludeFormFields()
Indicates whether to include form fields in
getFieldNames() in the action or exclude
them. | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pspdfkit.annotations.actions.AbstractFormAction
| |||||||||||
|
From class
com.pspdfkit.annotations.actions.Action
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public SubmitFormAction (String uri, List<FormField> formFields, EnumSet<SubmitFormAction.SubmitFormActionFlag> flags)
Creates action instance.
Parameters
| uri | Uri of the target to which to submit form data. |
|---|---|
| formFields | List of target form fields. |
| flags | A set of flags specifying various characteristics of this action. |
public SubmitFormAction (String uri, List<String> fieldNames, EnumSet<SubmitFormAction.SubmitFormActionFlag> flags, List<Action> subActions)
Creates action instance.
Parameters
| uri | Uri of the target to which to submit form data. |
|---|---|
| fieldNames | List of target form field names. |
| flags | A set of flags specifying various characteristics of this action. |
| subActions | List of sub-actions of this action. |
Public Methods
public EnumSet<SubmitFormAction.SubmitFormActionFlag> getFlags ()
A set of flags specifying various characteristics of this action.
Returns
- Set of flags set for this action.
public Observable<List<FormField>> getFormFieldsAsync (PdfDocument document)
Resolves target form fields that should be submitted.
Parameters
| document | Owning document. |
|---|
Returns
- Observable emitting a list of target form fields. If the resulting list is empty, all form fields should be submitted.
public ActionType getType ()
Returns type of action to make down-casting easier.
Returns
- Type of this action.
public int hashCode ()
public boolean shouldExcludeFormFields ()
Indicates whether to include form fields in getFieldNames() in the action or exclude
them.
Returns
- If
false, the list of fields specifies which fields to include. Iftrue, the list of fields indicates which fields to exclude.