form-engine/org.octavius.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)

Kontekst dostarczany do ControlAction, dający dostęp do stanu formularza i narzędzi.

Type Parameters

T

typ wartości kontrolki, która wyzwoliła akcję.

Constructors

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

Properties

val coroutineScope: CoroutineScope

Scope do uruchamiania operacji asynchronicznych (np. API).

val errorManager: ErrorManager

Dostęp do managera błędów.

val formSchema: FormSchema

Dostęp do schemy formularza.

val formState: FormState

Dostęp do globalnego stanu formularza.

val payload: Any?

sourceControlContext

val sourceControlContext: ControlContext

Kontekst kontrolki, która wyzwoliła akcję.

val sourceValue: T?

Nowa wartość kontrolki, która wyzwoliła akcję.

val trigger: FormActionTrigger

Functions

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

Czyta bieżącą wartość kontrolki spod ścieżki względnej (./, ../) lub bezwzględnej.

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

Aktualizuje wartość kontrolki używając ścieżki względnej (./, ../) lub bezwzględnej.

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

Aktualizuje wartości wielu kontrolek pasujących do wzorca (np. z wildcardem *).

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

Aktualizuje etykietę kontrolki (nadpisuje domyślną).