kotose-form/io.github.robinpcrd.kotose.form.fields/SelectableField

SelectableField

open class SelectableField<ValueType>(tag: String? = null, selectableValue: ValueType, defaultLabelForValue: StrRes? = null) : SelectionOptionField<ValueType> , ComposeField

A field that can be selected

Parameters

tag

Field's tag

selectableValue

Value to set to this field when it is selected

defaultLabelForValue

The text to display, if null the displayed text is selectableValue.toString()

Type Parameters

ValueType

Type associated to this field

Inheritors

MultipleSelectionField

SingleSelectionField

Constructors

SelectableField

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

Properties

var appearance: SelectableFieldAppearance

appearanceState

val appearanceState: State<SelectableFieldAppearance>

customCondition

var customCondition: CustomCondition?

val errors: ImmutableList<ValidationError>

val errorsState: State<ImmutableList<ValidationError>>

var form: Form?

hasErrorAndVisible

val hasErrorAndVisible: Boolean

hasErrorOrWarningAndVisible

val hasErrorOrWarningAndVisible: Boolean

val hasErrors: Boolean

hasErrorsNotSilent

val hasErrorsNotSilent: Boolean

hasErrorsNotSilentState

val hasErrorsNotSilentState: State<Boolean>

hasErrorsOrWarnings

val hasErrorsOrWarnings: Boolean

val hasErrorsState: State<Boolean>

hasWarningsState

val hasWarningsState: State<Boolean>

val indexInGroup: Int

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

val isEnabledState: State<Boolean>

val isErrorField: Boolean

val isSelected: Boolean

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

val isVisibleState: State<Boolean>

val key: String

var labelForValue: StrRes?

labelForValueState

val labelForValueState: State<StrRes?>

onValidationChange

var onValidationChange: () -> Unit

var onValueChange: (ValueType?) -> Unit

var parent: Group?

val parentErrors: List<ValidationError>

parentErrorState

val parentErrorState: State<List<ValidationError>>

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

selectableValue

open override val selectableValue: ValueType

val selectionGroup: SelectionGroup<ValueType>?

open val submittedValue: Any?

var subtitle: StrRes?

val tag: String?

validationOption

var validationOption: ValidationOption

var value: ValueType?

val valueState: State<ValueType?>

open override var view: ComposableFun

Functions

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>)

open override fun onValueChanged()

fun remove(reload: Boolean)

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

fun select()

open override fun setBaseValue(value: Any?)

fun setSelected(selected: Boolean): Boolean

setValidationErrors

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

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