summaryrefslogtreecommitdiff
path: root/api/pl.treksoft.kvision.form/-field-label/index.html
blob: 4c7cf63eca931a0f01bd8f38bffb9d8e1a7c7f82 (plain)
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
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>FieldLabel - kvision</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">kvision</a>&nbsp;/&nbsp;<a href="../index.html">pl.treksoft.kvision.form</a>&nbsp;/&nbsp;<a href="./index.html">FieldLabel</a><br/>
<br/>
<h1>FieldLabel</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">FieldLabel</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.html/-tag/index.html"><span class="identifier">Tag</span></a></code>
<p>Helper class for HTML label element.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">FieldLabel</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.FieldLabel$<init>(kotlin.String, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/forId">forId</span><span class="symbol">:</span>&nbsp;<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.FieldLabel$<init>(kotlin.String, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/content">content</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.FieldLabel$<init>(kotlin.String, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/rich">rich</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;false<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.form.FieldLabel$<init>(kotlin.String, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/classes">classes</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html"><span class="identifier">Set</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span>&nbsp;<span class="symbol">=</span>&nbsp;setOf("control-label")<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/align.html">align</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">align</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-align/index.html"><span class="identifier">Align</span></a><span class="symbol">?</span></code>
<p>Text align.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/content.html">content</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">content</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>Text content of the tag.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/rich.html">rich</a></p>
</td>
<td>
<code><span class="keyword">open</span> <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="../../pl.treksoft.kvision.html/-tag/content.html">content</a> can contain HTML code.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/template.html">template</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">template</span><span class="symbol">: </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>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Handlebars template.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/templates.html">templates</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">templates</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html"><span class="identifier">Map</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">,</span>&nbsp;<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>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span></code>
<p>Handlebars templates for i18n.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/type.html">type</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.html/-t-a-g/index.html"><span class="identifier">TAG</span></a></code>
<p>Tag type.</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">&lt;</span><a href="../../pl.treksoft.kvision.core/-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">&gt;</span></code>
<p>Returns list of element attributes in the form of a List.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/-tag/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">&lt;</span><a href="../../pl.treksoft.kvision.core/-string-bool-pair.html"><span class="identifier">StringBoolPair</span></a><span class="symbol">&gt;</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="../../pl.treksoft.kvision.html/-tag/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>Extension Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.html/set-data.html">setData</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">K</span><span class="symbol">&gt;</span> <a href="../../pl.treksoft.kvision.html/-template/index.html"><span class="identifier">Template</span></a><span class="symbol">.</span><span class="identifier">setData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.html.setData.K)))/obj">obj</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.html/set-data.html#K"><span class="identifier">K</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.html.setData.K)))/serializer">serializer</span><span class="symbol">:</span>&nbsp;<span class="identifier">SerializationStrategy</span><span class="symbol">&lt;</span><a href="../../pl.treksoft.kvision.html/set-data.html#K"><span class="identifier">K</span></a><span class="symbol">&gt;</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><br/>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">K</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="../../pl.treksoft.kvision.html/-template/index.html"><span class="identifier">Template</span></a><span class="symbol">.</span><span class="identifier">setData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.html$setData(pl.treksoft.kvision.html.Template, pl.treksoft.kvision.html.setData.K)/obj">obj</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.html/set-data.html#K"><span class="identifier">K</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></code>
<p>Extension function to set serializable object as a template data.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>