public static class

ComboBoxFormConfiguration.Builder

extends FormElementConfiguration.BaseBuilder<V extends FormElementConfiguration, B extends BaseBuilder<V, B>>
java.lang.Object
   ↳ com.pspdfkit.forms.FormElementConfiguration.BaseBuilder<V extends com.pspdfkit.forms.FormElementConfiguration, B extends com.pspdfkit.forms.FormElementConfiguration.BaseBuilder<V, B>>
     ↳ com.pspdfkit.forms.ComboBoxFormConfiguration.Builder

Class Overview

Builder used to construct ComboBoxFormConfiguration instance.

Summary

Public Constructors
Builder(int pageIndex, RectF boundingBox)
Creates a new ComboBoxFormConfiguration builder.
Public Methods
ComboBoxFormConfiguration build()
Creates a ComboBoxFormConfiguration with the arguments supplied to this builder.
ComboBoxFormConfiguration.Builder setCustomText(String customValue)
Sets custom text string.
ComboBoxFormConfiguration.Builder setEditable(boolean isEditable)
Defines whether or not the ComboBoxFormElement instance should be editable.
ComboBoxFormConfiguration.Builder setFormOptions(List<FormOption> options)
Sets the list of options for the given choices of the form element.
ComboBoxFormConfiguration.Builder setMultiSelectionEnabled(boolean isMultiSelectEnabled)
Defines whether the multiselection should be enabled or not.
ComboBoxFormConfiguration.Builder setSelectedIndex(Integer selectedIndex)
Sets the index with the selected option.
ComboBoxFormConfiguration.Builder setSpellCheckEnabled(boolean isSpellCheckEnabled)
Sets whether text entered in the combo box shall be spell-checked, defaults to true.
Protected Methods
ComboBoxFormConfiguration.Builder getThis()
Returns correct type of this builder.
[Expand]
Inherited Methods
From class com.pspdfkit.forms.FormElementConfiguration.BaseBuilder
From class java.lang.Object

Public Constructors

public Builder (int pageIndex, RectF boundingBox)

Creates a new ComboBoxFormConfiguration builder.

Parameters
pageIndex Page index where the checkbox form element will be attached.
boundingBox Annotation bounding box of the widget annotation representing the appearance of the checkbox form element.

Public Methods

public ComboBoxFormConfiguration build ()

Creates a ComboBoxFormConfiguration with the arguments supplied to this builder.

Returns
  • Newly created configuration.

public ComboBoxFormConfiguration.Builder setCustomText (String customValue)

Sets custom text string. May be null.

Parameters
customValue Custom text string.

public ComboBoxFormConfiguration.Builder setEditable (boolean isEditable)

Defines whether or not the ComboBoxFormElement instance should be editable. When editable, the form element will accept a custom text among its options. The form element is not editable by default.

Parameters
isEditable true if the form element should be editable.

public ComboBoxFormConfiguration.Builder setFormOptions (List<FormOption> options)

Sets the list of options for the given choices of the form element.

Parameters
options List of options for the given choices of the form element.

public ComboBoxFormConfiguration.Builder setMultiSelectionEnabled (boolean isMultiSelectEnabled)

Defines whether the multiselection should be enabled or not. Multi selection is disabled by default.

Parameters
isMultiSelectEnabled true if multiselection should be enabled.

public ComboBoxFormConfiguration.Builder setSelectedIndex (Integer selectedIndex)

Sets the index with the selected option.

Parameters
selectedIndex Index with the selected option.

public ComboBoxFormConfiguration.Builder setSpellCheckEnabled (boolean isSpellCheckEnabled)

Sets whether text entered in the combo box shall be spell-checked, defaults to true. Valid only when the combo box is editable (setEditable(boolean)).

Parameters
isSpellCheckEnabled true when text content should be spell checked.

Protected Methods

protected ComboBoxFormConfiguration.Builder getThis ()

Returns correct type of this builder.