diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-03-05 08:45:25 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-03-05 08:45:26 +0100 |
| commit | f3c9d405382dd81d426c7eab1f6390ec8e6dad00 (patch) | |
| tree | 2913cb1e5818e91119221c93f9a997a3f10a52c0 /docs/api/pl.treksoft.kvision.form.check/-check-box/index.html | |
| parent | 726751c145b33f82e024787fa7aafcc861712712 (diff) | |
| download | kvision-f3c9d405382dd81d426c7eab1f6390ec8e6dad00.tar.gz kvision-f3c9d405382dd81d426c7eab1f6390ec8e6dad00.tar.bz2 kvision-f3c9d405382dd81d426c7eab1f6390ec8e6dad00.zip | |
Documentation update.
Diffstat (limited to 'docs/api/pl.treksoft.kvision.form.check/-check-box/index.html')
| -rw-r--r-- | docs/api/pl.treksoft.kvision.form.check/-check-box/index.html | 309 |
1 files changed, 0 insertions, 309 deletions
diff --git a/docs/api/pl.treksoft.kvision.form.check/-check-box/index.html b/docs/api/pl.treksoft.kvision.form.check/-check-box/index.html deleted file mode 100644 index d145a888..00000000 --- a/docs/api/pl.treksoft.kvision.form.check/-check-box/index.html +++ /dev/null @@ -1,309 +0,0 @@ -<HTML> -<HEAD> -<meta charset="UTF-8"> -<title>CheckBox - 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">CheckBox</a><br/> -<br/> -<h1>CheckBox</h1> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CheckBox</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a><span class="symbol">, </span><a href="../../pl.treksoft.kvision.form/-bool-form-control/index.html"><span class="identifier">BoolFormControl</span></a></code> -<p>The form field component rendered as HTML <em>input type="checkbox"</em>.</p> -<h3>Constructors</h3> -<table> -<tbody> -<tr> -<td> -<p><a href="-init-.html"><init></a></p> -</td> -<td> -<code><span class="identifier">CheckBox</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBox$<init>(kotlin.Boolean, kotlin.String, kotlin.Boolean)/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.CheckBox$<init>(kotlin.Boolean, kotlin.String, kotlin.Boolean)/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="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBox$<init>(kotlin.Boolean, kotlin.String, kotlin.Boolean)/rich">rich</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></code></td> -</tr> -</tbody> -</table> -<h3>Properties</h3> -<table> -<tbody> -<tr> -<td> -<p><a href="circled.html">circled</a></p> -</td> -<td> -<code><span class="keyword">var </span><span class="identifier">circled</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 checkbox is rendered as a circle.</p> -</td> -</tr> -<tr> -<td> -<p><a href="disabled.html">disabled</a></p> -</td> -<td> -<code><span class="keyword">open</span> <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="flabel.html">flabel</a></p> -</td> -<td> -<code><span class="keyword">val </span><span class="identifier">flabel</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.form/-field-label/index.html"><span class="identifier">FieldLabel</span></a></code> -<p>Form field label.</p> -</td> -</tr> -<tr> -<td> -<p><a href="inline.html">inline</a></p> -</td> -<td> -<code><span class="keyword">var </span><span class="identifier">inline</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 checkbox is rendered inline.</p> -</td> -</tr> -<tr> -<td> -<p><a href="input.html">input</a></p> -</td> -<td> -<code><span class="keyword">val </span><span class="identifier">input</span><span class="symbol">: </span><a href="../-check-input/index.html"><span class="identifier">CheckInput</span></a></code> -<p>The actual input component.</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><span class="symbol">?</span></code> -<p>The label text bound to the input element.</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="rich.html">rich</a></p> -</td> -<td> -<code><span class="keyword">var </span><span class="identifier">rich</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 <a href="label.html">label</a> can contain HTML code.</p> -</td> -</tr> -<tr> -<td> -<p><a href="size.html">size</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">size</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.form/-input-size/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="style.html">style</a></p> -</td> -<td> -<code><span class="keyword">var </span><span class="identifier">style</span><span class="symbol">: </span><a href="../-check-box-style/index.html"><span class="identifier">CheckBoxStyle</span></a><span class="symbol">?</span></code> -<p>The style (one of Bootstrap standard colors) of the input.</p> -</td> -</tr> -<tr> -<td> -<p><a href="validation-info.html">validationInfo</a></p> -</td> -<td> -<code><span class="keyword">val </span><span class="identifier">validationInfo</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.form/-help-block/index.html"><span class="identifier">HelpBlock</span></a></code> -<p>Validation info component.</p> -</td> -</tr> -<tr> -<td> -<p><a href="value.html">value</a></p> -</td> -<td> -<code><span class="keyword">open</span> <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 checkbox.</p> -</td> -</tr> -</tbody> -</table> -<h3>Functions</h3> -<table> -<tbody> -<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.CheckBox$onClick(kotlin.Function2((pl.treksoft.kvision.form.check.CheckBox, org.w3c.dom.events.MouseEvent, kotlin.Unit)))/handler">handler</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">CheckBox</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">CheckBox</span></a></code> -<p>A convenient helper for easy setting onClick event handler.</p> -</td> -</tr> -<tr> -<td> -<p><a href="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="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.form.check.CheckBox$setEventListener(kotlin.Function1((pl.treksoft.kvision.utils.SnOn((pl.treksoft.kvision.form.check.CheckBox.setEventListener.T)), kotlin.Unit)))/block">block</span><span class="symbol">:</span> <span class="identifier">SnOn</span><span class="symbol"><</span><a href="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.form.check.CheckBox$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> -</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.form/-bool-form-control/get-value.html">getValue</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getValue</span><span class="symbol">(</span><span class="symbol">)</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>Returns the value of the control.</p> -</td> -</tr> -<tr> -<td> -<p><a href="../../pl.treksoft.kvision.form/-bool-form-control/get-value-as-string.html">getValueAsString</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getValueAsString</span><span class="symbol">(</span><span class="symbol">)</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>Returns the value of the control as a String.</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> -<tr> -<td> -<p><a href="../../pl.treksoft.kvision.panel/-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> -<tr> -<td> -<p><a href="../../pl.treksoft.kvision.form/-bool-form-control/set-value.html">setValue</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setValue</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.BoolFormControl$setValue(kotlin.Any)/v">v</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="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> -<p>Sets the value of the control.</p> -</td> -</tr> -</tbody> -</table> -<h3>Companion Object Functions</h3> -<table> -<tbody> -<tr> -<td> -<p><a href="check-box.html">checkBox</a></p> -</td> -<td> -<code><span class="keyword">fun </span><a href="../../pl.treksoft.kvision.core/-container/index.html"><span class="identifier">Container</span></a><span class="symbol">.</span><span class="identifier">checkBox</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBox.Companion$checkBox(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.form.check.CheckBox, kotlin.Unit)))/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.CheckBox.Companion$checkBox(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.form.check.CheckBox, kotlin.Unit)))/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="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBox.Companion$checkBox(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.form.check.CheckBox, kotlin.Unit)))/rich">rich</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.CheckBox.Companion$checkBox(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.String, kotlin.Boolean, kotlin.Function1((pl.treksoft.kvision.form.check.CheckBox, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">CheckBox</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> null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">CheckBox</span></a></code> -<p>DSL builder extension function.</p> -</td> -</tr> -</tbody> -</table> -</BODY> -</HTML> |