kotose-form-core/io.github.robinpcrd.kotose.form/Group

Group

open class Group(tag: String? = null) : Element<ValidationRule.Group>

Inheritors

Constructors

constructor(tag: String? = null)

Properties

customCondition

var customCondition: CustomCondition?

val errors: ImmutableList<ValidationError>

val errorsState: State<ImmutableList<ValidationError>>

val fields: ImmutableList<Field<*>>

var form: Form?

hasErrorAndVisible

val hasErrorAndVisible: Boolean

hasErrorOrWarningAndVisible

val hasErrorOrWarningAndVisible: Boolean

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

val hasErrorsState: State<Boolean>

return true if the element has errors, not warnings

hasWarningsState

val hasWarningsState: State<Boolean>

val indexInForm: Int

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

val isEnabledState: State<Boolean>

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

val isVisibleState: State<Boolean>

val key: String

Element key

onValidationChange

var onValidationChange: () -> Unit

val rules: List<ValidationRule.Group>

val tag: String?

validationOption

var validationOption: ValidationOption

Functions

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

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

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

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

fun addRule(rule: ValidationRule.Group)

open 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.

open fun clear(reload: Boolean = false)

clearValidationErrors

fun clearValidationErrors(triggerSource: ValidationTriggerSource)

evaluateCustomCondition

open fun evaluateCustomCondition()

evaluateEnabled

open override fun evaluateEnabled()

evaluateVisibility

open override fun evaluateVisibility()

onFieldVisibilityChanged

fun onFieldVisibilityChanged(field: Field<*>)

fun removeField(field: Field<*>, reload: Boolean = false)

fun removeFields(fields: Collection<Field<*>>, reload: Boolean = false)

fun removeRule(rule: ValidationRule.Group)

open fun setBaseValue(value: Any?)

A specialized group may accept a value under its own tag.

setValidationErrors

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

updateFieldErrors

fun updateFieldErrors(field: Field<*>, reload: Boolean = true)

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

fun validate(triggerSource: ValidationTriggerSource, skipFieldValidation: Boolean = false, includeHidden: Boolean): ImmutableList<ValidationError>