pspdfkit/com.pspdfkit.forms

Package-level declarations

Interactive forms API.

Types

Link copied to clipboard
abstract class ButtonFormElement : FormElement
Represents button in a PDF form.
Link copied to clipboard
abstract class ButtonFormField : FormField
Represents button form field in a PDF form.
Link copied to clipboard
Link copied to clipboard
open class CheckBoxFormElement : EditableButtonFormElement
A single checkbox form control which can be toggled to on or off.
Link copied to clipboard
open class CheckBoxFormField : EditableButtonFormField
One or more check boxes that can toggle between two states - on and off.
Link copied to clipboard
abstract class ChoiceFormElement : FormElement
Represents a choice form control in a PDF form.
Link copied to clipboard
abstract class ChoiceFormField : FormField
Represents a choice form field in a PDF form.
Link copied to clipboard
Link copied to clipboard
open class ComboBoxFormElement : ChoiceFormElement
A form control which displays drop-down list.
Link copied to clipboard
open class ComboBoxFormField : ChoiceFormField
A form field which displays drop-down list.
Link copied to clipboard
abstract class EditableButtonFormElement : ButtonFormElement
Represents editable button in a PDF form - i.e.
Link copied to clipboard
abstract class EditableButtonFormField : ButtonFormField
Represents editable button field in a PDF form - i.e.
Link copied to clipboard
abstract class FormElement
A visible form control.
Link copied to clipboard
@RestrictTo(value = LIBRARY)
abstract class FormElementConfiguration<T : FormElement?, K : FormField?>
Base class for all form element configuration classes.
Link copied to clipboard
open class FormField
A form field.
Link copied to clipboard
interface FormListeners
Collection of form listeners.
Link copied to clipboard
open class FormOption
Represents one entry in form options array.
Link copied to clipboard
interface FormProvider
Handles all form related operations on the owning document.
Link copied to clipboard
open class FormProviderFactory
Factory intended for internal usage only.
Link copied to clipboard
enum FormType
All supported form types.
Link copied to clipboard
open class ListBoxFormConfiguration : FormElementConfiguration<T, K>
Configuration class of ListBoxFormElement for the creation of a ListBoxFormField using addFormElementToPage.
Link copied to clipboard
open class ListBoxFormElement : ChoiceFormElement
A form control which displays scrollable list with choices.
Link copied to clipboard
open class ListBoxFormField : ChoiceFormField
A form field which displays scrollable list with choices.
Link copied to clipboard
open class PushButtonFormConfiguration : FormElementConfiguration<T, K>
Configuration class of PushButtonFormElement for the creation of a FormField using addFormElementToPage.
Link copied to clipboard
open class PushButtonFormElement : ButtonFormElement
A simple push button that responds immediately to user input without retaining any state.
Link copied to clipboard
open class PushButtonFormField : ButtonFormField
A simple push button that responds immediately to user input without retaining any state.
Link copied to clipboard
Link copied to clipboard
open class RadioButtonFormElement : EditableButtonFormElement
A single radio button in a radio group represented by RadioButtonFormField.
Link copied to clipboard
open class RadioButtonFormField : EditableButtonFormField
A group of radio buttons in a PDF form that are mutually exclusive.
Link copied to clipboard
open class SignatureFormConfiguration : FormElementConfiguration<T, K>
Configuration class of SignatureFormElement for the creation of a FormField using addFormElementToPage.
Link copied to clipboard
open class SignatureFormElement : FormElement
Form element representing a signature field.
Link copied to clipboard
open class SignatureFormField : FormField
Represents a signature field in a form.
Link copied to clipboard
open class TextFormConfiguration : FormElementConfiguration<T, K>
Configuration class of com.pspdfkit.forms.TextFormElement for the creation of a using addFormElementToPage.
Link copied to clipboard
open class TextFormElement : FormElement
Represents a text control in a PDF form.
Link copied to clipboard
open class TextFormField : FormField
A text form field in a PDF form.
Link copied to clipboard
enum TextInputFormat
Supported types of text input for forms.
Link copied to clipboard
open class UnknownFormElement : FormElement
Represents a form element that is currently not recognised and handled by PSPDFKit.