form-engine/org.octavius.form.control.base

Package-level declarations

Types

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.

BigDecimalValidation

data class BigDecimalValidation(val min: BigDecimal? = null, val max: BigDecimal? = null, val step: BigDecimal? = null, val decimalPlaces: Int? = null) : ValidationOptions

Opcje walidacji dla liczb o wysokiej precyzji (BigDecimal).

ComparisonType

enum ComparisonType : Enum<ComparisonType>

Sposób porównania wartości w zależnościach.

Control

abstract class Control<T : Any>(val label: String?, val required: Boolean?, val dependencies: Map<String, ControlDependency<*>>?, val validationOptions: ValidationOptions? = null, val actions: List<ControlAction<T>>? = null, val hasStandardLayout: Boolean = true)

Abstrakcyjna klasa bazowa dla wszystkich kontrolek formularza.

ControlAction

class ControlAction<T>(val action: suspend ActionContext<T>.() -> Unit)

Definiuje akcję do wykonania po zmianie wartości kontrolki.

ControlContext

data class ControlContext(val localName: String, val statePath: String = "", val controlPath: String = "", val parent: ControlContext? = null)

Kontekst renderowania i stanu kontrolki w hierarchii formularza.

ControlDependency

data class ControlDependency<T>(val controlName: String, val value: T, val dependencyType: DependencyType, val comparisonType: ComparisonType, val scope: DependencyScope = DependencyScope.Global)

Definuje zależność między kontrolkami.

ControlHierarchyRole

enum ControlHierarchyRole : Enum<ControlHierarchyRole>

ControlResultData

data class ControlResultData(val currentValue: Any?, val initialValue: Any?)

Wynik przetwarzania pojedynczej kontrolki formularza.

ControlState

data class ControlState<T>(val value: MutableState<T?> = mutableStateOf(null), val initValue: MutableState<T?> = mutableStateOf(null), val revision: MutableState<Int> = mutableStateOf(0))

Reaktywny stan pojedynczej kontrolki formularza.

ControlValidator

abstract class ControlValidator<T : Any>

Abstrakcyjna klasa bazowa dla wszystkich walidatorów kontrolek formularza.

DateTimeValidation

data class DateTimeValidation<T>(val min: T? = null, val max: T? = null) : ValidationOptions

Generyczne opcje walidacji dla wszystkich kontrolek daty i czasu.

DependencyScope

enum DependencyScope : Enum<DependencyScope>

Zasięg zależności między kontrolkami.

DependencyType

enum DependencyType : Enum<DependencyType>

Typ zależności między kontrolkami.

DoubleValidation

data class DoubleValidation(val min: Double? = null, val max: Double? = null, val step: Double? = null, val decimalPlaces: Int? = null) : ValidationOptions

Opcje walidacji dla liczb zmiennoprzecinkowych.

FormResultData

typealias FormResultData = Map<String, ControlResultData>

Alias dla mapy zawierającej wyniki wszystkich kontrolek formularza.

IntegerValidation

data class IntegerValidation(val min: Int? = null, val max: Int? = null, val step: Int? = null) : ValidationOptions

Opcje walidacji dla liczb całkowitych.

IntervalValidation

data class IntervalValidation(val min: Duration? = null, val max: Duration? = null) : ValidationOptions

Opcje walidacji dla interwałów czasowych.

RepeatableValidation

data class RepeatableValidation(val minItems: Int? = null, val maxItems: Int? = null, val uniqueFields: List<String> = emptyList()) : ValidationOptions

Opcje walidacji dla kontrolek powtarzalnych.

StringListValidation

data class StringListValidation(val minItems: Int? = null, val maxItems: Int? = null, val itemValidation: StringValidation? = null) : ValidationOptions

Opcje walidacji dla list tekstowych.

StringValidation

data class StringValidation(val minLength: Int? = null, val maxLength: Int? = null, val pattern: Regex? = null, val patternErrorMessage: String? = null) : ValidationOptions

Opcje walidacji dla pól tekstowych.

ValidationOptions

sealed class ValidationOptions

Opcje walidacji dla kontrolek formularza. Definiuje reguły walidacji które można zastosować do różnych typów kontrolek.

Functions

getCurrent

fun FormResultData.getCurrent(key: String): Any?

Pobiera bieżącą wartość kontrolki jako Any?.

getCurrentAs

inline fun <T> FormResultData.getCurrentAs(key: String): T

Pobiera bieżącą wartość kontrolki jako określony typ T. Obsługuje rzutowanie na typ T

getInitial

fun FormResultData.getInitial(key: String): Any?

Pobiera początkową wartość kontrolki jako Any?

getInitialAs

inline fun <T> FormResultData.getInitialAs(key: String): T

Pobiera początkową wartość kontrolki jako określony typ T.