form-engine/io.github.octaviusframework.form.control.base/ActionContext

ActionContext

data class ActionContext<T>(val sourceValue: T?, val sourceControlContext: ControlContext, val formState: FormState, val formSchema: FormSchema, val errorManager: ErrorManager, val trigger: FormActionTrigger, val coroutineScope: CoroutineScope, val payload: Any? = null)

Context given to a ControlAction, with access to the form state and tools.

Type Parameters

type of the value of the control that triggered the action.

Constructors

ActionContext

constructor(sourceValue: T?, sourceControlContext: ControlContext, formState: FormState, formSchema: FormSchema, errorManager: ErrorManager, trigger: FormActionTrigger, coroutineScope: CoroutineScope, payload: Any? = null)

Properties

coroutineScope

val coroutineScope: CoroutineScope

Scope for launching asynchronous operations (e.g. API calls).

errorManager

val errorManager: ErrorManager

Access to the error manager.

formSchema

val formSchema: FormSchema

Access to the form schema.

formState

val formState: FormState

Access to the global form state.

payload

val payload: Any?

sourceControlContext

val sourceControlContext: ControlContext

Context of the control that triggered the action.

sourceValue

val sourceValue: T?

New value of the control that triggered the action.

trigger

val trigger: FormActionTrigger

Functions

controlAt

private fun controlAt(statePath: String): Control<*>

readControl

fun <V : Any> readControl(controlPath: String): V?

Reads the current value of the control at a relative (./, ../) or absolute path.

resolvedPath

private fun resolvedPath(controlPath: String): String

setValue

private fun <V : Any> setValue(controlPath: String, statePath: String, newValue: V?)

stateAt

private fun stateAt(statePath: String): ControlState<*>

updateControl

fun <V : Any> updateControl(controlPath: String, newValue: V?)

Updates the value of a control at a relative (./, ../) or absolute path. A value the control does not accept (Control.acceptsValue) throws.

updateControls

fun <V : Any> updateControls(controlPath: String, newValue: V?)

Updates the values of all controls matching a pattern (e.g. with a * wildcard). The pattern may match nothing - a list of rows can be empty. A path without a wildcard works like updateControl, so without a control it throws.

updateLabel

fun updateLabel(controlPath: String, newLabel: String?)

Updates the control's label (overrides the default one).