form-engine/io.github.octaviusframework.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)

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

BigDecimalValidation

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

Validation options of high-precision numbers (BigDecimal).

ComparisonType

enum ComparisonType : Enum<ComparisonType>

How values are compared in dependencies.

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)

Abstract base class of all form controls.

ControlAction

class ControlAction<T>(val executeOnInit: Boolean = false, val action: suspend ActionContext<T>.() -> Unit)

Defines an action to run after a control's value changes.

ControlContext

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

Rendering and state context of a control in the form hierarchy.

ControlDependency

data class ControlDependency<T>(val controlPath: String, val value: T, val dependencyType: DependencyType, val comparisonType: ComparisonType)

Defines a dependency between controls.

ControlResultData

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

Result of processing a single form control.

ControlState

data class ControlState<T>(val value: MutableState<T?> = mutableStateOf(null), val initValue: MutableState<T?> = mutableStateOf(null), val displayText: MutableState<String?> = mutableStateOf(null), val labelOverride: MutableState<String?> = mutableStateOf(null))

Reactive state of a single form control.

ControlValidator

abstract class ControlValidator<T : Any>

Abstract base class of all form control validators.

DateTimeValidation

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

Generic validation options of all date and time controls.

DependencyType

enum DependencyType : Enum<DependencyType>

Type of a dependency between controls.

DoubleValidation

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

Validation options of floating-point numbers.

FormResultData

typealias FormResultData = Map<String, ControlResultData>

Alias for the map holding the results of all form controls.

IntegerValidation

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

Validation options of integers.

IntervalValidation

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

Validation options of time intervals.

RepeatableValidation

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

Validation options of repeatable controls.

StringListValidation

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

Validation options of text lists.

StringValidation

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

Validation options of text fields.

ValidationOptions

sealed class ValidationOptions

Validation options of form controls. Defines validation rules that apply to the various control types.