From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- api/pl.treksoft.kvision.form/-form/-init-.html | 24 ---- api/pl.treksoft.kvision.form/-form/add.html | 102 --------------- api/pl.treksoft.kvision.form/-form/clear-data.html | 15 --- api/pl.treksoft.kvision.form/-form/create.html | 14 -- .../-form/get-control.html | 20 --- .../-form/get-data-json.html | 17 --- api/pl.treksoft.kvision.form/-form/get-data.html | 17 --- api/pl.treksoft.kvision.form/-form/get.html | 20 --- api/pl.treksoft.kvision.form/-form/index.html | 143 --------------------- api/pl.treksoft.kvision.form/-form/remove-all.html | 17 --- api/pl.treksoft.kvision.form/-form/remove.html | 20 --- api/pl.treksoft.kvision.form/-form/set-data.html | 18 --- api/pl.treksoft.kvision.form/-form/validate.html | 17 --- 13 files changed, 444 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form/-form/-init-.html delete mode 100644 api/pl.treksoft.kvision.form/-form/add.html delete mode 100644 api/pl.treksoft.kvision.form/-form/clear-data.html delete mode 100644 api/pl.treksoft.kvision.form/-form/create.html delete mode 100644 api/pl.treksoft.kvision.form/-form/get-control.html delete mode 100644 api/pl.treksoft.kvision.form/-form/get-data-json.html delete mode 100644 api/pl.treksoft.kvision.form/-form/get-data.html delete mode 100644 api/pl.treksoft.kvision.form/-form/get.html delete mode 100644 api/pl.treksoft.kvision.form/-form/index.html delete mode 100644 api/pl.treksoft.kvision.form/-form/remove-all.html delete mode 100644 api/pl.treksoft.kvision.form/-form/remove.html delete mode 100644 api/pl.treksoft.kvision.form/-form/set-data.html delete mode 100644 api/pl.treksoft.kvision.form/-form/validate.html (limited to 'api/pl.treksoft.kvision.form/-form') diff --git a/api/pl.treksoft.kvision.form/-form/-init-.html b/api/pl.treksoft.kvision.form/-form/-init-.html deleted file mode 100644 index d2e40cfd..00000000 --- a/api/pl.treksoft.kvision.form/-form/-init-.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -Form.<init> - kvision - - - -kvision / pl.treksoft.kvision.form / Form / <init>
-
-

<init>

- -Form(panel: FormPanel<K>? = null, serializer: KSerializer<K>) -

Creates a form with a given modelFactory function

Parameters

-K - model class type

-panel - optional instance of FormPanel

-serializer - a serializer for model type

Constructor
-Creates a form with a given modelFactory function

- - diff --git a/api/pl.treksoft.kvision.form/-form/add.html b/api/pl.treksoft.kvision.form/-form/add.html deleted file mode 100644 index d1322272..00000000 --- a/api/pl.treksoft.kvision.form/-form/add.html +++ /dev/null @@ -1,102 +0,0 @@ - - - -Form.add - kvision - - - -kvision / pl.treksoft.kvision.form / Form / add
-
-

add

- -

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

-key - key identifier of the control

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

Adds a boolean control to the form.

Parameters

-key - key identifier of the control

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

Adds a number control to the form.

Parameters

-key - key identifier of the control

-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 : DateFormControl> add(key: KProperty1<K, Date?>, 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

-key - key identifier of the control

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

Adds a files control to the form.

Parameters

-key - key identifier of the control

-control - the files 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

- - diff --git a/api/pl.treksoft.kvision.form/-form/clear-data.html b/api/pl.treksoft.kvision.form/-form/clear-data.html deleted file mode 100644 index cc02df05..00000000 --- a/api/pl.treksoft.kvision.form/-form/clear-data.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Form.clearData - kvision - - - -kvision / pl.treksoft.kvision.form / Form / clearData
-
-

clearData

- -fun clearData(): Unit -

Sets the values of all controls to null.

- - diff --git a/api/pl.treksoft.kvision.form/-form/create.html b/api/pl.treksoft.kvision.form/-form/create.html deleted file mode 100644 index 6db5df89..00000000 --- a/api/pl.treksoft.kvision.form/-form/create.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -Form.create - kvision - - - -kvision / pl.treksoft.kvision.form / Form / create
-
-

create

- -

inline fun <reified K : Any> create(panel: FormPanel<K>? = null, noinline init: Form<K>.() -> Unit = null): Form<K>

- - diff --git a/api/pl.treksoft.kvision.form/-form/get-control.html b/api/pl.treksoft.kvision.form/-form/get-control.html deleted file mode 100644 index 83ad285f..00000000 --- a/api/pl.treksoft.kvision.form/-form/get-control.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -Form.getControl - kvision - - - -kvision / pl.treksoft.kvision.form / Form / getControl
-
-

getControl

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

Returns a control of given key.

Parameters

-key - key identifier of the control

Return
-selected control

- - diff --git a/api/pl.treksoft.kvision.form/-form/get-data-json.html b/api/pl.treksoft.kvision.form/-form/get-data-json.html deleted file mode 100644 index 4c327ae8..00000000 --- a/api/pl.treksoft.kvision.form/-form/get-data-json.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -Form.getDataJson - kvision - - - -kvision / pl.treksoft.kvision.form / Form / getDataJson
-
-

getDataJson

- -fun getDataJson(): Json -

Returns current data model as JSON.

Return
-data model as JSON

- - diff --git a/api/pl.treksoft.kvision.form/-form/get-data.html b/api/pl.treksoft.kvision.form/-form/get-data.html deleted file mode 100644 index bc3e0f12..00000000 --- a/api/pl.treksoft.kvision.form/-form/get-data.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -Form.getData - kvision - - - -kvision / pl.treksoft.kvision.form / Form / getData
-
-

getData

- -fun getData(): K -

Returns current data model.

Return
-data model

- - diff --git a/api/pl.treksoft.kvision.form/-form/get.html b/api/pl.treksoft.kvision.form/-form/get.html deleted file mode 100644 index e03bdc45..00000000 --- a/api/pl.treksoft.kvision.form/-form/get.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -Form.get - kvision - - - -kvision / pl.treksoft.kvision.form / Form / get
-
-

get

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

Returns a value of the control of given key.

Parameters

-key - key identifier of the control

Return
-value of the control

- - diff --git a/api/pl.treksoft.kvision.form/-form/index.html b/api/pl.treksoft.kvision.form/-form/index.html deleted file mode 100644 index 693f2c30..00000000 --- a/api/pl.treksoft.kvision.form/-form/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - -Form - kvision - - - -kvision / pl.treksoft.kvision.form / Form
-
-

Form

-class Form<K : Any> -

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

Constructors

- - - - - - - -

<init>

-Form(panel: FormPanel<K>? = null, serializer: KSerializer<K>) -

Creates a form with a given modelFactory function

Functions

- - - - -

add

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

Adds a 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): Form<K>

Adds a number control to the form.

fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, requiredMessage: String? = null,