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 --- .../-form-panel/add-internal.html | 4 +-- api/pl.treksoft.kvision.form/-form-panel/add.html | 30 ++++++++++++++-------- .../-form-panel/index.html | 12 ++++----- 3 files changed, 28 insertions(+), 18 deletions(-) (limited to 'api/pl.treksoft.kvision.form/-form-panel') diff --git a/api/pl.treksoft.kvision.form/-form-panel/add-internal.html b/api/pl.treksoft.kvision.form/-form-panel/add-internal.html index a33da08e..fbbbd6fe 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/add-internal.html +++ b/api/pl.treksoft.kvision.form/-form-panel/add-internal.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form / FormPanel / addInternal

addInternal

- -protected fun <C : FormControl> addInternal(key: KProperty1<K, *>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K> + +protected fun <C : FormControl> addInternal(key: KProperty1<K, *>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K> diff --git a/api/pl.treksoft.kvision.form/-form-panel/add.html b/api/pl.treksoft.kvision.form/-form-panel/add.html index 723ce9f7..55663b95 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/add.html +++ b/api/pl.treksoft.kvision.form/-form-panel/add.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / add

add

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

Adds a string control to the form panel.

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 panel

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

Adds a boolean control to the form panel.

Parameters

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

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 panel

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

Adds a number control to the form panel.

Parameters

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

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 panel

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

Adds a date control to the form panel.

Parameters

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

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 panel

- -open fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K> + +open 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): FormPanel