summaryrefslogtreecommitdiff
path: root/docs/api/pl.treksoft.kvision.modal/-modal/index.html
blob: 0d7d07981f6acbad781d2ab266e672181a5f7ede (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
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Modal - 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.modal</a>&nbsp;/&nbsp;<a href="./index.html">Modal</a><br/>
<br/>
<h1>Modal</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Modal</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.panel/-simple-panel/index.html"><span class="identifier">SimplePanel</span></a></code>
<p>Configurable modal window based on Bootstrap modal.</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">Modal</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/caption">caption</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.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/closeButton">closeButton</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;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/size">size</span><span class="symbol">:</span>&nbsp;<a href="../-m-o-d-a-l-s-i-z-e/index.html"><span class="identifier">MODALSIZE</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/animation">animation</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;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/escape">escape</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;true<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$<init>(kotlin.String, kotlin.Boolean, pl.treksoft.kvision.modal.MODALSIZE, kotlin.Boolean, 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()<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="animation.html">animation</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">animation</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 animations are used.</p>
</td>
</tr>
<tr>
<td>
<p><a href="caption.html">caption</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">caption</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>Window content text.</p>
</td>
</tr>
<tr>
<td>
<p><a href="close-button.html">closeButton</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">closeButton</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 Close button is visible.</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="../-m-o-d-a-l-s-i-z-e/index.html"><span class="identifier">MODALSIZE</span></a><span class="symbol">?</span></code>
<p>Window size.</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="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.modal.Modal$add(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span>&nbsp;<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="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.modal.Modal$addAll(kotlin.collections.List((pl.treksoft.kvision.core.Component)))/children">children</span><span class="symbol">:</span>&nbsp;<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/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">&gt;</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="add-button.html">addButton</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">addButton</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$addButton(pl.treksoft.kvision.html.Button)/button">button</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.html/-button/index.html"><span class="identifier">Button</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Modal</span></a></code>
<p>Adds given button to the bottom section of dialog window.</p>
</td>
</tr>
<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.modal.Modal$afterInsert(com.github.snabbdom.VNode)/node">node</span><span class="symbol">:</span>&nbsp;<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="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>
<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">&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="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="remove-all-buttons.html">removeAllButtons</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeAllButtons</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Modal</span></a></code>
<p>Removes all buttons from the bottom section of dialog window.</p>
</td>
</tr>
<tr>
<td>
<p><a href="remove-button.html">removeButton</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">removeButton</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.modal.Modal$removeButton(pl.treksoft.kvision.html.Button)/button">button</span><span class="symbol">:</span>&nbsp;<a href="../../pl.treksoft.kvision.html/-button/index.html"><span class="identifier">Button</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Modal</span></a></code>
<p>Removes given button from the bottom section of dialog window.</p>
</td>
</tr>
<tr>
<td>
<p><a href="toggle.html">toggle</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">toggle</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>Toggle modal window visibility.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<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>&nbsp;<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">&lt;</span><span class="identifier">VNode</span><span class="symbol">&gt;</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">&lt;</span><a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a><span class="symbol">&gt;</span></code>
<p>Returns a list of children of the current container.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../pl.treksoft.kvision.panel/-simple-panel/remove.html">remove</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">remove</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.panel.SimplePanel$remove(pl.treksoft.kvision.core.Component)/child">child</span><span class="symbol">:</span>&nbsp;<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>
</tbody>
</table>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../-alert/index.html">Alert</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Alert</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">Modal</span></a></code>
<p>Alert window based on Bootstrap modal.</p>
</td>
</tr>
<tr>
<td>
<p><a href="../-confirm/index.html">Confirm</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Confirm</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">Modal</span></a></code>
<p>Confirm window based on Bootstrap modal.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>