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.check/-check-input | |
| 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.check/-check-input')
15 files changed, 595 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html new file mode 100644 index 00000000..bc452be0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/-init-.html @@ -0,0 +1,23 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))"></a> +<code><span class="identifier">CheckInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/type">type</span><span class="symbol">:</span> <a href="../-c-h-e-c-k-i-n-p-u-t-t-y-p-e/index.html"><span class="identifier">CHECKINPUTTYPE</span></a> <span class="symbol">=</span> CHECKINPUTTYPE.CHECKBOX<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/value">value</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.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, 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="type"></a> +<code>type</code> - type of the input control</p> +<p><a name="value"></a> +<code>value</code> - selection state</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.form.check/-check-input/after-insert.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html new file mode 100644 index 00000000..6767622a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-insert.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.afterInsert - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./after-insert.html">afterInsert</a><br/> +<br/> +<h1>afterInsert</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$afterInsert(com.github.snabbdom.VNode)"></a> +<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterInsert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$afterInsert(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Overrides <a href="../../pl.treksoft.kvision.core/-widget/after-insert.html">Widget.afterInsert</a></p> +<p>Method called after inserting Snabbdom vnode into the DOM.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html new file mode 100644 index 00000000..e5033ca8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.afterPostpatch - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./after-postpatch.html">afterPostpatch</a><br/> +<br/> +<h1>afterPostpatch</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$afterPostpatch(com.github.snabbdom.VNode)"></a> +<code><span class="keyword">protected</span> <span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterPostpatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$afterPostpatch(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Overrides <a href="../../pl.treksoft.kvision.core/-widget/after-postpatch.html">Widget.afterPostpatch</a></p> +<p>Method called after updating Snabbdom vnode.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html new file mode 100644 index 00000000..9a839220 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/disabled.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.disabled - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./disabled.html">disabled</a><br/> +<br/> +<h1>disabled</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$disabled"></a> +<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 field is disabled.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html new file mode 100644 index 00000000..d1c95624 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/extra-value.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.extraValue - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./extra-value.html">extraValue</a><br/> +<br/> +<h1>extraValue</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$extraValue"></a> +<code><span class="keyword">var </span><span class="identifier">extraValue</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></code> +<p>The additional String value used for the radio button group.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html new file mode 100644 index 00000000..01b63bf4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.getSnAttrs - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./get-sn-attrs.html">getSnAttrs</a><br/> +<br/> +<h1>getSnAttrs</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$getSnAttrs()"></a> +<code><span class="keyword">protected</span> <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>Overrides <a href="../../pl.treksoft.kvision.core/-widget/get-sn-attrs.html">Widget.getSnAttrs</a></p> +<p>Returns list of element attributes in the form of a List.</p> +<p><strong>Return</strong><br/> +list of element attributes</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html new file mode 100644 index 00000000..ad4a5a60 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.getSnClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./get-sn-class.html">getSnClass</a><br/> +<br/> +<h1>getSnClass</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$getSnClass()"></a> +<code><span class="keyword">protected</span> <span class="keyword">open</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/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html new file mode 100644 index 00000000..5f486534 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/index.html @@ -0,0 +1,364 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="./index.html">CheckInput</a><br/> +<br/> +<h1>CheckInput</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CheckInput</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>The basic input component rendered as HTML <em>input type="checkbox"</em> or <em>input type="radio"</em>.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">CheckInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/type">type</span><span class="symbol">:</span> <a href="../-c-h-e-c-k-i-n-p-u-t-t-y-p-e/index.html"><span class="identifier">CHECKINPUTTYPE</span></a> <span class="symbol">=</span> CHECKINPUTTYPE.CHECKBOX<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/value">value</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.check.CheckInput$<init>(pl.treksoft.kvision.form.check.CHECKINPUTTYPE, 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 field is disabled.</p> +</td> +</tr> +<tr> +<td> +<p><a href="extra-value.html">extraValue</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">extraValue</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></code> +<p>The additional String value used for the radio button group.</p> +</td> +</tr> +<tr> +<td> +<p><a href="name.html">name</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">name</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></code> +<p>The name attribute of the generated HTML input element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="size.html">size</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">size</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.form/-i-n-p-u-t-s-i-z-e/index.html"><span class="identifier">INPUTSIZE</span></a><span class="symbol">?</span></code> +<p>The size of the input.</p> +</td> +</tr> +<tr> +<td> +<p><a href="start-value.html">startValue</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">startValue</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>The value attribute of the generated HTML input element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="type.html">type</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../-c-h-e-c-k-i-n-p-u-t-t-y-p-e/index.html"><span class="identifier">CHECKINPUTTYPE</span></a></code> +<p>The type of the generated HTML input element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="value.html">value</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">value</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>The selection state of the input.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/id.html">id</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">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></code> +<p>An ID attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/parent.html">parent</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">parent</span><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>Parent of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/role.html">role</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">role</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></code> +<p>A role attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/title.html">title</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">title</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></code> +<p>A title attribute of generated HTML element.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/visible.html">visible</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">visible</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>Visibility state of the current component.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="after-insert.html">afterInsert</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterInsert</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$afterInsert(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Method called after inserting Snabbdom vnode into the DOM.</p> +</td> +</tr> +<tr> +<td> +<p><a href="after-postpatch.html">afterPostpatch</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterPostpatch</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$afterPostpatch(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Method called after updating Snabbdom vnode.</p> +</td> +</tr> +<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="get-sn-class.html">getSnClass</a></p> +</td> +<td> +<code><span class="keyword">open</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>Returns list of CSS class names for current widget in the form of a List.</p> +</td> +</tr> +<tr> +<td> +<p><a href="on-click.html">onClick</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">onClick</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$onClick(kotlin.Function2((pl.treksoft.kvision.form.check.CheckInput, org.w3c.dom.events.MouseEvent, kotlin.Unit)))/handler">handler</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">CheckInput</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><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><a href="./index.html"><span class="identifier">CheckInput</span></a></code> +<p>A convenient helper for easy setting onClick event handler.</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.core/-widget/add-css-class.html">addCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addCssClass(kotlin.String)/css">css</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="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Adds given value to the set of CSS classes generated in html code of current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html">addSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$addSurroundingCssClass(kotlin.String)/css">css</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="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Adds given value to the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-create.html">afterCreate</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterCreate</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$afterCreate(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span> <span class="identifier">VNode</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></code> +<p>Method called after creating Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/after-destroy.html">afterDestroy</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">afterDestroy</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></code> +<p>Method called after destroying Snabbdom vnode.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element.html">getElement</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElement</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html"><span class="identifier">Node</span></a><span class="symbol">?</span></code> +<p>Returns DOM element bound to the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query.html">getElementJQuery</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQuery</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">JQuery</span><span class="symbol">?</span></code> +<p>Returns JQuery element bound to the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-element-j-query-d.html">getElementJQueryD</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getElementJQueryD</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="keyword">dynamic</span></code> +<p>Returns JQuery element bound to the current component as a <em>dynamic</em> type.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-hooks.html">getSnHooks</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnHooks</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Hooks</span><span class="symbol">?</span></code> +<p>Returns list of hooks in the form of a Snabbdom <em>Hooks</em> object.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/get-sn-on.html">getSnOn</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnOn</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">On</span><span class="symbol">?</span></code> +<p>Returns list of event handlers in the form of a Snabbdom <em>On</em> object.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/hide.html">hide</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">hide</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Makes current widget invisible.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-css-class.html">removeCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeCssClass(kotlin.String)/css">css</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="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes given value from the set of CSS classes generated in html code of current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-event-listeners.html">removeEventListeners</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeEventListeners</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes all event listeners from current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html">removeSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$removeSurroundingCssClass(kotlin.String)/css">css</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="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Removes given value from the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/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="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String)/elementName">elementName</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><span class="identifier">VNode</span></code><br/> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">render</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/elementName">elementName</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.core.Widget$render(kotlin.String, kotlin.Array((kotlin.Any)))/children">children</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="keyword">dynamic</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> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html">setEventListener</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></span> <span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget.setEventListener.T)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/set-event-listener.html#T"><span class="identifier">T</span></a><span class="symbol">></span><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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Sets an event listener for current widget, keeping the actual type of component.</p> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setEventListener</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.core.Widget)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">></span><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><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Sets an event listener for current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/show.html">show</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">show</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Makes current widget visible.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/toggle-visible.html">toggleVisible</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toggleVisible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a></code> +<p>Toggles visibility of current widget.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html new file mode 100644 index 00000000..4000cbea --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/name.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.name - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./name.html">name</a><br/> +<br/> +<h1>name</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$name"></a> +<code><span class="keyword">var </span><span class="identifier">name</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></code> +<p>The name attribute of the generated HTML input element.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html new file mode 100644 index 00000000..66f9330a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/on-click.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.onClick - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./on-click.html">onClick</a><br/> +<br/> +<h1>onClick</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$onClick(kotlin.Function2((pl.treksoft.kvision.form.check.CheckInput, org.w3c.dom.events.MouseEvent, kotlin.Unit)))"></a> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">onClick</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckInput$onClick(kotlin.Function2((pl.treksoft.kvision.form.check.CheckInput, org.w3c.dom.events.MouseEvent, kotlin.Unit)))/handler">handler</span><span class="symbol">:</span> <a href="index.html"><span class="identifier">CheckInput</span></a><span class="symbol">.</span><span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom.events/-mouse-event/index.html"><span class="identifier">MouseEvent</span></a><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><a href="index.html"><span class="identifier">CheckInput</span></a></code> +<p>A convenient helper for easy setting onClick event handler.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html new file mode 100644 index 00000000..f5a8b24f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/render.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.render - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./render.html">render</a><br/> +<br/> +<h1>render</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$render()"></a> +<code><span class="keyword">protected</span> <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>Overrides <a href="../../pl.treksoft.kvision.core/-widget/render.html">Widget.render</a></p> +<p>Renders current component as a Snabbdom vnode.</p> +<p><strong>Return</strong><br/> +Snabbdom vnode</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html new file mode 100644 index 00000000..fc447db2 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/size.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.size - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./size.html">size</a><br/> +<br/> +<h1>size</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$size"></a> +<code><span class="keyword">var </span><span class="identifier">size</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.form/-i-n-p-u-t-s-i-z-e/index.html"><span class="identifier">INPUTSIZE</span></a><span class="symbol">?</span></code> +<p>The size of the input.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html new file mode 100644 index 00000000..9789c839 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/start-value.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.startValue - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./start-value.html">startValue</a><br/> +<br/> +<h1>startValue</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$startValue"></a> +<code><span class="keyword">var </span><span class="identifier">startValue</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>The value attribute of the generated HTML input element.</p> +<p>This value is placed directly in generated HTML code, while the <a href="value.html">value</a> property is dynamically +bound to the input selection state.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html new file mode 100644 index 00000000..cad626e5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/type.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.type - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./type.html">type</a><br/> +<br/> +<h1>type</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$type"></a> +<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../-c-h-e-c-k-i-n-p-u-t-t-y-p-e/index.html"><span class="identifier">CHECKINPUTTYPE</span></a></code> +<p>The type of the generated HTML input element.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html new file mode 100644 index 00000000..75d9a706 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-check-input/value.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CheckInput.value - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.check</a> / <a href="index.html">CheckInput</a> / <a href="./value.html">value</a><br/> +<br/> +<h1>value</h1> +<a name="pl.treksoft.kvision.form.check.CheckInput$value"></a> +<code><span class="keyword">var </span><span class="identifier">value</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>The selection state of the input.</p> +</BODY> +</HTML> |