pspdfkit/com.pspdfkit.forms/FormElementConfiguration

FormElementConfiguration

@RestrictTo(value = LIBRARY)
abstract class FormElementConfiguration<T : FormElement?, K : FormField?>

Base class for all form element configuration classes. Every class extending FormElementConfiguration class must use generics and explicitly declaring the FormElement subtype that is configuring, this will enforce type-safe checking.

Inheritors

Types

Link copied to clipboard
abstract class BaseBuilder<V : FormElementConfiguration?, B : FormElementConfiguration.BaseBuilder<V, B>?>
Base builder to be used for all builders declared in the FormElementConfiguration subclasses.

Functions

Link copied to clipboard
@NonNull
open fun getAdditionalActions(): Map<AnnotationTriggerEvent, Action>
Returns map of annotation trigger events and their actions for this form element.
Link copied to clipboard
@Nullable
open fun getNextElement(): FormElement
Gets next FormElement in form tab order, may be null
Link copied to clipboard
@Nullable
open fun getPreviousElement(): FormElement
Gets previous FormElement in form tab order, may be null
Link copied to clipboard
open fun isReadOnly(): Boolean
If set, the user may not change the value of this form field.
Link copied to clipboard
open fun isRequired(): Boolean
If set, the field is required to have a value at the time it is exported by a submit form action.