Class FormElementConfiguration
-
- All Implemented Interfaces:
@RestrictTo(value = LIBRARY) public abstract class FormElementConfiguration<T extends FormElement, K extends FormField>
Base class for all form element configuration classes. Every class extending FormElementConfiguration class must use generics and explicitly declaring the FormElement subtype that is configuring, this will enforce type-safe checking.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract class
FormElementConfiguration.BaseBuilder
Base builder to be used for all builders declared in the FormElementConfiguration subclasses.
-
Method Summary
Modifier and Type Method Description FormElement
getPreviousElement()
Gets previous FormElement in form tab order, may be null
FormElement
getNextElement()
Gets next FormElement in form tab order, may be null
Map<AnnotationTriggerEvent, Action>
getAdditionalActions()
Returns map of annotation trigger events and their actions for this form element. boolean
isReadOnly()
If set, the user may not change the value of this form field. boolean
isRequired()
If set, the field is required to have a value at the time it is exported by a submit form action. -
-
Method Detail
-
getPreviousElement
@Nullable() FormElement getPreviousElement()
Gets previous FormElement in form tab order, may be
null
- Returns:
Previous FormElement in form tab order, if any.
-
getNextElement
@Nullable() FormElement getNextElement()
Gets next FormElement in form tab order, may be
null
- Returns:
Next FormElement in form tab order, if any.
-
getAdditionalActions
@NonNull() Map<AnnotationTriggerEvent, Action> getAdditionalActions()
Returns map of annotation trigger events and their actions for this form element.
- Returns:
Additional actions dictionary.
-
isReadOnly
boolean isReadOnly()
If set, the user may not change the value of this form field. This flag is useful for fields whose values are computed or imported from a database.
- Returns:
true
when field is read-only.
-
isRequired
boolean isRequired()
If set, the field is required to have a value at the time it is exported by a submit form action.
- Returns:
true
when field is required.
-
-
-
-