nutrient/com.pspdfkit.forms/FormProviderImpl

FormProviderImpl

class FormProviderImpl : InternalFormProvider

Internal implementation of the form provider that manages PDF form fields and elements. This class handles form field creation, retrieval, modification, and removal operations for AcroForms in PDF documents.

Properties

formCache

open override val formCache: FormCache

Returns lazily initialized form fields/elements cache. This can block for a while when initializing cache.

formElements

open override val formElements: List<FormElement>

formElementsAsync

open override val formElementsAsync: Single<List<FormElement>>

formFields

open override val formFields: List<FormField>

formFieldsAsync

open override val formFieldsAsync: Single<List<FormField>>

formObserver

val formObserver: FormObserver

Observer translating native form callbacks to Java listeners.

tabOrder

open override val tabOrder: List<FormElement>

tabOrderAsync

open override val tabOrderAsync: Single<List<FormElement>>

Functions

addFormElementsToPage

open override fun <T : FormElementConfiguration<*, *>> addFormElementsToPage(fullyQualifiedName: String, formElementConfigurations: List<T>): FormField

Allows to programmatically create and insert a form field into the document. The newly created form field will be automatically attached to the document once created.

addFormElementsToPageAsync

open override fun <T : FormElementConfiguration<*, *>> addFormElementsToPageAsync(fullyQualifiedName: String, formElementConfigurations: List<T>): Single<FormField>

Allows to programmatically create and insert a form field into the document, asynchronously. The newly created form field will be automatically attached to the document once created.

addFormElementToPage

open override fun <T : FormElementConfiguration<*, *>> addFormElementToPage(fullyQualifiedName: String, formElementConfiguration: T): FormField

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

addFormElementToPageAsync

open override fun <T : FormElementConfiguration<*, *>> addFormElementToPageAsync(fullyQualifiedName: String, formElementConfiguration: T): Single<FormField>

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

addOnButtonFormFieldUpdatedListener

open override fun addOnButtonFormFieldUpdatedListener(listener: FormListeners.OnButtonFormFieldUpdatedListener)

Adds OnButtonFormFieldUpdatedListener to get notified when button fields get updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

addOnChoiceFormFieldUpdatedListener

open override fun addOnChoiceFormFieldUpdatedListener(listener: FormListeners.OnChoiceFormFieldUpdatedListener)

Adds OnChoiceFormFieldUpdatedListener to get notified when choice fields get updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

addOnFormFieldUpdatedListener

open override fun addOnFormFieldUpdatedListener(listener: FormListeners.OnFormFieldUpdatedListener)

Adds OnFormFieldUpdatedListener to get notified when any form field gets updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

addOnFormTabOrderUpdatedListener

open override fun addOnFormTabOrderUpdatedListener(listener: FormListeners.OnFormTabOrderUpdatedListener)

Adds OnFormTabOrderUpdatedListener to get notified when form tab order has been recalculated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

addOnTextFormFieldUpdatedListener

open override fun addOnTextFormFieldUpdatedListener(listener: FormListeners.OnTextFormFieldUpdatedListener)

Adds OnTextFormFieldUpdatedListener to get notified when text fields get updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

attachFormElement

open override fun attachFormElement(formField: FormField, formElements: List<FormElement>)

Attaches the form field to its child form elements. This method needs to be implemented by the InternalFormProvider because it's package private on the FormField.

createFormElement

open override fun createFormElement(formField: FormField, annotation: WidgetAnnotation): FormElement

Factory for creating FormElement instances. This is implement by this interface to not expose the form element constructors themselves.

createFormField

open override fun createFormField(providerIndex: Int, nativeFormField: ERROR CLASS: Symbol not found for NativeFormField): FormField

Factory for creating FormField instances. This is implement by this interface to not expose the form field constructors themselves.

getFormElementForAnnotation

open override fun getFormElementForAnnotation(annotation: WidgetAnnotation): FormElement?

Finds a form element for widget annotation.

getFormElementForAnnotationAsync

open override fun getFormElementForAnnotationAsync(annotation: WidgetAnnotation): Maybe<FormElement>

Finds a form element for widget annotation, asynchronously.

