nutrient/com.pspdfkit.forms/FormField

FormField

open class FormField

A form field. Each form field can have multiple child FormElements. For example, radio button group is a RadioButtonFormField, while each radio button in a group is a RadioButtonFormElement.

Forms can be grouped in a tree hierarchy. The otherwise empty hierarchy elements are not returned as a form field. All that happens is that the fully qualified name contains the full hierarchy name, separated by a dot.

Inheritors

ButtonFormField

SignatureFormField

ChoiceFormField

Properties

alternateFieldName

val alternateFieldName: String

The alternate field name used for accessibility and error messages.

open val formElements: List<out FormElement>

The list of form elements that visually represent this field.

val mappingName: String

The mapping name used when exporting form field data from the document.

val name: String

The partial name of this form field.

val type: FormType

The type of this form field (text, checkbox, radio button, etc.).

Functions

open fun equals(o: Any): Boolean

Compares this form field to the specified object.

getAdditionalAction

open fun getAdditionalAction(@NonNull triggerEvent: AnnotationTriggerEvent): Action

Returns the action that should be executed on annotation trigger event.

open fun getFormElement(): FormElement

Returns first form element.

getFullyQualifiedName

open fun getFullyQualifiedName(): String

Returns the fully qualified name of the form field.

open fun hashCode(): Int

Returns a hash code value for this form field based on its fully qualified name and provider index.

open fun isDirty(): Boolean

Checks whether the form field is dirty (any value was modified).

open fun isExported(): Boolean

If set, the field shall be exported by a submit-form action.

open fun isReadOnly(): Boolean

If set, the user may not change the value of this field.

open fun isRequired(): Boolean

If set, the field shall have a value at the time it is exported by a submit-form action.

open fun reset(): Boolean

Resets form field to its original value.