public abstract class

AbstractFormAction

extends Action
java.lang.Object
   ↳ com.pspdfkit.annotations.actions.Action
     ↳ com.pspdfkit.annotations.actions.AbstractFormAction
Known Direct Subclasses

Class Overview

Base class for form related actions.

Summary

Protected Constructors
AbstractFormAction(List<String> fieldNames, List<Action> subActions)
Public Methods
boolean equals(Object o)
List<String> getFieldNames()
Returns list of target form field names.
Observable<List<FormField>> getFormFieldsAsync(PdfDocument document)
Resolves target form fields that are affected by this action.
int hashCode()
boolean shouldExcludeFormFields()
Indicates whether to include form fields in getFieldNames() in the action or exclude them.
String toString()
Protected Methods
static List<String> toFieldNames(List<FormField> formFields)
Converts list of FormField to list of field names.
[Expand]
Inherited Methods
From class com.pspdfkit.annotations.actions.Action
From class java.lang.Object

Protected Constructors

protected AbstractFormAction (List<String> fieldNames, List<Action> subActions)

Public Methods

public boolean equals (Object o)

public 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.

public Observable<List<FormField>> getFormFieldsAsync (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.

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. If true, the list of fields indicates which fields to exclude.

public String toString ()

Protected Methods

protected static List<String> toFieldNames (List<FormField> formFields)

Converts list of FormField to list of field names.