From 63503bd4517d87c34498002c820aefaef22c501e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 22 Aug 2018 15:34:00 +0200 Subject: API documentation for 0.0.17 --- api/pl.treksoft.kvision.form/-form/add.html | 30 ++++++++++++++++++--------- api/pl.treksoft.kvision.form/-form/index.html | 10 ++++----- 2 files changed, 25 insertions(+), 15 deletions(-) (limited to 'api/pl.treksoft.kvision.form/-form') diff --git a/api/pl.treksoft.kvision.form/-form/add.html b/api/pl.treksoft.kvision.form/-form/add.html index ee324f93..54194e62 100644 --- a/api/pl.treksoft.kvision.form/-form/add.html +++ b/api/pl.treksoft.kvision.form/-form/add.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / Form / add

add

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

Adds a string control to the form.

Parameters

@@ -18,14 +18,16 @@ control - the string form control

required - determines if the control is required

+

+requiredMessage - optional required validation message

validatorMessage - optional function returning validation message

validator - optional validation function

Return
current form

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

Adds a boolean control to the form.

Parameters

@@ -34,14 +36,16 @@ current form

control - the boolean form control

required - determines if the control is required

+

+requiredMessage - optional required validation message

validatorMessage - optional function returning validation message

validator - optional validation function

Return
current form

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

Adds a number control to the form.

Parameters

@@ -50,14 +54,16 @@ current form

control - the number form control

required - determines if the control is required

+

+requiredMessage - optional required validation message

validatorMessage - optional function returning validation message

validator - optional validation function

Return
current form

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

Adds a date control to the form.

Parameters

@@ -66,14 +72,16 @@ current form

control - the date form control

required - determines if the control is required

+

+requiredMessage - optional required validation message

validatorMessage - optional function returning validation message

validator - optional validation function

Return
current form

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

Adds a files control to the form.

Parameters

@@ -82,6 +90,8 @@ current form

control - the files form control

required - determines if the control is required

+

+requiredMessage - optional required validation message

validatorMessage - optional function returning validation message

diff --git a/api/pl.treksoft.kvision.form/-form/index.html b/api/pl.treksoft.kvision.form/-form/index.html index f34e7aea..3de71e84 100644 --- a/api/pl.treksoft.kvision.form/-form/index.html +++ b/api/pl.treksoft.kvision.form/-form/index.html @@ -32,15 +32,15 @@

add

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

Adds a string control to the form.

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