kotose-form-core/io.github.robinpcrd.kotose.form.fields/SelectionOptionField

SelectionOptionField

open class SelectionOptionField<ValueType>(tag: String? = null, val selectableValue: ValueType, defaultLabelForValue: StrRes? = null) : Field<ValueType> , ISelectableField<ValueType>

One typed option, with its own conditions and validation, in a selection group.

Constructors

constructor(tag: String? = null, selectableValue: ValueType, defaultLabelForValue: StrRes? = null)

Properties

customCondition

var customCondition: CustomCondition?

errors

val errors: ImmutableList<ValidationError>

errorsState

val errorsState: State<ImmutableList<ValidationError>>

form

var form: Form?

hasErrorAndVisible

val hasErrorAndVisible: Boolean

hasErrorOrWarningAndVisible

val hasErrorOrWarningAndVisible: Boolean

hasErrors

val hasErrors: Boolean

return true if the element has errors, not warnings

hasErrorsNotSilent

val hasErrorsNotSilent: Boolean

hasErrorsNotSilentState

val hasErrorsNotSilentState: State<Boolean>

hasErrorsOrWarnings

val hasErrorsOrWarnings: Boolean

hasErrorsState

val hasErrorsState: State<Boolean>

return true if the element has errors, not warnings

hasWarningsState

val hasWarningsState: State<Boolean>

indexInGroup

val indexInGroup: Int

isEnabled

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

isEnabledState

val isEnabledState: State<Boolean>

isErrorField

val isErrorField: Boolean

isSelected

val isSelected: Boolean

isVisible

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

isVisibleState

val isVisibleState: State<Boolean>

key

val key: String

Element key

labelForValue

var labelForValue: StrRes?

labelForValueState

val labelForValueState: State<StrRes?>

onValidationChange

var onValidationChange: () -> Unit

onValueChange

var onValueChange: (ValueType?) -> Unit

parent

var parent: Group?

parentErrors

val parentErrors: List<ValidationError>

parentErrorState

val parentErrorState: State<List<ValidationError>>

rules

val rules: List<ValidationRule.Field<ValueType>>

selectableValue

open override val selectableValue: ValueType

selectionGroup

val selectionGroup: SelectionGroup<ValueType>?

submittedValue

open val submittedValue: Any?

Value contributed by this field to Form.allValues.

subtitle

var subtitle: StrRes?

Secondary text under the label, for example what or who the option stands for.

tag

val tag: String?

validationOption

var validationOption: ValidationOption

value

var value: ValueType?

valueState

val valueState: State<ValueType?>

Functions

addRule

fun addRule(rule: ValidationRule.Field<ValueType>)

clearValidationErrors

fun clearValidationErrors(triggerSource: ValidationTriggerSource)

evaluateCustomCondition

open fun evaluateCustomCondition()

evaluateEnabled

open override fun evaluateEnabled()

evaluateVisibility

open override fun evaluateVisibility()

onParentValidationChanged

open override fun onParentValidationChanged(errors: List<ValidationError>)

onValueChanged

open override fun onValueChanged()

remove

fun remove(reload: Boolean = false)

removeRule

fun removeRule(rule: ValidationRule.Field<ValueType>)

select

fun select()

setBaseValue

open override fun setBaseValue(value: Any?)

Called by the form on Form.setValues.

setSelected

fun setSelected(selected: Boolean): Boolean

User action. Programmatic setters remain available for unavailable options.

setValidationErrors

fun setValidationErrors(errors: List<ValidationError>, triggerSource: ValidationTriggerSource)

validate

open override fun validate(triggerSource: ValidationTriggerSource, includeHidden: Boolean): ImmutableList<ValidationError>