ChoiceFormField

extends FormField

java.lang.Object
↳	com.pspdfkit.forms.FormField
	↳	com.pspdfkit.forms.ChoiceFormField

Known Direct Subclasses

ComboBoxFormField, ListBoxFormField

Class Overview

Represents a choice form field in a PDF form.

Public Methods
void	setOptions(List<FormOption> options) Sets the options for the given choice form element.

Inherited Methods

boolean	equals(Object o)
String	getAlternateFieldName() An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field).
FormElement	getFormElement() Returns first form element.
List<? extends FormElement>	getFormElements() Retrieve list of form elements that represents this field visually.
String	getFullyQualifiedName() Returns the fully qualified name of the form field.
String	getMappingName() (Optional; PDF 1.3) The mapping name that shall be used when exporting interactive form field data from the document.
String	getName() Name of the form field.
FormType	getType() Type of the form field.
int	hashCode()
boolean	isDirty() Checks whether the form field is dirty (any value was modified).
boolean	isExported() If set, the field shall be exported by a submit-form action.
boolean	isReadOnly() If set, the user may not change the value of this field.
boolean	isRequired() If set, the field shall have a value at the time it is exported by a submit-form action.
boolean	reset() Resets form field to its original value.

From class java.lang.Object

Sets the options for the given choice form element. This WILL change the options in the PDF file.

options	List of entries for form options.