From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-stack-panel/-init-.html | 23 ++++ .../-stack-panel/active-child.html | 15 +++ .../-stack-panel/active-index.html | 21 +++ .../-stack-panel/add-all.html | 21 +++ .../-stack-panel/add.html | 31 +++++ .../-stack-panel/children-v-nodes.html | 18 +++ .../-stack-panel/index.html | 148 +++++++++++++++++++++ .../-stack-panel/remove-all.html | 18 +++ .../-stack-panel/remove.html | 21 +++ .../-stack-panel/stack-panel.html | 16 +++ 10 files changed, 332 insertions(+) create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/-init-.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/active-child.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/active-index.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/add-all.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/add.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/index.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/remove.html create mode 100644 api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html (limited to 'api/pl.treksoft.kvision.panel/-stack-panel') diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html b/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html new file mode 100644 index 00000000..3048853c --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html @@ -0,0 +1,23 @@ + + + +StackPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / <init>
+
+

<init>

+ +StackPanel(activateLast: Boolean = true, classes: Set<String> = setOf(), init: StackPanel.() -> Unit = null) +

Parameters

+activateLast - determines if added component is automatically activated (default true)

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/active-child.html b/api/pl.treksoft.kvision.panel/-stack-panel/active-child.html new file mode 100644 index 00000000..98080aa2 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/active-child.html @@ -0,0 +1,15 @@ + + + +StackPanel.activeChild - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / activeChild
+
+

activeChild

+ +var activeChild: Component +

The active (visible) child.

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html b/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html new file mode 100644 index 00000000..2bffc4bf --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html @@ -0,0 +1,21 @@ + + + +StackPanel.activeIndex - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / activeIndex
+
+

activeIndex

+ +var activeIndex: Int +

The index of active (visible) child.

Getter
+

The index of active (visible) child.

Setter
+

The index of active (visible) child.

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html b/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html new file mode 100644 index 00000000..68dd599c --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html @@ -0,0 +1,21 @@ + + + +StackPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): StackPanel +

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/add.html b/api/pl.treksoft.kvision.panel/-stack-panel/add.html new file mode 100644 index 00000000..64c9b308 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/add.html @@ -0,0 +1,31 @@ + + + +StackPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / add
+
+

add

+ +open fun add(panel: Component, route: String): StackPanel +

Adds given component and bounds it's activation to a given route.

Parameters

+panel - child component

+route - JavaScript route to activate given child

Return
+current container

+ +open fun add(child: Component): StackPanel +

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html b/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html new file mode 100644 index 00000000..dd6b54f9 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html @@ -0,0 +1,18 @@ + + + +StackPanel.childrenVNodes - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / childrenVNodes
+
+

childrenVNodes

+ +protected open fun childrenVNodes(): Array<VNode> +

Overrides SimplePanel.childrenVNodes

Returns the array of the children Snabbdom vnodes.

Return
+array of children vnodes

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/index.html b/api/pl.treksoft.kvision.panel/-stack-panel/index.html new file mode 100644 index 00000000..3de189fd --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/index.html @@ -0,0 +1,148 @@ + + + +StackPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel
+
+

StackPanel

+open class StackPanel : SimplePanel +

The container with only one active (visible) child at any moment.

It supports activating children by a JavaScript route.

Constructors

+ + + + + + + +

<init>

+StackPanel(activateLast: Boolean = true, classes: Set<String> = setOf(), init: StackPanel.() -> Unit = null)

Properties

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

+ activeChild +	+`var activeChild: Component` + The active (visible) child. +
+ activeIndex +	+`var activeIndex: Int` + The index of active (visible) child. +

Functions

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

+ add +	+`open fun add(panel: Component, route: String): StackPanel` + Adds given component and bounds it's activation to a given route. +`open fun add(child: Component): StackPanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): StackPanel` + Adds a list of components to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ remove +	+`open fun remove(child: Component): StackPanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): StackPanel` + Removes all children from the current container. +

Inherited Functions

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

+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

stackPanel

fun Container.stackPanel(activateLast: Boolean = true, classes: Set<String> = setOf(), init: StackPanel.() -> Unit = null): StackPanel

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html b/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html new file mode 100644 index 00000000..4e6736c6 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +StackPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): StackPanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/remove.html b/api/pl.treksoft.kvision.panel/-stack-panel/remove.html new file mode 100644 index 00000000..c1d87b4d --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/remove.html @@ -0,0 +1,21 @@ + + + +StackPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / remove
+
+

remove

+ +open fun remove(child: Component): StackPanel +

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html b/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html new file mode 100644 index 00000000..f2c463d8 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html @@ -0,0 +1,16 @@ + + + +StackPanel.stackPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / StackPanel / stackPanel
+
+

stackPanel

+ +

fun Container.stackPanel(activateLast: Boolean = true, classes: Set<String> = setOf(), init: StackPanel.() -> Unit = null): StackPanel

DSL builder extension function.

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

+ + -- cgit