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 --- .../-tab-panel/-init-.html | 21 +++ .../-tab-panel/active-index.html | 15 ++ .../-tab-panel/add-all.html | 21 +++ .../-tab-panel/add-tab.html | 28 ++++ api/pl.treksoft.kvision.panel/-tab-panel/add.html | 21 +++ .../-tab-panel/index.html | 155 +++++++++++++++++++++ .../-tab-panel/remove-all.html | 18 +++ .../-tab-panel/remove-tab.html | 15 ++ .../-tab-panel/remove.html | 21 +++ .../-tab-panel/tab-panel.html | 16 +++ 10 files changed, 331 insertions(+) create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/-init-.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/active-index.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/add-all.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/add.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/index.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/remove-all.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/remove-tab.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/remove.html create mode 100644 api/pl.treksoft.kvision.panel/-tab-panel/tab-panel.html (limited to 'api/pl.treksoft.kvision.panel/-tab-panel') diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html b/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html new file mode 100644 index 00000000..c581a361 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/-init-.html @@ -0,0 +1,21 @@ + + + +TabPanel.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / <init>
+
+

<init>

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

Parameters

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html b/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html new file mode 100644 index 00000000..01be57ab --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/active-index.html @@ -0,0 +1,15 @@ + + + +TabPanel.activeIndex - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / activeIndex
+
+

activeIndex

+ +var activeIndex: Int +

The index of active (visible) tab.

+ + diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html b/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html new file mode 100644 index 00000000..73a08956 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add-all.html @@ -0,0 +1,21 @@ + + + +TabPanel.addAll - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / addAll
+
+

addAll

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

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/-tab-panel/add-tab.html b/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html new file mode 100644 index 00000000..994ff44e --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add-tab.html @@ -0,0 +1,28 @@ + + + +TabPanel.addTab - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / addTab
+
+

addTab

+ +

open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, route: String? = null): TabPanel

Adds new tab and optionally bounds it's activation to a given route.

Parameters

+title - title of the tab

+panel - child component

+icon - icon of the tab

+image - image of the tab

+route - JavaScript route to activate given child

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/add.html b/api/pl.treksoft.kvision.panel/-tab-panel/add.html new file mode 100644 index 00000000..21369b50 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/add.html @@ -0,0 +1,21 @@ + + + +TabPanel.add - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / add
+
+

add

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

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/-tab-panel/index.html b/api/pl.treksoft.kvision.panel/-tab-panel/index.html new file mode 100644 index 00000000..e460c144 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/index.html @@ -0,0 +1,155 @@ + + + +TabPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel
+
+

TabPanel

+open class TabPanel : SimplePanel +

The container rendering it's children as tabs.

It supports activating children by a JavaScript route.

Constructors

+ + + + + + + +

<init>

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

Properties

+ + + + + + + +

activeIndex

+var activeIndex: Int +

The index of active (visible) tab.

Functions

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

+ add +	+`open fun add(child: Component): TabPanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): TabPanel` + Adds a list of components to the current container. +
+ addTab +	+`open fun addTab(title: String, panel: Component, icon: String? = null, image: ResString? = null, route: String? = null): TabPanel` + Adds new tab and optionally bounds it's activation to a given route. +
+ remove +	+`open fun remove(child: Component): TabPanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): TabPanel` + Removes all children from the current container. +
+ removeTab +	+`open fun removeTab(index: Int): TabPanel` + Removes tab at given index. +

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

+ + + + + + + +

tabPanel

+fun Container.tabPanel(classes: Set<String> = setOf(), init: TabPanel.() -> Unit = null): TabPanel +

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/remove-all.html b/api/pl.treksoft.kvision.panel/-tab-panel/remove-all.html new file mode 100644 index 00000000..24cc98db --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/remove-all.html @@ -0,0 +1,18 @@ + + + +TabPanel.removeAll - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / removeAll
+
+

removeAll

+ +open fun removeAll(): TabPanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.panel/-tab-panel/remove-tab.html b/api/pl.treksoft.kvision.panel/-tab-panel/remove-tab.html new file mode 100644 index 00000000..2ef88c03 --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/remove-tab.html @@ -0,0 +1,15 @@ + + + +TabPanel.removeTab - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / removeTab
+
+

removeTab

+ +open fun removeTab(index: Int): TabPanel +

Removes tab at given index.

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

remove

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

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/-tab-panel/tab-panel.html b/api/pl.treksoft.kvision.panel/-tab-panel/tab-panel.html new file mode 100644 index 00000000..fa3d041c --- /dev/null +++ b/api/pl.treksoft.kvision.panel/-tab-panel/tab-panel.html @@ -0,0 +1,16 @@ + + + +TabPanel.tabPanel - kvision + + + +kvision / pl.treksoft.kvision.panel / TabPanel / tabPanel
+
+

tabPanel

+ +fun Container.tabPanel(classes: Set<String> = setOf(), init: TabPanel.() -> Unit = null): TabPanel +

DSL builder extension function.

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

+ + -- cgit