diff options
author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
---|---|---|
committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.panel/-root | |
parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.panel/-root')
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/-init-.html | 24 | ||||
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/get-root.html | 14 | ||||
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/get-sn-class.html | 18 | ||||
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/index.html | 153 | ||||
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/is-first-root.html | 14 | ||||
-rw-r--r-- | api1/pl.treksoft.kvision.panel/-root/render.html | 18 |
6 files changed, 241 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.panel/-root/-init-.html b/api1/pl.treksoft.kvision.panel/-root/-init-.html new file mode 100644 index 00000000..783c11cd --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/-init-.html @@ -0,0 +1,24 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="index.html">Root</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))"></a> +<code><span class="identifier">Root</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/id">id</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/element">element</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/fixed">fixed</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="symbol">(</span><a href="index.html"><span class="identifier">Root</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code> +<h3>Parameters</h3> +<p><a name="id"></a> +<code>id</code> - ID attribute of element in the main HTML file</p> +<p><a name="fixed"></a> +<code>fixed</code> - if false, the container is rendered with Bootstrap "container-fluid" class, +otherwise it's rendered with "container" class (default is false)</p> +<p><a name="init"></a> +<code>init</code> - an initializer extension function</p> +<p><strong>Constructor</strong><br/> +</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.panel/-root/get-root.html b/api1/pl.treksoft.kvision.panel/-root/get-root.html new file mode 100644 index 00000000..9667c2dd --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/get-root.html @@ -0,0 +1,14 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root.getRoot - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="index.html">Root</a> / <a href="./get-root.html">getRoot</a><br/> +<br/> +<h1>getRoot</h1> +<a name="pl.treksoft.kvision.panel.Root$getRoot()"></a> +<code><span class="keyword">fun </span><span class="identifier">getRoot</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Root</span></a><span class="symbol">?</span></code> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html b/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html new file mode 100644 index 00000000..ba9cf8eb --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/get-sn-class.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root.getSnClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="index.html">Root</a> / <a href="./get-sn-class.html">getSnClass</a><br/> +<br/> +<h1>getSnClass</h1> +<a name="pl.treksoft.kvision.panel.Root$getSnClass()"></a> +<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> +<p>Overrides <a href="../../pl.treksoft.kvision.core/-widget/get-sn-class.html">Widget.getSnClass</a></p> +<p>Returns list of CSS class names for current widget in the form of a List.</p> +<p><strong>Return</strong><br/> +list of CSS class names</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.panel/-root/index.html b/api1/pl.treksoft.kvision.panel/-root/index.html new file mode 100644 index 00000000..99089a94 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/index.html @@ -0,0 +1,153 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="./index.html">Root</a><br/> +<br/> +<h1>Root</h1> +<code><span class="keyword">class </span><span class="identifier">Root</span> <span class="symbol">:</span> <a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Root container.</p> +<p>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.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Root</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/id">id</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/element">element</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/fixed">fixed</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a> <span class="symbol">=</span> false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.Root$<init>(kotlin.String, , kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.panel.Root, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="symbol">(</span><a href="./index.html"><span class="identifier">Root</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code></td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="is-first-root.html">isFirstRoot</a></p> +</td> +<td> +<code><span class="keyword">val </span><span class="identifier">isFirstRoot</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code></td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-root.html">getRoot</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">getRoot</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Root</span></a><span class="symbol">?</span></code></td> +</tr> +<tr> +<td> +<p><a href="get-sn-class.html">getSnClass</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">getSnClass</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">></span></code> +<p>Returns list of CSS class names for current widget in the form of a List.</p> +</td> +</tr> +<tr> +<td> +<p><a href="render.html">render</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> +<p>Renders current component as a Snabbdom vnode.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-simple-panel/add.html">add</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">add</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$add(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Adds given component to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/add-all.html">addAll</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addAll</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$addAll(kotlin.collections.List((pl.treksoft.kvision.core.Component)))/children">children</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Adds a list of components to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/add-internal.html">addInternal</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">addInternal</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$addInternal(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Protected and final method to add given component to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/children-v-nodes.html">childrenVNodes</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">childrenVNodes</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol"><</span><span class="identifier">VNode</span><span class="symbol">></span></code> +<p>Returns the array of the children Snabbdom vnodes.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/get-children.html">getChildren</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getChildren</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">></span></code> +<p>Returns a list of children of the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/remove.html">remove</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">remove</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$remove(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Removes given component from the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-simple-panel/remove-all.html">removeAll</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeAll</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Removes all children from the current container.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.panel/-root/is-first-root.html b/api1/pl.treksoft.kvision.panel/-root/is-first-root.html new file mode 100644 index 00000000..6974d7f8 --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/is-first-root.html @@ -0,0 +1,14 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root.isFirstRoot - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="index.html">Root</a> / <a href="./is-first-root.html">isFirstRoot</a><br/> +<br/> +<h1>isFirstRoot</h1> +<a name="pl.treksoft.kvision.panel.Root$isFirstRoot"></a> +<code><span class="keyword">val </span><span class="identifier">isFirstRoot</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.panel/-root/render.html b/api1/pl.treksoft.kvision.panel/-root/render.html new file mode 100644 index 00000000..f5a2f85a --- /dev/null +++ b/api1/pl.treksoft.kvision.panel/-root/render.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Root.render - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.panel</a> / <a href="index.html">Root</a> / <a href="./render.html">render</a><br/> +<br/> +<h1>render</h1> +<a name="pl.treksoft.kvision.panel.Root$render()"></a> +<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">VNode</span></code> +<p>Overrides <a href="../-simple-panel/render.html">SimplePanel.render</a></p> +<p>Renders current component as a Snabbdom vnode.</p> +<p><strong>Return</strong><br/> +Snabbdom vnode</p> +</BODY> +</HTML> |