From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-data-container/-init-.html | 40 ++ .../-data-container/add-all.html | 21 + .../-data-container/add.html | 21 + .../-data-container/clear-on-update.html | 17 + .../-data-container/data-container.html | 20 + .../-data-container/get-children.html | 18 + .../-data-container/index.html | 621 +++++++++++++++++++++ .../-data-container/on-update.html | 20 + .../-data-container/remove-all.html | 18 + .../-data-container/remove.html | 21 + .../-data-container/update.html | 16 + .../-data-container/visible.html | 17 + 12 files changed, 850 insertions(+) create mode 100644 api1/pl.treksoft.kvision.data/-data-container/-init-.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/add-all.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/add.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/clear-on-update.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/data-container.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/get-children.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/index.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/on-update.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/remove-all.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/remove.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/update.html create mode 100644 api1/pl.treksoft.kvision.data/-data-container/visible.html (limited to 'api1/pl.treksoft.kvision.data/-data-container') diff --git a/api1/pl.treksoft.kvision.data/-data-container/-init-.html b/api1/pl.treksoft.kvision.data/-data-container/-init-.html new file mode 100644 index 00000000..8e9b58d5 --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/-init-.html @@ -0,0 +1,40 @@ + + + +DataContainer.<init> - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / <init>
+
+

<init>

+ +

DataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, CONT>.() -> Unit)? = null)

Creates DataContainer bound to given data model.

Parameters

+M - data model type

+C - visual component type

+CONT - container type

+model - data model of type MutableList

+factory - a function which creates component C from data model at given index

+container - internal container

+containerAdd - function to add component C to the internal container CONT

+filter - a filtering function

+sorter - a sorting function

+sorterType - a sorting type selection function

+init - an initializer extension function

Constructor
+Creates DataContainer bound to given data model.

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/add-all.html b/api1/pl.treksoft.kvision.data/-data-container/add-all.html new file mode 100644 index 00000000..258e9af8 --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/add-all.html @@ -0,0 +1,21 @@ + + + +DataContainer.addAll - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / addAll
+
+

addAll

+ +fun addAll(children: List<Component>): Container +

Overrides Container.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/add.html b/api1/pl.treksoft.kvision.data/-data-container/add.html new file mode 100644 index 00000000..c759e280 --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/add.html @@ -0,0 +1,21 @@ + + + +DataContainer.add - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / add
+
+

add

+ +fun add(child: Component): Container +

Overrides Container.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/clear-on-update.html b/api1/pl.treksoft.kvision.data/-data-container/clear-on-update.html new file mode 100644 index 00000000..f427030a --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/clear-on-update.html @@ -0,0 +1,17 @@ + + + +DataContainer.clearOnUpdate - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / clearOnUpdate
+
+

clearOnUpdate

+ +fun clearOnUpdate(): DataContainer<M, C, CONT> +

Clears notification handler.

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/data-container.html b/api1/pl.treksoft.kvision.data/-data-container/data-container.html new file mode 100644 index 00000000..a048354f --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/data-container.html @@ -0,0 +1,20 @@ + + + +DataContainer.dataContainer - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / dataContainer
+
+

dataContainer

+ +

fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, CONT>.() -> Unit)? = null): DataContainer<M, C, CONT>

DSL builder extension function.

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

+ +

fun <M, C : Component> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, containerAdd: (VPanel.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, VPanel>.() -> Unit)? = null): DataContainer<M, C, VPanel>

DSL builder extension function with VPanel default.

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

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/get-children.html b/api1/pl.treksoft.kvision.data/-data-container/get-children.html new file mode 100644 index 00000000..60d6f289 --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/get-children.html @@ -0,0 +1,18 @@ + + + +DataContainer.getChildren - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer / getChildren
+
+

getChildren

+ +fun getChildren(): List<Component> +

Overrides Container.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api1/pl.treksoft.kvision.data/-data-container/index.html b/api1/pl.treksoft.kvision.data/-data-container/index.html new file mode 100644 index 00000000..c74daa17 --- /dev/null +++ b/api1/pl.treksoft.kvision.data/-data-container/index.html @@ -0,0 +1,621 @@ + + + +DataContainer - kvision + + + +kvision / pl.treksoft.kvision.data / DataContainer
+
+

DataContainer

+class DataContainer<M, C : Component, CONT : Container> : Widget, Container, DataUpdatable +

A container class with support for mutable/observable data model.

Constructors

+ + + + +

<init>

DataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null,