public abstract class

FormElementConfiguration

extends Object
java.lang.Object
   ↳ com.pspdfkit.forms.FormElementConfiguration<T extends com.pspdfkit.forms.FormElement, K extends com.pspdfkit.forms.FormField>
Known Direct Subclasses

Class Overview

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.

Summary

Nested Classes
class FormElementConfiguration.BaseBuilder<V extends FormElementConfiguration, B extends BaseBuilder<V, B>> Base builder to be used for all builders declared in the FormElementConfiguration subclasses. 
Fields
protected final RectF boundingBox
protected final FormElement nextElement
protected final int pageIndex
protected final FormElement previousElement
Public Methods
Map<AnnotationTriggerEvent, Action> getAdditionalActions()
Returns map of annotation trigger events and their actions for this form element.
FormElement getNextElement()
Gets next FormElement in form tab order, may be null
FormElement getPreviousElement()
Gets previous FormElement in form tab order, may be null
boolean isReadOnly()
If set, the user may not change the value of this form field.
boolean isRequired()
If set, the field is required to have a value at the time it is exported by a submit form action.
Protected Methods
RectF getBoundingBox()
Position of this form element on the page.
int getPageIndex()
The page number to which the form element will belong.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected final RectF boundingBox

protected final FormElement nextElement

protected final int pageIndex

protected final FormElement previousElement

Public Methods

public Map<AnnotationTriggerEvent, Action> getAdditionalActions ()

Returns map of annotation trigger events and their actions for this form element.

Returns
  • Additional actions dictionary.

public FormElement getNextElement ()

Gets next FormElement in form tab order, may be null

Returns

public FormElement getPreviousElement ()

Gets previous FormElement in form tab order, may be null

Returns

public boolean isReadOnly ()

If set, the user may not change the value of this form field. This flag is useful for fields whose values are computed or imported from a database.

Returns
  • true when field is read-only.

public boolean isRequired ()

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

Returns
  • true when field is required.

Protected Methods

protected RectF getBoundingBox ()

Position of this form element on the page. The returned RectF is a copy, so changing its values won't update the annotation's bounds.

Returns
  • Rect with page position in PDF coordinates.

protected int getPageIndex ()

The page number to which the form element will belong.

Returns
  • Page number tied to the form element.