From 6ce402754e01940fc641f8814eae03599a622b1c Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 9 Feb 2020 14:23:52 +0100 Subject: API documentation for KVision 2.10.0 --- .../-form-panel/-init-.html | 4 +- .../-form-panel/add-custom.html | 32 +++++++ .../-form-panel/add-internal.html | 4 +- api/pl.treksoft.kvision.form/-form-panel/add.html | 30 ++++--- .../-form-panel/create.html | 4 +- .../-form-panel/index.html | 98 +++++++++++++++++++--- 6 files changed, 143 insertions(+), 29 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/add-custom.html (limited to 'api/pl.treksoft.kvision.form/-form-panel') diff --git a/api/pl.treksoft.kvision.form/-form-panel/-init-.html b/api/pl.treksoft.kvision.form/-form-panel/-init-.html index 97ad93ee..3c5645e2 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/-init-.html +++ b/api/pl.treksoft.kvision.form/-form-panel/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / <init>

<init>

- -FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, classes: Set<String> = setOf(), serializer: KSerializer<K>) + +FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, classes: Set<String> = setOf(), serializer: KSerializer<K>, customSerializers: Map<KClass<*>, KSerializer<*>>? = null)

Parameters

K - model class type

diff --git a/api/pl.treksoft.kvision.form/-form-panel/add-custom.html b/api/pl.treksoft.kvision.form/-form-panel/add-custom.html new file mode 100644 index 00000000..d488e3da --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/add-custom.html @@ -0,0 +1,32 @@ + + + +FormPanel.addCustom - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / addCustom
+
+

addCustom

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

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

+

Parameters

+

+key - key identifier of the control

+

+control - the string form control

+

+required - determines if the control is required

+

+requiredMessage - optional required validation message

+

+legend - put this control inside a fieldset with given legend

+

+validatorMessage - optional function returning validation message

+

+validator - optional validation function

+

Return
+current 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 63e84fa2..7c25cc8a 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, requiredMessage: String? = null, 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, legend: 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 cac9e4ea..37123c44 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, requiredMessage: String? = null, 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, legend: String? = null, validatorMessage: ((C) -> String?)? = null, validator: ((C) -> Boolean?)? = null): FormPanel<K>

Adds a string control to the form panel.

Parameters

@@ -20,14 +20,16 @@ required - determines if the control is required

requiredMessage - optional required validation message

+

+legend - put this control inside a fieldset with given legend

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, requiredMessage: String? = null, 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, legend: String? = null, validatorMessage: ((C) -> String?)? = null, validator: ((C) -> Boolean?)? = null): FormPanel<K>

Adds a boolean control to the form panel.

Parameters

@@ -38,14 +40,16 @@ current form panel

required - determines if the control is required

requiredMessage - optional required validation message

+

+legend - put this control inside a fieldset with given legend

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, requiredMessage: String? = null,