From 415afec335659ca6bc206b34bdd3c2fe4635718f Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 1 Mar 2018 15:19:44 +0100 Subject: KVision site with Jekyll --- .../-form-panel/-init-.html | 25 +++ api/pl.treksoft.kvision.form/-form-panel/add.html | 28 +++ .../-form-panel/clear-data.html | 15 ++ .../-form-panel/form-panel.html | 16 ++ .../-form-panel/get-control.html | 20 ++ .../-form-panel/get-data-json.html | 17 ++ .../-form-panel/get-data.html | 17 ++ .../-form-panel/get-sn-class.html | 18 ++ api/pl.treksoft.kvision.form/-form-panel/get.html | 20 ++ .../-form-panel/index.html | 235 +++++++++++++++++++++ .../-form-panel/remove-all.html | 18 ++ .../-form-panel/remove.html | 20 ++ .../-form-panel/render.html | 18 ++ .../-form-panel/set-data.html | 18 ++ .../-form-panel/validate.html | 17 ++ .../-form-panel/validator-message.html | 15 ++ .../-form-panel/validator.html | 15 ++ 17 files changed, 532 insertions(+) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/-init-.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/add.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/clear-data.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/form-panel.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-control.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-data-json.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-data.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/index.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/remove-all.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/remove.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/render.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/set-data.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/validate.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/validator-message.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/validator.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 new file mode 100644 index 00000000..754f2a51 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/-init-.html @@ -0,0 +1,25 @@ + + + +FormPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / <init>
+
+

<init>

+ +FormPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K) +

Parameters

+K - model class type

+type - form layout

+classes - set of CSS class names

+modelFactory - function transforming a Map<String, Any?> to a data model of class K

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/add.html b/api/pl.treksoft.kvision.form/-form-panel/add.html new file mode 100644 index 00000000..dabf16e2 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/add.html @@ -0,0 +1,28 @@ + + + +FormPanel.add - kvision + + + +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.

Parameters

+key - key identifier of the control

+control - the form control

+required - determines if the control is required

+validatorMessage - optional function returning validation message

+validator - optional validation function

Return
+current form panel

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

clearData

+ +open fun clearData(): Unit +

Sets the values of all controls to null.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/form-panel.html b/api/pl.treksoft.kvision.form/-form-panel/form-panel.html new file mode 100644 index 00000000..6410911f --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/form-panel.html @@ -0,0 +1,16 @@ + + + +FormPanel.formPanel - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / formPanel
+
+

formPanel

+ +

fun <K> Container.formPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K>

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/get-control.html b/api/pl.treksoft.kvision.form/-form-panel/get-control.html new file mode 100644 index 00000000..e3e8b15c --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/get-control.html @@ -0,0 +1,20 @@ + + + +FormPanel.getControl - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / getControl
+
+

getControl

+ +open fun getControl(key: String): 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-panel/get-data-json.html b/api/pl.treksoft.kvision.form/-form-panel/get-data-json.html new file mode 100644 index 00000000..f472a575 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/get-data-json.html @@ -0,0 +1,17 @@ + + + +FormPanel.getDataJson - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / getDataJson
+
+

getDataJson

+ +open fun getDataJson(): Json +

Returns current data model as JSON.

Return
+data model as JSON

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

getData

+ +open fun getData(): K +

Returns current data model.

Return
+data model

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/get-sn-class.html b/api/pl.treksoft.kvision.form/-form-panel/get-sn-class.html new file mode 100644 index 00000000..dd839778 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/get-sn-class.html @@ -0,0 +1,18 @@ + + + +FormPanel.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/get.html b/api/pl.treksoft.kvision.form/-form-panel/get.html new file mode 100644 index 00000000..dd82feb1 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/get.html @@ -0,0 +1,20 @@ + + + +FormPanel.get - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / get
+
+

get

+ +operator fun get(key: String): 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-panel/index.html b/api/pl.treksoft.kvision.form/-form-panel/index.html new file mode 100644 index 00000000..99e379a8 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/index.html @@ -0,0 +1,235 @@ + + + +FormPanel - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel
+
+

FormPanel

+open class FormPanel<K> : SimplePanel +

Bootstrap form component.

Constructors

+ + + + + + + +

<init>

+FormPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K)

Properties

+ + + + + + + + + + + +

+ validator +	+`var validator: (Form<K>) -> Boolean?` + Validation function. +
+ validatorMessage +	+`var validatorMessage: (Form<K>) -> String?` + Function returning validation message. +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ 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. +
+ clearData +	+`open fun clearData(): Unit` + Sets the values of all controls to null. +
+ get +	+`operator fun get(key: String): Any?` + Returns a value of the control of given key. +
+ getControl +	+`open fun getControl(key: String): FormControl?` + Returns a control of given key. +
+ getData +	+`open fun getData(): K` + Returns current data model. +
+ getDataJson +	+`open fun getDataJson(): Json` + Returns current data model as JSON. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ remove +	+`open fun remove(key: String): FormPanel<K>` + Removes a control from the form panel. +
+ removeAll +	+`open fun removeAll(): FormPanel<K>` + Removes all children from the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ setData +	+`open fun setData(model: K): Unit` + Sets the values of all the controls from the model. +
+ validate +	+`open fun validate(): Boolean` + Invokes validator function and validates the form. +

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +

Companion Object Functions

+ + + + + + + +

formPanel

fun <K> Container.formPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K>

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/remove-all.html b/api/pl.treksoft.kvision.form/-form-panel/remove-all.html new file mode 100644 index 00000000..31ab388f --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +FormPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): FormPanel<K> +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/remove.html b/api/pl.treksoft.kvision.form/-form-panel/remove.html new file mode 100644 index 00000000..0e9d4afd --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/remove.html @@ -0,0 +1,20 @@ + + + +FormPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / remove
+
+

remove

+ +open fun remove(key: String): FormPanel<K> +

Removes a control from the form panel.

Parameters

+key - key identifier of the control

Return
+current form panel

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/render.html b/api/pl.treksoft.kvision.form/-form-panel/render.html new file mode 100644 index 00000000..625a9dfb --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/render.html @@ -0,0 +1,18 @@ + + + +FormPanel.render - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/set-data.html b/api/pl.treksoft.kvision.form/-form-panel/set-data.html new file mode 100644 index 00000000..347f7cf1 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/set-data.html @@ -0,0 +1,18 @@ + + + +FormPanel.setData - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / setData
+
+

setData

+ +open fun setData(model: K): Unit +

Sets the values of all the controls from the model.

Parameters

+model - data model

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/validate.html b/api/pl.treksoft.kvision.form/-form-panel/validate.html new file mode 100644 index 00000000..e1e1be05 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/validate.html @@ -0,0 +1,17 @@ + + + +FormPanel.validate - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / validate
+
+

validate

+ +open fun validate(): Boolean +

Invokes validator function and validates the form.

Return
+validation result

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/validator-message.html b/api/pl.treksoft.kvision.form/-form-panel/validator-message.html new file mode 100644 index 00000000..09f629f9 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/validator-message.html @@ -0,0 +1,15 @@ + + + +FormPanel.validatorMessage - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / validatorMessage
+
+

validatorMessage

+ +var validatorMessage: (Form<K>) -> String? +

Function returning validation message.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/validator.html b/api/pl.treksoft.kvision.form/-form-panel/validator.html new file mode 100644 index 00000000..88081e7c --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/validator.html @@ -0,0 +1,15 @@ + + + +FormPanel.validator - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / validator
+
+

validator

+ +var validator: (Form<K>) -> Boolean? +

Validation function.

+ + -- cgit