| java.lang.Object | |
| ↳ | com.pspdfkit.forms.FormElementConfiguration.BaseBuilder<V extends com.pspdfkit.forms.FormElementConfiguration, B extends com.pspdfkit.forms.FormElementConfiguration.BaseBuilder<V, B>> |
 Known Direct Subclasses
|
Class Overview
Base builder to be used for all builders declared in the FormElementConfiguration subclasses.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
BaseBuilder(int pageIndex, RectF boundingBox)
Creates a new
FormElementConfiguration builder. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract V |
build()
Creates a
FormElementConfiguration with the arguments supplied to this builder. | ||||||||||
| B |
setAdditionalAction(AnnotationTriggerEvent triggerEvent, Action action)
Sets the action that should be executed for given annotation trigger event.
| ||||||||||
| B |
setNextElement(FormElement nextElement)
Sets next form element in form tab order.
| ||||||||||
| B |
setPreviousElement(FormElement previousElement)
Sets previous form element in form tab order.
| ||||||||||
| B |
setReadOnly(boolean isReadOnly)
Sets whether the form element is read-only.
| ||||||||||
| B |
setRequired(boolean isRequired)
Sets whether the form element is required.
| ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract B |
getThis()
Returns correct type of this builder.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public BaseBuilder (int pageIndex, RectF boundingBox)
Creates a new FormElementConfiguration 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 abstract V build ()
Creates a FormElementConfiguration with the arguments supplied to this builder.
Returns
- Newly created configuration.
public B setAdditionalAction (AnnotationTriggerEvent triggerEvent, Action action)
Sets the action that should be executed for given annotation trigger event.
Parameters
| triggerEvent | Event for which to set the action. |
|---|---|
| action | Action to be executed when triggerEvent occurs, null to remove existing action.
|
public B setNextElement (FormElement nextElement)
Sets next form element in form tab order.
Parameters
| nextElement | Next form element in form tab order. |
|---|
public B setPreviousElement (FormElement previousElement)
Sets previous form element in form tab order.
Parameters
| previousElement | Previous form element in form tab order. |
|---|
public B setReadOnly (boolean isReadOnly)
Sets whether the form element is read-only. If set, the user may not change the value of the created form element.
Parameters
| isReadOnly | true when the form element should be read-only.
|
|---|
public B setRequired (boolean isRequired)
Sets whether the form element is required. If set, the field is required to have a value at the time it is exported by a submit form action.
Parameters
| isRequired | true when the form element should be required.
|
|---|
Protected Methods
protected abstract B getThis ()
Returns correct type of this builder.