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.form.select/-select-opt-group/index.html | |
| 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.form.select/-select-opt-group/index.html')
| -rw-r--r-- | docs/api/pl.treksoft.kvision.form.select/-select-opt-group/index.html | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-opt-group/index.html b/docs/api/pl.treksoft.kvision.form.select/-select-opt-group/index.html new file mode 100644 index 00000000..f3a5bc45 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-opt-group/index.html @@ -0,0 +1,160 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SelectOptGroup - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.select</a> / <a href="./index.html">SelectOptGroup</a><br/> +<br/> +<h1>SelectOptGroup</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SelectOptGroup</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>The helper container for adding option groups to <a href="../-select/index.html">Select</a>.</p> +<p>The option group can be populated directly from <em>options</em> parameter or manually by adding +<a href="../-select-option/index.html">SelectOption</a> components to the container.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">SelectOptGroup</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.select.SelectOptGroup$<init>(kotlin.String, kotlin.collections.List((kotlin.Pair((kotlin.String, )))), kotlin.Int, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/label">label</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="identifier" id="pl.treksoft.kvision.form.select.SelectOptGroup$<init>(kotlin.String, kotlin.collections.List((kotlin.Pair((kotlin.String, )))), kotlin.Int, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/options">options</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.select.SelectOptGroup$<init>(kotlin.String, kotlin.collections.List((kotlin.Pair((kotlin.String, )))), kotlin.Int, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/maxOptions">maxOptions</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.select.SelectOptGroup$<init>(kotlin.String, kotlin.collections.List((kotlin.Pair((kotlin.String, )))), kotlin.Int, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/disabled">disabled</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.form.select.SelectOptGroup$<init>(kotlin.String, kotlin.collections.List((kotlin.Pair((kotlin.String, )))), kotlin.Int, 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="disabled.html">disabled</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">disabled</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> +<p>Determines if the group is disabled.</p> +</td> +</tr> +<tr> +<td> +<p><a href="label.html">label</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">label</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>A label for the group.</p> +</td> +</tr> +<tr> +<td> +<p><a href="max-options.html">maxOptions</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">maxOptions</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span></code> +<p>Maximal number of selected options in the group.</p> +</td> +</tr> +<tr> +<td> +<p><a href="options.html">options</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">options</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>A list of options (label to value pairs) for the group.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-sn-attrs.html">getSnAttrs</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnAttrs</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-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> +<p>Returns list of element attributes 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">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> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-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="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code> +<p>Removes all children from the current container.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |