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 --- api/alltypes/index.html | 7 ++ api/index-outline.html | 92 +++++++++++---- .../-widget-wrapper/visible.html | 6 - api/pl.treksoft.kvision.core/-widget/visible.html | 3 - .../-data-container/-init-.html | 14 ++- .../-data-container/data-container.html | 4 +- .../-data-container/index.html | 4 +- .../-data-container/visible.html | 6 - .../-drop-down/width.html | 6 - .../-check-box/disabled.html | 6 - .../-check-box/size.html | 6 - .../-check-box/value.html | 6 - .../-radio-group/disabled.html | 6 - .../-radio/disabled.html | 6 - .../-radio/size.html | 6 - .../-radio/value.html | 6 - .../-ajax-options/before-send.html | 1 + .../-ajax-options/cache.html | 1 + .../-ajax-options/clear-on-empty.html | 1 + .../-ajax-options/clear-on-error.html | 1 + .../-ajax-options/data.html | 1 + .../-ajax-options/empty-request.html | 1 + .../-ajax-options/http-type.html | 1 + .../-ajax-options/index.html | 50 +++++++-- .../-ajax-options/min-length.html | 1 + .../-ajax-options/preprocess-data.html | 2 + .../-ajax-options/request-delay.html | 1 + .../-ajax-options/restore-on-error.html | 2 + .../-ajax-options/url.html | 1 + .../-select/disabled.html | 6 - .../-select/size.html | 6 - .../-select/value.html | 6 - .../-spinner/disabled.html | 6 - .../-spinner/size.html | 6 - .../-spinner/value.html | 6 - .../-abstract-text/disabled.html | 6 - .../-abstract-text/size.html | 6 - .../-abstract-text/value.html | 6 - .../-date-time/disabled.html | 6 - .../-date-time/size.html | 6 - .../-date-time/value.html | 6 - .../-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 +- api/pl.treksoft.kvision.form/-form/add.html | 56 +++++++++- .../-form/get-control.html | 4 +- api/pl.treksoft.kvision.form/-form/get.html | 4 +- api/pl.treksoft.kvision.form/-form/index.html | 16 ++- api/pl.treksoft.kvision.form/-form/remove.html | 4 +- api/pl.treksoft.kvision.html/-icon/-init-.html | 19 ++++ .../-icon/get-sn-class.html | 18 +++ api/pl.treksoft.kvision.html/-icon/icon.html | 25 +++++ api/pl.treksoft.kvision.html/-icon/index.html | 123 +++++++++++++++++++++ api/pl.treksoft.kvision.html/-t-a-g/-b.html | 14 +++ api/pl.treksoft.kvision.html/-t-a-g/-i.html | 14 +++ api/pl.treksoft.kvision.html/-t-a-g/index.html | 14 +++ api/pl.treksoft.kvision.html/-tag/index.html | 9 ++ api/pl.treksoft.kvision.html/index.html | 9 ++ api/pl.treksoft.kvision.panel/-root/get-root.html | 14 +++ api/pl.treksoft.kvision.panel/-root/index.html | 7 ++ 63 files changed, 568 insertions(+), 207 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/add-internal.html create mode 100644 api/pl.treksoft.kvision.html/-icon/-init-.html create mode 100644 api/pl.treksoft.kvision.html/-icon/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.html/-icon/icon.html create mode 100644 api/pl.treksoft.kvision.html/-icon/index.html create mode 100644 api/pl.treksoft.kvision.html/-t-a-g/-b.html create mode 100644 api/pl.treksoft.kvision.html/-t-a-g/-i.html create mode 100644 api/pl.treksoft.kvision.panel/-root/get-root.html diff --git a/api/alltypes/index.html b/api/alltypes/index.html index 5c8235f6..fe473ce7 100644 --- a/api/alltypes/index.html +++ b/api/alltypes/index.html @@ -499,6 +499,13 @@ +pl.treksoft.kvision.html.Icon + +

Icon component with support for FontAwesome and Bootstrap glyphicons.

+ + + + pl.treksoft.kvision.html.Image

Image component.

diff --git a/api/index-outline.html b/api/index-outline.html index 0815c13a..2d6124cf 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -764,11 +764,11 @@ -DataContainer(model: ObservableList<M>, binding: (Int) -> C, filter: (Int) -> Boolean = null, child: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null)
+DataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<M>) -> List<M> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null)
fun add(child: Component): Container
fun addAll(children: List<Component>): Container
fun clearOnUpdate(): DataContainer<M, C>
-fun <M, C : Component> Container.dataContainer(model: ObservableList<M>, binding: (Int) -> C, filter: (Int) -> Boolean = null, child: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null): DataContainer<M, C>
+fun <M, C : Component> Container.dataContainer(model: ObservableList<M>, factory: (Int, M) -> C, filter: (Int, M) -> Boolean = null, mapping: (List<M>) -> List<M> = null, container: Container = VPanel(), init: DataContainer<M, C>.() -> Unit = null): DataContainer<M, C>
fun getChildren(): List<Component>
fun onUpdate(handler: () -> Unit): DataContainer<M, C>
fun remove(child: Component): Container
@@ -1134,13 +1134,16 @@ Form(panel: FormPanel<K>? = null, modelFactory: (Map<String, Any?>) -> K)
-fun <C : FormControl> add(key: String, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>
+fun <C : StringFormControl> add(key: KProperty1<K, String?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>
+fun <C : BoolFormControl> add(key: KProperty1<K, Boolean?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>
+fun <C : NumberFormControl> add(key: KProperty1<K, Number?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>
+fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>
fun clearData(): Unit
-operator fun get(key: String): Any?
-fun getControl(key: String): FormControl?
+operator fun get(key: KProperty1<K, *>): Any?
+fun getControl(key: KProperty1<K, *>): FormControl?
fun getData(): K
fun getDataJson(): Json
-fun remove(key: String): Form<K>
+fun remove(key: KProperty1<K, *>): Form<K>
fun removeAll(): Form<K>
fun setData(model: K): Unit
fun validate(): Boolean
@@ -1178,15 +1181,19 @@ FormPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K)
-open fun <C : FormControl> add(key: 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, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>
+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 : NumberFormControl> add(key: KProperty1<K, Number?>, control: C, required: Boolean = false, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>
+open fun <C : DateFormControl> add(key: KProperty1<K, Date?>, 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, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>
open fun clearData(): Unit
fun <K> Container.formPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K>
-operator fun get(key: String): Any?
-open fun getControl(key: String): FormControl?
+operator fun get(key: KProperty1<K, *>): Any?
+open fun getControl(key: KProperty1<K, *>): FormControl?
open fun getData(): K
open fun getDataJson(): Json
protected open fun getSnClass(): List<StringBoolPair>
-open fun remove(key: String): FormPanel<K>
+open fun remove(key: KProperty1<K, *>): FormPanel<K>
open fun removeAll(): FormPanel<K>
protected open fun render(): VNode
open fun setData(model: K): Unit
@@ -1430,6 +1437,22 @@ +open class Icon : Tag
+ open class Image : Widget
+open class Icon : Tag
+ open class Image : Widget