package

com.pspdfkit.forms

Interactive forms API.

Interfaces

FormListeners Collection of form listeners. 
FormListeners.OnButtonFormFieldUpdatedListener Listener for ButtonFormField updates. 
FormListeners.OnChoiceFormFieldUpdatedListener Listener for ChoiceFormField updates. 
FormListeners.OnFormFieldUpdatedListener Listener for form fields updates. 
FormListeners.OnFormTabOrderUpdatedListener Listener for form tab ordering updates. 
FormListeners.OnTextFormFieldUpdatedListener Listener for TextFormField updates. 
FormProvider Handles all form related operations on the owning document. 

Classes

ButtonFormElement Represents button in a PDF form. 
ButtonFormField Represents button form field in a PDF form. 
CheckBoxFormConfiguration Configuration class of CheckBoxFormElement for the creation of a CheckBoxFormField using addFormElementsToPage(String, List) or addFormElementToPage(String, T)
CheckBoxFormConfiguration.Builder Builder used to construct CheckBoxFormConfiguration instance. 
CheckBoxFormElement A single checkbox form control which can be toggled to on or off. 
CheckBoxFormField One or more check boxes that can toggle between two states - on and off. 
ChoiceFormElement Represents a choice form control in a PDF form. 
ChoiceFormField Represents a choice form field in a PDF form. 
ComboBoxFormConfiguration Configuration class of ComboBoxFormElement for the creation of a ComboBoxFormField using addFormElementToPage(String, T)
ComboBoxFormConfiguration.Builder Builder used to construct ComboBoxFormConfiguration instance. 
ComboBoxFormElement A form control which displays drop-down list. 
ComboBoxFormField A form field which displays drop-down list. 
EditableButtonFormElement Represents editable button in a PDF form - i.e. 
EditableButtonFormField Represents editable button field in a PDF form - i.e. 
FormElement A visible form control. 
FormElementConfiguration<T extends FormElement, K extends FormField> Base class for all form element configuration classes. 
FormElementConfiguration.BaseBuilder<V extends FormElementConfiguration, B extends BaseBuilder<V, B>> Base builder to be used for all builders declared in the FormElementConfiguration subclasses. 
FormField A form field. 
FormOption Represents one entry in form options array. 
ListBoxFormConfiguration Configuration class of ListBoxFormElement for the creation of a ListBoxFormField using addFormElementToPage(String, T)
ListBoxFormConfiguration.Builder Builder used to construct ListBoxFormConfiguration instance. 
ListBoxFormElement A form control which displays scrollable list with choices. 
ListBoxFormField A form field which displays scrollable list with choices. 
PushButtonFormConfiguration Configuration class of PushButtonFormElement for the creation of a FormField using addFormElementToPage(String, T)
PushButtonFormConfiguration.Builder Builder used to construct PushButtonFormConfiguration instance. 
PushButtonFormElement A simple push button that responds immediately to user input without retaining any state. 
PushButtonFormField A simple push button that responds immediately to user input without retaining any state. 
RadioButtonFormConfiguration Configuration class of RadioButtonFormElement for the creation of a FormField using addFormElementsToPage(String, List) or addFormElementToPage(String, T)
RadioButtonFormConfiguration.Builder Builder used to construct RadioButtonFormConfiguration instance. 
RadioButtonFormElement A single radio button in a radio group represented by RadioButtonFormField
RadioButtonFormField A group of radio buttons in a PDF form that are mutually exclusive. 
SignatureFormConfiguration Configuration class of SignatureFormElement for the creation of a FormField using addFormElementToPage(String, T)
SignatureFormConfiguration.Builder Builder used to construct SignatureFormConfiguration instance. 
SignatureFormElement Form element representing a signature field. 
SignatureFormField Represents a signature field in a form. 
TextFormConfiguration Configuration class of TextFormElement for the creation of a TextFormField using addFormElementToPage(String, T)
TextFormConfiguration.Builder Builder used to construct TextFormConfiguration instance. 
TextFormElement Represents a text control in a PDF form. 
TextFormField A text form field in a PDF form. 
UnknownFormElement Represents a form element that is currently not recognised and handled by PSPDFKit. 

Enums

FormType All supported form types. 
TextInputFormat Supported types of text input for forms.