Validator responsible for validating this control. Every control type provides its own implementation (e.g. StringValidator). Empty implementation by default

Functions

acceptsValue

protected open override fun acceptsValue(value: Any): Boolean

Whether this control can hold value, i.e. whether it is a value of type T (and for a choice from fixed options - one of them). Checked for initial values and in updateControl. Controls without a value of their own accept nothing: a section, a button, and a repeatable list, which manages its rows itself. Containers check the shape of their initial data in setInitValue.

childContexts

internal open fun childContexts(controlContext: ControlContext): List<Pair<ControlContext, Control<*>>>

Children of this control in the current form state, each with a context in which this control is the parent: a section has one set, a repeatable - one per row. The engine walks down the tree through them when initializing, validating and collecting data.

convertToResult

protected open fun convertToResult(controlContext: ControlContext, state: ControlState<*>): ControlResultData

Converts the control's internal state (ControlState) into a result to save (ControlResultData). Can be overridden for custom conversions (e.g. in RepeatableControl).

copyInitToValue

internal open fun copyInitToValue(value: T): T

Makes a deep copy of the initial value for the current value. Matters for mutable types (e.g. List), so that changes to value do not affect initValue.

Display

@Composable

protected open override fun Display(controlContext: ControlContext, controlState: ControlState<T>, isRequired: Boolean)

Renders the control's own UI. Every concrete control type (e.g. StringControl) implements it.

DisplayFieldErrors

@Composable

protected fun DisplayFieldErrors(controlContext: ControlContext)

Renders this control's validation errors.

executeActions

protected fun executeActions(controlContext: ControlContext, newValue: T?, scope: CoroutineScope, payload: Any? = null)

Runs the actions defined for this control, usually after a value change.

executeInitActions

internal fun executeInitActions(controlContext: ControlContext, currentValue: T?, scope: CoroutineScope)

getResult

internal fun getResult(controlContext: ControlContext, state: ControlState<*>): ControlResultData

Returns the control's result (current and initial value) for further processing. If the control is invisible, its currentValue is set to null.

initializeControlLifecycle

internal open fun initializeControlLifecycle(formState: FormState, formSchema: FormSchema, errorManager: ErrorManager, formActionTrigger: FormActionTrigger)

Sets the references to the form components. This is the second stage of a control's initialization, called by FormHandler. Gives access to the global state, the schema and the error manager. Also lets particular controls run additional initialization steps they need

mismatch

protected fun mismatch(value: Any): String

Describes value as not fitting this control, for exception messages.

registerChildrenInGlobalMap

internal open fun registerChildrenInGlobalMap(controlContext: ControlContext): Map<String, Control<*>>

Registers the children in the global map Holds references to the controls defined inside a control that has its own

rejectionOf

internal fun rejectionOf(value: Any): String?

Why the control does not accept value, or null when it does.

Render

@Composable

internal fun Render(controlContext: ControlContext, controlState: ControlState<*>)

Renders the control in the user interface. This is the entry point for FormView. Handles visibility.

setInitValue

internal open fun setInitValue(controlContext: ControlContext, value: Any?): ControlState<T>

Sets the control's initial value and creates its state (ControlState).

validateControl

internal fun validateControl(controlContext: ControlContext, state: ControlState<*>)

Runs this control's validation with its validator.