getFormElements

open override fun getFormElements(): List<FormElement>

Returns a list of all form elements in the document.

getFormElementsAsync

open override fun getFormElementsAsync(): Single<List<FormElement>>

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

getFormElementWithName

open override fun getFormElementWithName(fieldName: String): FormElement?

Searches for a form element by name. Returns the first element with given name.

getFormElementWithNameAsync

open override fun getFormElementWithNameAsync(fieldName: String): Maybe<FormElement>

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

getFormFields

open override fun getFormFields(): List<FormField>

Returns a list of all form fields in the document.

getFormFieldsAsync

open override fun getFormFieldsAsync(): Single<List<FormField>>

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

getFormFieldWithFullyQualifiedName

open override fun getFormFieldWithFullyQualifiedName(fullyQualifiedName: String): FormField?

Searches for a form field with fully qualified field name. Returns the first field with given fullyQualifiedName.

getFormFieldWithFullyQualifiedNameAsync

open override fun getFormFieldWithFullyQualifiedNameAsync(fullyQualifiedName: String): Maybe<FormField>

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

getTabOrder

open override fun getTabOrder(): List<FormElement>

Returns order of FormElement for document. We calculate the tab order with two different methods:

getTabOrderAsync

open override fun getTabOrderAsync(): Single<List<FormElement>>

Returns order of FormElement for document, asynchronously.

hasFieldsCache

open override fun hasFieldsCache(): Boolean

Returns true when fields cache has already been initialized.

hasUnsavedChanges

open override fun hasUnsavedChanges(): Boolean

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

markFormAsSavedToDisk

open override fun markFormAsSavedToDisk()

Clears dirty state of this forms provider. It's used to clear the modified state after the document has been saved.

onFormFieldAdded

@Synchronized

open override fun onFormFieldAdded(@IntRange(from = 0) providerIndex: Int, nativeFormField: ERROR CLASS: Symbol not found for NativeFormField): FormField?

Call this method to add new field to cache. Use case for this is that, form field has been encountered in document that is not in global AcroForms array and core notifies us about this field.

prepareFieldsCache

open suspend override fun prepareFieldsCache()

Called when the form fields cache should be prepared for the first time. This can take a while and should not be executed on the main thread.

removeFormElementFromPage

open override fun removeFormElementFromPage(formElement: FormElement): Boolean

Allows to programmatically remove a form element from the document.

removeFormElementFromPageAsync

open override fun removeFormElementFromPageAsync(formElement: FormElement): Single<Boolean>

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

removeOnButtonFormFieldUpdatedListener

open override fun removeOnButtonFormFieldUpdatedListener(listener: FormListeners.OnButtonFormFieldUpdatedListener)

Removes previously registered OnButtonFormFieldUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Passing null is not allowed, and will result in an exception.

removeOnChoiceFormFieldUpdatedListener

open override fun removeOnChoiceFormFieldUpdatedListener(listener: FormListeners.OnChoiceFormFieldUpdatedListener)

Removes previously registered OnChoiceFormFieldUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Passing null is not allowed, and will result in an exception.

removeOnFormFieldUpdatedListener

open override fun removeOnFormFieldUpdatedListener(listener: FormListeners.OnFormFieldUpdatedListener)

Removes previously registered OnFormFieldUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Passing null is not allowed, and will result in an exception.

removeOnFormTabOrderUpdatedListener

open override fun removeOnFormTabOrderUpdatedListener(listener: FormListeners.OnFormTabOrderUpdatedListener)

Removes previously registered OnFormTabOrderUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Passingnull is not allowed, and will result in an exception.

removeOnTextFormFieldUpdatedListener

open override fun removeOnTextFormFieldUpdatedListener(listener: FormListeners.OnTextFormFieldUpdatedListener)

Removes previously registered OnTextFormFieldUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Passing null is not allowed, and will result in an exception.

resetFormFields

open override fun resetFormFields(formFields: List<FormField>, shouldExcludeFormFields: Boolean)

Resets a form, represented by a list of form fields, to default values.

setDirty

open override fun setDirty(isDirty: Boolean)

Sets dirty state for this provider.