Class ComboBoxFormConfiguration
-
- All Implemented Interfaces:
public class ComboBoxFormConfiguration extends FormElementConfiguration<T, K>
Configuration class of com.pspdfkit.forms.ComboBoxFormElement for the creation of a com.pspdfkit.forms.ComboBoxFormField using addFormElementToPage.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
ComboBoxFormConfiguration.Builder
Builder used to construct ComboBoxFormConfiguration instance.
-
Field Summary
Fields Modifier and Type Field Description public final Integer
selectedIndex
public final String
customText
public final List<FormOption>
options
-
Method Summary
Modifier and Type Method Description Integer
getSelectedIndex()
Gets the index with the selected option. String
getCustomText()
Gets the custom text. List<FormOption>
getOptions()
Gets the list of options for the given choices of the form element. boolean
isEditable()
Returns true
when the form element is editable,false
otherwise.boolean
isMultiSelectionEnabled()
Returns true
when multiselection is enabled,false
otherwise.-
-
Method Detail
-
getSelectedIndex
@Nullable() Integer getSelectedIndex()
Gets the index with the selected option. May return
null
when none are selected.- Returns:
Index with the selected option.
-
getCustomText
@Nullable() String getCustomText()
Gets the custom text. May return
null
.- Returns:
Custom text.
-
getOptions
@Nullable() 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.
-
isEditable
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.
-
isMultiSelectionEnabled
boolean isMultiSelectionEnabled()
Returns
true
when multiselection is enabled,false
otherwise.- Returns:
true
when multiselection is enabled.
-
-
-
-