kotose-form-core/io.github.robinpcrd.kotose.form.groups/SelectionGroup

SelectionGroup

sealed class SelectionGroup<ValueType> : Group

presentation applies on every platform unless iosPresentation replaces it on iOS. Any presentation other than SelectionPresentation.Inline shows the options as one row labelled by title, so it requires one.

Inheritors

Multiple

Single

Types

Multiple

class Multiple<ValueType>(tag: String? = null, title: StrRes? = null, presentation: SelectionPresentation = SelectionPresentation.Inline, iosPresentation: SelectionPresentation? = null) : SelectionGroup<ValueType>

Shown SelectionPresentation.Inline, in a sheet or on a page: a menu closes after each tap.

Single

class Single<ValueType>(tag: String? = null, title: StrRes? = null, enableDeselection: Boolean = false, presentation: SelectionPresentation = SelectionPresentation.Inline, iosPresentation: SelectionPresentation? = null) : SelectionGroup<ValueType>

Properties

customCondition

var customCondition: CustomCondition?

errors

val errors: ImmutableList<ValidationError>

errorsState

val errorsState: State<ImmutableList<ValidationError>>

fields

val fields: ImmutableList<Field<*>>

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>

indexInForm

val indexInForm: Int

iosPresentation

val iosPresentation: SelectionPresentation?

isEnabled

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

isEnabledState

val isEnabledState: State<Boolean>

isVisible

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

isVisibleState

val isVisibleState: State<Boolean>

key

val key: String

Element key

onValidationChange

var onValidationChange: () -> Unit

presentation

val presentation: SelectionPresentation

rules

val rules: List<ValidationRule.Group>

selectableFields

val selectableFields: ImmutableList<SelectionOptionField<ValueType>>

tag

val tag: String?

title

val title: StrRes?

validationOption

var validationOption: ValidationOption

Functions

addField

fun addField(field: Field<*>, skipGroupValidation: Boolean = true, reload: Boolean = false)

fun addField(idx: Int, field: Field<*>, skipGroupValidation: Boolean = true, reload: Boolean = false)

addFields

fun addFields(fields: Collection<Field<*>>, skipGroupValidation: Boolean = true, reload: Boolean = false)

fun addFields(idx: Int, fields: Collection<Field<*>>, skipGroupValidation: Boolean = true, reload: Boolean = false)

addRule

fun addRule(rule: ValidationRule.Group)

allValues

open override fun allValues(includeHidden: Boolean = false): Map<String, Any?>

Values contributed by this group when submitting the form. Hidden groups and fields contribute nothing unless includeHidden is set, mirroring Form.validate.

clear