Package com.pspdfkit.annotations.actions
Class SubmitFormAction
-
- All Implemented Interfaces:
public final class SubmitFormAction extends AbstractFormAction
PDF action for sending form data to a URI.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
SubmitFormAction.SubmitFormActionFlag
Flags specifying various characteristics of form submit action.
-
Field Summary
Fields Modifier and Type Field Description public final String
uri
public final EnumSet<SubmitFormAction.SubmitFormActionFlag>
flags
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
Modifier and Type Method Description String
getUri()
The target URI for form submission. EnumSet<SubmitFormAction.SubmitFormActionFlag>
getFlags()
A set of flags specifying various characteristics of this action. boolean
shouldExcludeFormFields()
Indicates whether to include form fields in getFieldNames in the action or exclude them. Observable<List<FormField>>
getFormFieldsAsync(@NonNull() PdfDocument document)
Resolves target form fields that should be submitted. ActionType
getType()
Returns type of action to make down-casting easier. boolean
equals(Object o)
int
hashCode()
String
toString()
-
-
Constructor Detail
-
SubmitFormAction
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.
-
SubmitFormAction
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.
-
-
Method Detail
-
getUri
@NonNull() String getUri()
The target URI for form submission.
- Returns:
Target URI or
null
if no set.
-
getFlags
@NonNull() EnumSet<SubmitFormAction.SubmitFormActionFlag> getFlags()
A set of flags specifying various characteristics of this action.
- Returns:
Set of flags set for this action.
-
shouldExcludeFormFields
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.
-
getFormFieldsAsync
@NonNull() Observable<List<FormField>> getFormFieldsAsync(@NonNull() 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.
-
getType
@NonNull() ActionType getType()
Returns type of action to make down-casting easier.
- Returns:
Type of this action.
-
hashCode
int hashCode()
-
-
-
-