pspdfkit/com.pspdfkit.forms/FormElement

FormElement

A visible form control. Every form element has a single parent FormField. Each form element is associated with a single WidgetAnnotation that is a visual representation of the form element in the document.

Inheritors

Properties

formField

@NonNull

@get:NonNull

val formField: FormField

nextElement

@Nullable

@get:Nullable

open var nextElement: FormElement

previousElement

@Nullable

@get:Nullable

open var previousElement: FormElement

Functions

equals

open fun equals(o: Any): Boolean

getAnnotation

@NonNull

open fun getAnnotation(): WidgetAnnotation

Retrieve widget annotation for this form element.

getFullyQualifiedName

@NonNull

open fun getFullyQualifiedName(): String

Returns the fully qualified name for the form element.

getName

@NonNull

open fun getName(): String

Returns the name for the form element.

getType

@NonNull

abstract fun getType(): FormType

Returns type of the form field.

hashCode

open fun hashCode(): Int

isReadOnly

open fun isReadOnly(): Boolean

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

isRequired

open fun isRequired(): Boolean

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