pspdfkit/com.pspdfkit.forms/FormProvider

FormProvider

Handles all form related operations on the owning document. Retrieve it with getFormProvider.

Functions

abstract fun <T : FormElementConfiguration?> addFormElementsToPage(@NonNull fullyQualifiedName: String, @NonNull formElementConfigurations: List<T>): FormField

Allows to programmatically create and insert a form field into the document.

addFormElementsToPageAsync

@NonNull

abstract fun <T : FormElementConfiguration?> addFormElementsToPageAsync(@NonNull fullyQualifiedName: String, @NonNull formElementConfigurations: List<T>): Single<FormField>

Allows to programmatically create and insert a form field into the document, asynchronously.

addFormElementToPage

@NonNull

abstract fun <T : FormElementConfiguration?> addFormElementToPage(@NonNull fullyQualifiedName: String, @NonNull formElementConfiguration: T): FormField

Allows to programmatically create and insert a form field into the document.

addFormElementToPageAsync

@NonNull

abstract fun <T : FormElementConfiguration?> addFormElementToPageAsync(@NonNull fullyQualifiedName: String, @NonNull formElementConfiguration: T): Single<FormField>

Allows to programmatically create and insert a form field into the document, asynchronously.

addOnButtonFormFieldUpdatedListener

abstract fun addOnButtonFormFieldUpdatedListener(@NonNull listener: FormListeners.OnButtonFormFieldUpdatedListener)

Adds OnButtonFormFieldUpdatedListener to get notified when button fields get updated.

addOnChoiceFormFieldUpdatedListener

abstract fun addOnChoiceFormFieldUpdatedListener(@NonNull listener: FormListeners.OnChoiceFormFieldUpdatedListener)

Adds OnChoiceFormFieldUpdatedListener to get notified when choice fields get updated.

addOnFormFieldUpdatedListener

abstract fun addOnFormFieldUpdatedListener(@NonNull listener: FormListeners.OnFormFieldUpdatedListener)

Adds OnFormFieldUpdatedListener to get notified when any form field gets updated.

addOnFormTabOrderUpdatedListener

abstract fun addOnFormTabOrderUpdatedListener(@NonNull listener: FormListeners.OnFormTabOrderUpdatedListener)

Adds OnFormTabOrderUpdatedListener to get notified when form tab order has been recalculated.

addOnTextFormFieldUpdatedListener

abstract fun addOnTextFormFieldUpdatedListener(@NonNull listener: FormListeners.OnTextFormFieldUpdatedListener)

Adds OnTextFormFieldUpdatedListener to get notified when text fields get updated.

getFormElementForAnnotation

@Nullable

abstract fun getFormElementForAnnotation(@NonNull annotation: WidgetAnnotation): FormElement

Finds a form element for widget annotation.

getFormElementForAnnotationAsync

@NonNull

abstract fun getFormElementForAnnotationAsync(@NonNull annotation: WidgetAnnotation): Maybe<FormElement>

Finds a form element for widget annotation, asynchronously.

getFormElements

@NonNull

abstract fun getFormElements(): List<FormElement>

Returns a list of all form elements in the document.

getFormElementsAsync

@NonNull

abstract fun getFormElementsAsync(): Single<List<FormElement>>

Returns a list of all form elements in the document, asynchronously.

getFormElementWithName

@Nullable

abstract fun getFormElementWithName(@NonNull fieldName: String): FormElement

Searches for a form element by name.

getFormElementWithNameAsync

@NonNull

abstract fun getFormElementWithNameAsync(@NonNull fieldName: String): Maybe<FormElement>

Searches for a form element with a given name, asynchronously.

getFormFields

@NonNull

abstract fun getFormFields(): List<FormField>

Returns a list of all form fields in the document.

getFormFieldsAsync

@NonNull

abstract fun getFormFieldsAsync(): Single<List<FormField>>

Returns the list of all form fields in the document, asynchronously.

getFormFieldWithFullyQualifiedName

@Nullable

abstract fun getFormFieldWithFullyQualifiedName(@NonNull fullyQualifiedName: String): FormField

Searches for a form field with fully qualified field name.

getFormFieldWithFullyQualifiedNameAsync

@NonNull

abstract fun getFormFieldWithFullyQualifiedNameAsync(@NonNull fullyQualifiedName: String): Maybe<FormField>

Searches for a form field with fully qualified field name, asynchronously.

getTabOrder

@NonNull

abstract fun getTabOrder(): List<FormElement>

Returns order of FormElement for document.

getTabOrderAsync

@NonNull

abstract fun getTabOrderAsync(): Single<List<FormElement>>

Returns order of FormElement for document, asynchronously.

hasUnsavedChanges

abstract fun hasUnsavedChanges(): Boolean

Returns whether form fields in this document were modified or not.

removeFormElementFromPage

abstract fun removeFormElementFromPage(@NonNull formElement: FormElement): Boolean

Allows to programmatically remove a form element from the document.

removeFormElementFromPageAsync

@NonNull

abstract fun removeFormElementFromPageAsync(@NonNull formElement: FormElement): Single<Boolean>

Allows to programmatically remove a form element from the document, asynchronously.

removeOnButtonFormFieldUpdatedListener

abstract fun removeOnButtonFormFieldUpdatedListener(@NonNull listener: FormListeners.OnButtonFormFieldUpdatedListener)

Removes previously registered OnButtonFormFieldUpdatedListener.

removeOnChoiceFormFieldUpdatedListener

abstract fun removeOnChoiceFormFieldUpdatedListener(@NonNull listener: FormListeners.OnChoiceFormFieldUpdatedListener)

Removes previously registered OnChoiceFormFieldUpdatedListener.

removeOnFormFieldUpdatedListener

abstract fun removeOnFormFieldUpdatedListener(@NonNull listener: FormListeners.OnFormFieldUpdatedListener)

Removes previously registered OnFormFieldUpdatedListener.

removeOnFormTabOrderUpdatedListener

abstract fun removeOnFormTabOrderUpdatedListener(@NonNull listener: FormListeners.OnFormTabOrderUpdatedListener)

Removes previously registered OnFormTabOrderUpdatedListener.

removeOnTextFormFieldUpdatedListener

abstract fun removeOnTextFormFieldUpdatedListener(@NonNull listener: FormListeners.OnTextFormFieldUpdatedListener)

Removes previously registered OnTextFormFieldUpdatedListener.