form-engine/org.octavius.form.control.type.selection/EnumControl

EnumControl

class EnumControl<T : Enum<T>, EnumWithFormatter<T>>(label: String?, val enumClass: KClass<T>, required: Boolean? = false, dependencies: Map<String, ControlDependency<*>>? = null, actions: List<ControlAction<T>>? = null) : DropdownControlBase<T>

Kontrolka do wyboru wartości z enumeracji (enum) z listy rozwijanej.

Automatycznie generuje opcje wyboru na podstawie wartości enumeracji. Wymaga aby enum implementował interfejs EnumWithFormatter dla formatowania tekstu wyświetlanego użytkownikowi. Obsługuje wyszukiwanie w opcjach.

Constructors

EnumControl

constructor(label: String?, enumClass: KClass<T>, required: Boolean? = false, dependencies: Map<String, ControlDependency<*>>? = null, actions: List<ControlAction<T>>? = null)

Properties

actions

private val actions: List<ControlAction<T>>?

dependencies

internal val dependencies: Map<String, ControlDependency<*>>?

enumClass

private val enumClass: KClass<T>

errorManager

protected lateinit var errorManager: ErrorManager

formActionTrigger

protected lateinit var formActionTrigger: FormActionTrigger

formSchema

protected lateinit var formSchema: FormSchema

formState

protected lateinit var formState: FormState

hasStandardLayout

protected val hasStandardLayout: Boolean

hierarchyRole

internal var hierarchyRole: ControlHierarchyRole

Flaga określająca, rolę kontrolki w hierarchii.

label

internal val label: String?

required

internal val required: Boolean?

validationOptions

internal val validationOptions: ValidationOptions?

validator

protected open val validator: ControlValidator<T>

Validator odpowiedzialny za walidację tej kontrolki. Każdy typ kontrolki dostarcza własną implementację (np. StringValidator). Domyślnie pusta implementacja

Functions

convertToResult

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

Konwertuje wewnętrzny stan kontrolki (ControlState) na wynik do zapisu (ControlResultData). Może być przesłonięta dla niestandardowych konwersji (np. w RepeatableControl).

copyInitToValue

internal open fun copyInitToValue(value: T): T

Tworzy głęboką kopię wartości początkowej dla bieżącej wartości. Kluczowe dla typów mutowalnych (np. List), aby zmiany w value nie wpływały na initValue.

Display

@Composable

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

Abstrakcyjna metoda renderowania specyficznego interfejsu kontrolki. Każdy konkretny typ kontrolki (np. StringControl) musi ją zaimplementować.

DisplayFieldErrors

@Composable

protected fun DisplayFieldErrors(controlContext: ControlContext)

Pomocnicza funkcja renderująca błędy walidacji dla tej kontrolki.

executeActions

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

Wykonuje zdefiniowane akcje dla tej kontrolki, zazwyczaj po zmianie wartości.

executeInitActions

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

getResult

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

Pobiera wynik kontrolki (wartość bieżącą i początkową) do dalszego przetwarzania. Jeśli kontrolka jest niewidoczna, jej currentValue jest ustawiane na null.

initializeControlLifecycle

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

Ustawia referencje do komponentów formularza. Jest to drugi etap inicjalizacji kontrolki, wywoływany przez FormHandler. Daje dostęp do globalnego stanu, schemy i managera błędów. Dodatkowo umożliwia wykonanie dodatkowych kroków inicjalizacyjnych wymaganych przez określone kontrolki

registerChildrenInGlobalMap

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

Funkcja do rejestracji dzieci na globalnej mapie Zawiera referencje do kontrolek zdefiniowanych w kontrolce posiadającej własne

Render

@Composable

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

Renderuje kontrolkę w interfejsie użytkownika. Ta metoda jest publicznym API dla FormScreen. Obsługuje logikę widoczności.

RenderMenuItems

@Composable

protected open override fun ColumnScope.RenderMenuItems(controlContext: ControlContext, scope: CoroutineScope, controlState: ControlState<T>, menuScrollState: ScrollState, closeMenu: () -> Unit)

Podklasy muszą zaimplementować tę metodę, aby wyrenderować zawartość menu rozwijanego.

resolveDisplayText

protected open suspend override fun resolveDisplayText(value: T): String

Wyznacza tekst dla wybranej wartości. Wołane raz na wartość, poza ścieżką renderowania, a wynik ląduje w ControlState.displayText - dlatego wolno tu odpytać bazę albo API.

setInitValue

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

Ustawia początkową wartość kontrolki i tworzy jej stan (ControlState).

validateControl

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

Uruchamia proces walidacji dla tej kontrolki przy użyciu przypisanego walidatora.