AbstractFormAction

All Implemented Interfaces:


public abstract class AbstractFormAction
extends Action

Base class for form related actions.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final List<String>`	`fieldNames`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`List<String>`	`getFieldNames()`	Returns list of target form field names.
`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 are affected by this action.
`Single<List<FormField>>`	`getTargetFormFieldsAsync(@NonNull() PdfDocument document)`	Returns form fields targeted by this action.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getFieldNames
```
@NonNull() List<String> getFieldNames()
```
    Returns list of target form field names.
    
    Returns:
    
    List of the target form field names or an empty list if no form fields are targeted by 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. If true, the list of fields indicates which fields to exclude.
  - getFormFieldsAsync
```
@NonNull() Observable<List<FormField>> getFormFieldsAsync(@NonNull() PdfDocument document)
```
    Resolves target form fields that are affected by this action.
    
    Parameters:
    
    document - Owning document.
    
    Returns:
    
    Observable emitting a list of target form fields.
  - getTargetFormFieldsAsync
```
@NonNull() Single<List<FormField>> getTargetFormFieldsAsync(@NonNull() PdfDocument document)
```
    Returns form fields targeted by this action.
    
    Parameters:
    
    document - Owning document.
    
    Returns:
    
    Single returning a list of form fields.
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```