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 --- .../-dock-panel/-init-.html | 21 +++ .../-dock-panel/add-all.html | 21 +++ .../pl.treksoft.kvision.panel/-dock-panel/add.html | 31 +++++ .../-dock-panel/dock-panel.html | 16 +++ .../-dock-panel/index.html | 147 +++++++++++++++++++++ .../-dock-panel/remove-all.html | 18 +++ .../-dock-panel/remove-at.html | 20 +++ .../-dock-panel/remove.html | 21 +++ 8 files changed, 295 insertions(+) create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/-init-.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/add-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/add.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/dock-panel.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/index.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/remove-all.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/remove-at.html create mode 100644 api1/pl.treksoft.kvision.panel/-dock-panel/remove.html (limited to 'api1/pl.treksoft.kvision.panel/-dock-panel') diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/-init-.html b/api1/pl.treksoft.kvision.panel/-dock-panel/-init-.html new file mode 100644 index 00000000..d8f41cd6 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/-init-.html @@ -0,0 +1,21 @@ + + + +DockPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / <init>
+
+

<init>

+ +DockPanel(classes: Set<String> = setOf(), init: (DockPanel.() -> Unit)? = null) +

Parameters

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/add-all.html b/api1/pl.treksoft.kvision.panel/-dock-panel/add-all.html new file mode 100644 index 00000000..5de27e01 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/add-all.html @@ -0,0 +1,21 @@ + + + +DockPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / addAll
+
+

addAll

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

Overrides SimplePanel.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.panel/-dock-panel/add.html b/api1/pl.treksoft.kvision.panel/-dock-panel/add.html new file mode 100644 index 00000000..01e6a4e4 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/add.html @@ -0,0 +1,31 @@ + + + +DockPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / add
+
+

add

+ +open fun add(child: Component, position: Side): DockPanel +

Adds a component to the dock container.

Parameters

+child - child component

+position - position in the dock

Return
+current container

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/dock-panel.html b/api1/pl.treksoft.kvision.panel/-dock-panel/dock-panel.html new file mode 100644 index 00000000..89218668 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/dock-panel.html @@ -0,0 +1,16 @@ + + + +DockPanel.dockPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / dockPanel
+
+

dockPanel

+ +fun Container.dockPanel(classes: Set<String> = setOf(), init: (DockPanel.() -> Unit)? = null): DockPanel +

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/index.html b/api1/pl.treksoft.kvision.panel/-dock-panel/index.html new file mode 100644 index 00000000..04552d68 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/index.html @@ -0,0 +1,147 @@ + + + +DockPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel
+
+

DockPanel

+open class DockPanel : SimplePanel +

The container with dock layout (up, down, left, right and center positions).

Constructors

+ + + + + + + +

<init>

+DockPanel(classes: Set<String> = setOf(), init: (DockPanel.() -> Unit)? = null)

Functions

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

+ add +	+`open fun add(child: Component, position: Side): DockPanel` + Adds a component to the dock container. +`open fun add(child: Component): DockPanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): DockPanel` + Adds a list of components to the current container. +
+ remove +	+`open fun remove(child: Component): DockPanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): DockPanel` + Removes all children from the current container. +
+ removeAt +	+`open fun removeAt(position: Side): DockPanel` + Removes child from given position in the dock. +

Inherited Functions

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

+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ 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

+ + + + + + + +

dockPanel

+fun Container.dockPanel(classes: Set<String> = setOf(), init: (DockPanel.() -> Unit)? = null): DockPanel +

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/remove-all.html b/api1/pl.treksoft.kvision.panel/-dock-panel/remove-all.html new file mode 100644 index 00000000..42174bd5 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +DockPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): DockPanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/remove-at.html b/api1/pl.treksoft.kvision.panel/-dock-panel/remove-at.html new file mode 100644 index 00000000..504fac9b --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/remove-at.html @@ -0,0 +1,20 @@ + + + +DockPanel.removeAt - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / removeAt
+
+

removeAt

+ +open fun removeAt(position: Side): DockPanel +

Removes child from given position in the dock.

Parameters

+position - position in the dock

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.panel/-dock-panel/remove.html b/api1/pl.treksoft.kvision.panel/-dock-panel/remove.html new file mode 100644 index 00000000..3a3976a8 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-dock-panel/remove.html @@ -0,0 +1,21 @@ + + + +DockPanel.remove - kvision + + + +kvision / pl.treksoft.kvision.panel / DockPanel / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + -- cgit