public
static
class
ListBoxFormConfiguration.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.ListBoxFormConfiguration.Builder | |
Class Overview
Builder used to construct ListBoxFormConfiguration instance.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Builder(int pageIndex, RectF boundingBox)
Creates a new
ListBoxFormConfiguration builder. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ListBoxFormConfiguration |
build()
Creates a
ListBoxFormConfiguration with the arguments supplied to this builder. | ||||||||||
| ListBoxFormConfiguration.Builder |
setFormOptions(List<FormOption> options)
Sets the list of options for the given choices of the form element.
| ||||||||||
| ListBoxFormConfiguration.Builder |
setMultiSelectionEnabled(boolean enable)
Defines whether the multi selection should be enabled or not.
| ||||||||||
| ListBoxFormConfiguration.Builder |
setSelectedIndexes(List<Integer> selectedIndexes)
Sets the list of indexes with a selected option.
| ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ListBoxFormConfiguration.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 ListBoxFormConfiguration 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 ListBoxFormConfiguration build ()
Creates a ListBoxFormConfiguration with the arguments supplied to this builder.
Returns
- Newly created configuration.
public ListBoxFormConfiguration.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 ListBoxFormConfiguration.Builder setMultiSelectionEnabled (boolean enable)
Defines whether the multi selection should be enabled or not. Multi selection is disabled by default.
Parameters
| enable | true if multi selection should be enabled.
|
|---|
public ListBoxFormConfiguration.Builder setSelectedIndexes (List<Integer> selectedIndexes)
Sets the list of indexes with a selected option.
Parameters
| selectedIndexes | List of indexes with a selected option. |
|---|