Package com.pspdfkit.forms
Class FormElementConfiguration.BaseBuilder
-
- All Implemented Interfaces:
public abstract class FormElementConfiguration.BaseBuilder<V extends FormElementConfiguration, B extends FormElementConfiguration.BaseBuilder<V, B>>
Base builder to be used for all builders declared in the FormElementConfiguration subclasses.
-
-
Method Summary
Modifier and Type Method Description B
setAdditionalAction(@NonNull() AnnotationTriggerEvent triggerEvent, @Nullable() Action action)
Sets the action that should be executed for given annotation trigger event. B
setReadOnly(boolean isReadOnly)
Sets whether the form element is read-only. B
setRequired(boolean isRequired)
Sets whether the form element is required. abstract V
build()
Creates a FormElementConfiguration with the arguments supplied to this builder. B
setPreviousElement(@Nullable() FormElement previousElement)
Sets previous form element in form tab order. B
setNextElement(@Nullable() FormElement nextElement)
Sets next form element in form tab order. -
-
Method Detail
-
setAdditionalAction
B setAdditionalAction(@NonNull() AnnotationTriggerEvent triggerEvent, @Nullable() 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 whentriggerEvent
occurs,null
to remove existing action.
-
setReadOnly
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.
-
setRequired
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.
-
build
@NonNull() abstract V build()
Creates a FormElementConfiguration with the arguments supplied to this builder.
- Returns:
Newly created configuration.
-
setPreviousElement
B setPreviousElement(@Nullable() FormElement previousElement)
Sets previous form element in form tab order.
- Parameters:
previousElement
- Previous form element in form tab order.
-
setNextElement
B setNextElement(@Nullable() FormElement nextElement)
Sets next form element in form tab order.
- Parameters:
nextElement
- Next form element in form tab order.
-
-
-
-