From c9f98dfdbdc3f56553b58dc226b3f841189d0fc0 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 7 Mar 2018 13:46:10 +0100 Subject: API documentation update --- .../-form-panel/add-internal.html | 14 ++++++ api/pl.treksoft.kvision.form/-form-panel/add.html | 56 ++++++++++++++++++++-- .../-form-panel/get-control.html | 4 +- api/pl.treksoft.kvision.form/-form-panel/get.html | 4 +- .../-form-panel/index.html | 23 +++++++-- .../-form-panel/remove.html | 4 +- 6 files changed, 90 insertions(+), 15 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/add-internal.html (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 new file mode 100644 index 00000000..a33da08e --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/add-internal.html @@ -0,0 +1,14 @@ + + + +FormPanel.addInternal - kvision + + + +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>

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/add.html b/api/pl.treksoft.kvision.form/-form-panel/add.html index dabf16e2..4d325c15 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/add.html +++ b/api/pl.treksoft.kvision.form/-form-panel/add.html @@ -8,14 +8,62 @@ kvision / pl.treksoft.kvision.form / FormPanel / add

add

- -

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

Adds a control to the form panel.

+ +

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

Adds a string control to the form panel.

Parameters

key - key identifier of the control

-control - the form control

+control - the string form control

+required - determines if the control is required

+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>

Adds a boolean control to the form panel.

Parameters

+key - key identifier of the control

+control - the boolean form control

+required - determines if the control is required

+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>

Adds a number control to the form panel.

Parameters

+key - key identifier of the control

+control - the number form control

+required - determines if the control is required

+validatorMessage - optional function returning validation message

+validator - optional validation function

Return
+current form panel

+ +

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

Adds a date control to the form panel.

Parameters

+key - key identifier of the control

+control - the date form control

required - determines if the control is required

diff --git a/api/pl.treksoft.kvision.form/-form-panel/get-control.html b/api/pl.treksoft.kvision.form/-form-panel/get-control.html index e3e8b15c..75960c0a 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/get-control.html +++ b/api/pl.treksoft.kvision.form/-form-panel/get-control.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / getControl

getControl

- -open fun getControl(key: String): FormControl? + +open fun getControl(key: KProperty1<K, *>): FormControl?

Returns a control of given key.

Parameters

diff --git a/api/pl.treksoft.kvision.form/-form-panel/get.html b/api/pl.treksoft.kvision.form/-form-panel/get.html index dd82feb1..6c369e60 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/get.html +++ b/api/pl.treksoft.kvision.form/-form-panel/get.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / get

get

- -operator fun get(key: String): Any? + +operator fun get(key: KProperty1<K, *>): Any?

Returns a value of the control of given key.

Parameters

diff --git a/api/pl.treksoft.kvision.form/-form-panel/index.html b/api/pl.treksoft.kvision.form/-form-panel/index.html index 99e379a8..2a99b314 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/index.html +++ b/api/pl.treksoft.kvision.form/-form-panel/index.html @@ -53,12 +53,25 @@

add

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

Adds a control to the form panel.

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

Adds a string control to the 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>

Adds a boolean control to the 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>

Adds a number control to the form panel.

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

Adds a date control to the form panel.

addInternal

+ + +

fun <C : FormControl> addInternal(key: KProperty1<K, *>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

+ + +

clearData

@@ -71,7 +84,7 @@

get

-operator fun get(key: String): Any? +operator fun get(key: KProperty1<K, *>): Any?

Returns a value of the control of given key.

@@ -80,7 +93,7 @@

getControl

-open fun getControl(key: String): FormControl? +open fun getControl(key: KProperty1<K, *>): FormControl?

Returns a control of given key.

@@ -116,7 +129,7 @@

remove

-open fun remove(key: String): FormPanel<K> +open fun remove(key: KProperty1<K, *>): FormPanel<K>

Removes a control from the form panel.

diff --git a/api/pl.treksoft.kvision.form/-form-panel/remove.html b/api/pl.treksoft.kvision.form/-form-panel/remove.html index 0e9d4afd..99b459b3 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/remove.html +++ b/api/pl.treksoft.kvision.form/-form-panel/remove.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / remove

remove

- -open fun remove(key: String): FormPanel<K> + +open fun remove(key: KProperty1<K, *>): FormPanel<K>

Removes a control from the form panel.

Parameters

-- cgit