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 --- .../-split-panel/-init-.html | 23 ++++ .../-split-panel/children-v-nodes.html | 18 +++ .../-split-panel/index.html | 124 +++++++++++++++++++++ .../-split-panel/split-panel.html | 16 +++ 4 files changed, 181 insertions(+) create mode 100644 api/pl.treksoft.kvision.panel/-split-panel/-init-.html create mode 100644 api/pl.treksoft.kvision.panel/-split-panel/children-v-nodes.html create mode 100644 api/pl.treksoft.kvision.panel/-split-panel/index.html create mode 100644 api/pl.treksoft.kvision.panel/-split-panel/split-panel.html (limited to 'api/pl.treksoft.kvision.panel/-split-panel') diff --git a/api/pl.treksoft.kvision.panel/-split-panel/-init-.html b/api/pl.treksoft.kvision.panel/-split-panel/-init-.html new file mode 100644 index 00000000..af9de50e --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-split-panel/-init-.html @@ -0,0 +1,23 @@ + + + +SplitPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / SplitPanel / <init>
+
+

<init>

+ +

SplitPanel(direction: Direction = Direction.VERTICAL, classes: Set<String> = setOf(), init: SplitPanel.() -> Unit = null)

Parameters

+direction - direction of the splitter

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.panel/-split-panel/children-v-nodes.html b/api/pl.treksoft.kvision.panel/-split-panel/children-v-nodes.html new file mode 100644 index 00000000..8f683d11 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-split-panel/children-v-nodes.html @@ -0,0 +1,18 @@ + + + +SplitPanel.childrenVNodes - kvision + + + +kvision / pl.treksoft.kvision.panel / SplitPanel / 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/-split-panel/index.html b/api/pl.treksoft.kvision.panel/-split-panel/index.html new file mode 100644 index 00000000..89d1c07b --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-split-panel/index.html @@ -0,0 +1,124 @@ + + + +SplitPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / SplitPanel
+
+

SplitPanel

+open class SplitPanel : SimplePanel +

The container with draggable splitter.

It is required to have exactly two children, for both sides of the splitter. Otherwise it will be +rendered as empty.

Constructors

+ + + + + + + +

<init>

SplitPanel(direction: Direction = Direction.VERTICAL, classes: Set<String> = setOf(), init: SplitPanel.() -> Unit = null)

Functions

+ + + + + + + +

childrenVNodes

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

Returns the array of the children Snabbdom vnodes.

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. +
+ 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. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

splitPanel

fun Container.splitPanel(direction: Direction = Direction.VERTICAL, classes: Set<String> = setOf(), init: SplitPanel.() -> Unit = null): SplitPanel

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.panel/-split-panel/split-panel.html b/api/pl.treksoft.kvision.panel/-split-panel/split-panel.html new file mode 100644 index 00000000..6c964beb --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-split-panel/split-panel.html @@ -0,0 +1,16 @@ + + + +SplitPanel.splitPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / SplitPanel / splitPanel
+
+

splitPanel

+ +

fun Container.splitPanel(direction: Direction = Direction.VERTICAL, classes: Set<String> = setOf(), init: SplitPanel.() -> Unit = null): SplitPanel

DSL builder extension function.

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

+ + -- cgit