public class

ComboBoxFormConfiguration

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

Class Overview

Configuration class of ComboBoxFormElement for the creation of a ComboBoxFormField using addFormElementToPage(String, T).

Summary

Nested Classes
class ComboBoxFormConfiguration.Builder Builder used to construct ComboBoxFormConfiguration instance. 
[Expand]
Inherited Fields
From class com.pspdfkit.forms.FormElementConfiguration
Public Methods
String getCustomText()
Gets the custom text.
List<FormOption> getOptions()
Gets the list of options for the given choices of the form element.
Integer getSelectedIndex()
Gets the index with the selected option.
boolean isEditable()
Returns true when the form element is editable, false otherwise.
boolean isMultiSelectionEnabled()
Returns true when multiselection is enabled, false otherwise.
[Expand]
Inherited Methods
From class com.pspdfkit.forms.FormElementConfiguration
From class java.lang.Object

Public Methods

public String getCustomText ()

Gets the custom text. May return null.

Returns
  • Custom text.

public List<FormOption> getOptions ()

Gets the list of options for the given choices of the form element. May return null.

Returns
  • List of options for the given choices of the form element.

public Integer getSelectedIndex ()

Gets the index with the selected option. May return null when none are selected.

Returns
  • Index with the selected option.

public boolean isEditable ()

Returns true when the form element is editable, false otherwise. When editable, the form element will accept a custom text among its options.

Returns
  • true when the form element is editable.

public boolean isMultiSelectionEnabled ()

Returns true when multiselection is enabled, false otherwise.

Returns
  • true when multiselection is enabled.