From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../pl.treksoft.kvision.panel/-root/-init-.html | 22 ++++ .../-root/get-sn-class.html | 18 ++++ .../api/pl.treksoft.kvision.panel/-root/index.html | 120 +++++++++++++++++++++ .../pl.treksoft.kvision.panel/-root/render.html | 18 ++++ 4 files changed, 178 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.panel/-root/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.panel/-root/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.panel/-root/index.html create mode 100644 docs/api/pl.treksoft.kvision.panel/-root/render.html (limited to 'docs/api/pl.treksoft.kvision.panel/-root') diff --git a/docs/api/pl.treksoft.kvision.panel/-root/-init-.html b/docs/api/pl.treksoft.kvision.panel/-root/-init-.html new file mode 100644 index 00000000..bdefb012 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-root/-init-.html @@ -0,0 +1,22 @@ + + + +Root.<init> - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / <init>
+
+

<init>

+ +Root(id: String, fixed: Boolean = false) +

Parameters

+id - ID attribute of element in the main HTML file

+fixed - if false, the container is rendered with Bootstrap "container-fluid" class, +otherwise it's rendered with "container" class (default is false)

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.panel/-root/get-sn-class.html b/docs/api/pl.treksoft.kvision.panel/-root/get-sn-class.html new file mode 100644 index 00000000..ba9cf8eb --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-root/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Root.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / getSnClass
+
+

getSnClass

+ +protected fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
+list of CSS class names

+ + diff --git a/docs/api/pl.treksoft.kvision.panel/-root/index.html b/docs/api/pl.treksoft.kvision.panel/-root/index.html new file mode 100644 index 00000000..72570a47 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-root/index.html @@ -0,0 +1,120 @@ + + + +Root - kvision + + + +kvision / pl.treksoft.kvision.panel / Root
+
+

Root

+class Root : SimplePanel +

Root container.

This container is bound to the specific element in the main HTML file of the project. +It is always the root of components tree and it is responsible for rendering and updating +Snabbdom virtual DOM.

Constructors

+ + + + + + + +

<init>

+Root(id: String, fixed: Boolean = false)

Functions

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

+ getSnClass +	+`fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ render +	+`fun render(): VNode` + Renders current component as a Snabbdom vnode. +

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. +
+ 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. +
+ 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. +

+ + diff --git a/docs/api/pl.treksoft.kvision.panel/-root/render.html b/docs/api/pl.treksoft.kvision.panel/-root/render.html new file mode 100644 index 00000000..f5a2f85a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-root/render.html @@ -0,0 +1,18 @@ + + + +Root.render - kvision + + + +kvision / pl.treksoft.kvision.panel / Root / render
+
+

render

+ +protected fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + -- cgit