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

ToggleField

open class ToggleField(tag: String? = null, defaultLabel: StrRes) : Field<Boolean>

Boolean value and label shared by every renderer.

Constructors

constructor(tag: String? = null, defaultLabel: StrRes)

Properties

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

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 indexInGroup: Int

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

val isEnabledState: State<Boolean>

val isErrorField: Boolean

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

val isVisibleState: State<Boolean>

val key: String

Element key

var label: StrRes

val labelState: State<StrRes>

onValidationChange

var onValidationChange: () -> Unit

var onValueChange: (Boolean?) -> Unit

var parent: Group?

val parentErrors: List<ValidationError>

parentErrorState

val parentErrorState: State<List<ValidationError>>

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

open val submittedValue: Any?

Value contributed by this field to Form.allValues.

val tag: String?

validationOption

var validationOption: ValidationOption

var value: Boolean?

val valueState: State<Boolean?>

Functions

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

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

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

open override fun setBaseValue(value: Any?)

Called by the form on Form.setValues.

setValidationErrors

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

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