diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
| commit | d8cd67062b8de6e8398dc6dfd00d201200c82414 (patch) | |
| tree | 601082ec1eec73bc7a7d6ce8b51352e5345ffe81 /docs/api/pl.treksoft.kvision.panel/-stack-panel | |
| parent | 955304789ea83aceacbdf4c8a9eb742f6c2518f6 (diff) | |
| download | kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.gz kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.bz2 kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.zip | |
API doc and readme
Diffstat (limited to 'docs/api/pl.treksoft.kvision.panel/-stack-panel')
8 files changed, 270 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html new file mode 100644 index 00000000..16a0981f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/-init-.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.<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">StackPanel</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.panel.StackPanel$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)))"></a> +<code><span class="identifier">StackPanel</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.StackPanel$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/activateLast">activateLast</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> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.StackPanel$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><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> setOf()<span class="symbol">)</span></code> +<h3>Parameters</h3> +<p><a name="activateLast"></a> +<code>activateLast</code> - determines if added component is automatically activated (default true)</p> +<p><a name="classes"></a> +<code>classes</code> - a set of CSS class names</p> +<p><strong>Constructor</strong><br/> +</p> +</BODY> +</HTML> 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 new file mode 100644 index 00000000..bd4a56e5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/active-index.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.activeIndex - 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">StackPanel</a> / <a href="./active-index.html">activeIndex</a><br/> +<br/> +<h1>activeIndex</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$activeIndex"></a> +<code><span class="keyword">var </span><span class="identifier">activeIndex</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code> +<p>The index of active (visible) child.</p> +</BODY> +</HTML> 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 new file mode 100644 index 00000000..68dd599c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/add-all.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.addAll - 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">StackPanel</a> / <a href="./add-all.html">addAll</a><br/> +<br/> +<h1>addAll</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$addAll(kotlin.collections.List((pl.treksoft.kvision.core.Component)))"></a> +<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.StackPanel$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="index.html"><span class="identifier">StackPanel</span></a></code> +<p>Overrides <a href="../-simple-panel/add-all.html">SimplePanel.addAll</a></p> +<p>Adds a list of components to the current container.</p> +<h3>Parameters</h3> +<p><a name="children"></a> +<code>children</code> - list of child components</p> +<p><strong>Return</strong><br/> +current container</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html new file mode 100644 index 00000000..64c9b308 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/add.html @@ -0,0 +1,31 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.add - 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">StackPanel</a> / <a href="./add.html">add</a><br/> +<br/> +<h1>add</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$add(pl.treksoft.kvision.core.Component, kotlin.String)"></a> +<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.StackPanel$add(pl.treksoft.kvision.core.Component, kotlin.String)/panel">panel</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="identifier" id="pl.treksoft.kvision.panel.StackPanel$add(pl.treksoft.kvision.core.Component, kotlin.String)/route">route</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><a href="index.html"><span class="identifier">StackPanel</span></a></code> +<p>Adds given component and bounds it's activation to a given route.</p> +<h3>Parameters</h3> +<p><a name="panel"></a> +<code>panel</code> - child component</p> +<p><a name="route"></a> +<code>route</code> - JavaScript route to activate given child</p> +<p><strong>Return</strong><br/> +current container</p> +<a name="pl.treksoft.kvision.panel.StackPanel$add(pl.treksoft.kvision.core.Component)"></a> +<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.StackPanel$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="index.html"><span class="identifier">StackPanel</span></a></code> +<p>Overrides <a href="../-simple-panel/add.html">SimplePanel.add</a></p> +<p>Adds given component to the current container.</p> +<h3>Parameters</h3> +<p><a name="child"></a> +<code>child</code> - child component</p> +<p><strong>Return</strong><br/> +current container</p> +</BODY> +</HTML> 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 new file mode 100644 index 00000000..dd6b54f9 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/children-v-nodes.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.childrenVNodes - 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">StackPanel</a> / <a href="./children-v-nodes.html">childrenVNodes</a><br/> +<br/> +<h1>childrenVNodes</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$childrenVNodes()"></a> +<code><span class="keyword">protected</span> <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>Overrides <a href="../-simple-panel/children-v-nodes.html">SimplePanel.childrenVNodes</a></p> +<p>Returns the array of the children Snabbdom vnodes.</p> +<p><strong>Return</strong><br/> +array of children vnodes</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html new file mode 100644 index 00000000..858201c6 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/index.html @@ -0,0 +1,125 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel - 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">StackPanel</a><br/> +<br/> +<h1>StackPanel</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">StackPanel</span> <span class="symbol">:</span> <a href="../-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>The container with only one active (visible) child at any moment.</p> +<p>It supports activating children by a JavaScript route.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">StackPanel</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.StackPanel$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/activateLast">activateLast</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> true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.panel.StackPanel$<init>(kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/classes">classes</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><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> setOf()<span class="symbol">)</span></code></td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="active-index.html">activeIndex</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">activeIndex</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code> +<p>The index of active (visible) child.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="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.StackPanel$add(pl.treksoft.kvision.core.Component, kotlin.String)/panel">panel</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="identifier" id="pl.treksoft.kvision.panel.StackPanel$add(pl.treksoft.kvision.core.Component, kotlin.String)/route">route</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><a href="./index.html"><span class="identifier">StackPanel</span></a></code> +<p>Adds given component and bounds it's activation to a given route.</p> +<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.StackPanel$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="./index.html"><span class="identifier">StackPanel</span></a></code> +<p>Adds given component to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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.StackPanel$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="./index.html"><span class="identifier">StackPanel</span></a></code> +<p>Adds a list of components to the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="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.StackPanel$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="./index.html"><span class="identifier">StackPanel</span></a></code> +<p>Removes given component from the current container.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="./index.html"><span class="identifier">StackPanel</span></a></code> +<p>Removes all children from the current container.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<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/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/render.html">render</a></p> +</td> +<td> +<code><span class="keyword">open</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>Renders current component as a Snabbdom vnode.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> 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 new file mode 100644 index 00000000..4e6736c6 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove-all.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.removeAll - 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">StackPanel</a> / <a href="./remove-all.html">removeAll</a><br/> +<br/> +<h1>removeAll</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$removeAll()"></a> +<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="index.html"><span class="identifier">StackPanel</span></a></code> +<p>Overrides <a href="../-simple-panel/remove-all.html">SimplePanel.removeAll</a></p> +<p>Removes all children from the current container.</p> +<p><strong>Return</strong><br/> +current container</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html b/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html new file mode 100644 index 00000000..c1d87b4d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.panel/-stack-panel/remove.html @@ -0,0 +1,21 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StackPanel.remove - 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">StackPanel</a> / <a href="./remove.html">remove</a><br/> +<br/> +<h1>remove</h1> +<a name="pl.treksoft.kvision.panel.StackPanel$remove(pl.treksoft.kvision.core.Component)"></a> +<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.StackPanel$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="index.html"><span class="identifier">StackPanel</span></a></code> +<p>Overrides <a href="../-simple-panel/remove.html">SimplePanel.remove</a></p> +<p>Removes given component from the current container.</p> +<h3>Parameters</h3> +<p><a name="child"></a> +<code>child</code> - child component</p> +<p><strong>Return</strong><br/> +current container</p> +</BODY> +</HTML> |