1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>CheckBoxInput - 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">CheckBoxInput</a><br/>
<br/>
<h1>CheckBoxInput</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CheckBoxInput</span> <span class="symbol">:</span> <a href="../-check-input/index.html"><span class="identifier">CheckInput</span></a></code>
<p>The basic input 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">CheckBoxInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBoxInput$<init>(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.CheckBoxInput$<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>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../-check-input/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="../-check-input/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="../-check-input/name.html">name</a></p>
</td>
<td>
<code><span class="keyword">open</span> <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="../-check-input/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="../-check-input/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="../-check-input/type.html">type</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../-check-input-type/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="../-check-input/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 Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../-check-input/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="../-check-input/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="../-check-input/blur.html">blur</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">blur</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>Makes the input element blur.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../-check-input/focus.html">focus</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">focus</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>Makes the input element focused.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../-check-input/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="../-check-input/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="../-check-input/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="../-check-input/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="../-check-input/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="../-check-input/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>Companion Object Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="check-box-input.html">checkBoxInput</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">checkBoxInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBoxInput.Companion$checkBoxInput(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.check.CheckInput, 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.CheckBoxInput.Companion$checkBoxInput(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.check.CheckInput, kotlin.Unit)))/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><span class="identifier" id="pl.treksoft.kvision.form.check.CheckBoxInput.Companion$checkBoxInput(pl.treksoft.kvision.core.Container, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.check.CheckInput, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <span class="symbol">(</span><a href="../-check-input/index.html"><span class="identifier">CheckInput</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a><span class="symbol">)</span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">CheckBoxInput</span></a></code>
<p>DSL builder extension function.</p>
</td>
</tr>
</tbody>
</table>
<h3>Extension Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code>
<p>Helper function for creating JavaScript objects from dynamic constructors.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
|
