From f3c9d405382dd81d426c7eab1f6390ec8e6dad00 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:45:25 +0100 Subject: Documentation update. --- .../-stack-panel/-init-.html | 23 ---- .../-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 | 139 --------------------- .../-stack-panel/remove-all.html | 18 --- .../-stack-panel/remove.html | 21 ---- .../-stack-panel/stack-panel.html | 16 --- 9 files changed, 308 deletions(-) delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html delete mode 100644 docs/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html (limited to 'docs/api/pl.treksoft.kvision.panel/-stack-panel') diff --git a/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html deleted file mode 100644 index 3048853c..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html +++ /dev/null @@ -1,23 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html deleted file mode 100644 index 2bffc4bf..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html deleted file mode 100644 index 68dd599c..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html deleted file mode 100644 index 64c9b308..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html deleted file mode 100644 index dd6b54f9..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html deleted file mode 100644 index 5c0f7733..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html +++ /dev/null @@ -1,139 +0,0 @@ - - - -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

- - - - - - - -
-

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/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html deleted file mode 100644 index 4e6736c6..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html deleted file mode 100644 index c1d87b4d..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html deleted file mode 100644 index f2c463d8..00000000 --- a/docs/api/pl.treksoft.kvision.panel/-stack-panel/stack-panel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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