kvision/io.kvision.form/Form

Form

class Form<K : Any>(panel: FormPanel<K>? = null, serializer: <Error class: unknown class><K>? = null, customSerializers: Map<KClass<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null)

The form definition class. Can be used directly or indirectly inside a FormPanel.

Parameters

model class type

panel

optional instance of FormPanel

serializer

a serializer for model type

customSerializers

a map of custom serializers for model type

Constructors

Form

constructor(panel: FormPanel<K>? = null, serializer: <Error class: unknown class><K>? = null, customSerializers: Map<KClass<*>, <Error class: unknown class><out <Error class: unknown class>>>? = null)

Creates a form with a given modelFactory function

Types

Companion

object Companion

Properties

fields

val fields: <Error class: unknown class><String, FormControl>

modelFactory

val modelFactory: (Map<String, Any?>) -> K?

Functions

add

fun <C : FormControl> add(key: String, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a form control to the form with a dynamic keys.

fun <C : DateFormControl> add(key: KProperty1<K, <Error class: unknown class>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a date control to the form.

fun <C : BoolFormControl> add(key: KProperty1<K, Boolean?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a boolean control to the form.

fun <C : TriStateFormControl> add(key: KProperty1<K, Boolean?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a nullable boolean control to the form.

fun <C : NumberFormControl> add(key: KProperty1<K, Number?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a number control to the form.

fun <C : StringFormControl> add(key: KProperty1<K, String?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a string control to the form.

fun <C : KFilesFormControl> add(key: KProperty1<K, List<<Error class: unknown class>>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a files control to the form.

addCustom

fun <C : StringFormControl> addCustom(key: KProperty1<K, Any?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String?? = null, validator: (C) -> Boolean?? = null)

Adds a string control to the form bound to custom field type.

clearData

fun clearData()

Sets the values of all controls to null.

clearValidation

fun clearValidation()

Clear validation information from all fields.

get