diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-04-02 01:35:47 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-04-02 01:35:47 +0200 |
| commit | 806edfceeefe7fda47924f97237974e99fe28a02 (patch) | |
| tree | ab1f0cbd26fabd147c2343761c1577e05da373af /api/pl.treksoft.kvision.form.upload/-upload-input/index.html | |
| parent | fe344a5450759e8eb8ffbb9c7d7f92a9ee5f4ee0 (diff) | |
| download | kvision-806edfceeefe7fda47924f97237974e99fe28a02.tar.gz kvision-806edfceeefe7fda47924f97237974e99fe28a02.tar.bz2 kvision-806edfceeefe7fda47924f97237974e99fe28a02.zip | |
API documentantion update
Diffstat (limited to 'api/pl.treksoft.kvision.form.upload/-upload-input/index.html')
| -rw-r--r-- | api/pl.treksoft.kvision.form.upload/-upload-input/index.html | 623 |
1 files changed, 623 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html new file mode 100644 index 00000000..3090e5be --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html @@ -0,0 +1,623 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>UploadInput - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form.upload</a> / <a href="./index.html">UploadInput</a><br/> +<br/> +<h1>UploadInput</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">UploadInput</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-widget/index.html"><span class="identifier">Widget</span></a><span class="symbol">, </span><a href="../../pl.treksoft.kvision.form/-form-input/index.html"><span class="identifier">FormInput</span></a></code> +<p>The file upload component.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">UploadInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.upload.UploadInput$<init>(kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/uploadUrl">uploadUrl</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.upload.UploadInput$<init>(kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)))/multiple">multiple</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.upload.UploadInput$<init>(kotlin.String, 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="allowed-file-extensions.html">allowedFileExtensions</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">allowedFileExtensions</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></code> +<p>Allowed file extensions.</p> +</td> +</tr> +<tr> +<td> +<p><a href="allowed-file-types.html">allowedFileTypes</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">allowedFileTypes</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></code> +<p>Allowed file types.</p> +</td> +</tr> +<tr> +<td> +<p><a href="browse-on-zone-click.html">browseOnZoneClick</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">browseOnZoneClick</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 click on the preview zone opens file browse window.</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="drop-zone-enabled.html">dropZoneEnabled</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">dropZoneEnabled</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 Drag&Drop zone is enabled.</p> +</td> +</tr> +<tr> +<td> +<p><a href="explorer-theme.html">explorerTheme</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">explorerTheme</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 explorer theme is used.</p> +</td> +</tr> +<tr> +<td> +<p><a href="multiple.html">multiple</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">multiple</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 multiple file upload is supported.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="prefer-iconic-preview.html">preferIconicPreview</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">preferIconicPreview</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 iconic preview is prefered.</p> +</td> +</tr> +<tr> +<td> +<p><a href="required.html">required</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">required</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 input selection is required.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-browse.html">showBrowse</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showBrowse</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 file browse button is shown.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-cancel.html">showCancel</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showCancel</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 cancel button is shown.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-caption.html">showCaption</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showCaption</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 caption is shown.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-preview.html">showPreview</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showPreview</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 preview is shown.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-remove.html">showRemove</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showRemove</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 remove button is shown.</p> +</td> +</tr> +<tr> +<td> +<p><a href="show-upload.html">showUpload</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">showUpload</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 upload button is shown.</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 (currently not working)</p> +</td> +</tr> +<tr> +<td> +<p><a href="upload-extra-data.html">uploadExtraData</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">uploadExtraData</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> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span> <span class="symbol">-></span> <span class="keyword">dynamic</span></code> +<p>The extra data that will be passed as data to the AJAX server call via POST.</p> +</td> +</tr> +<tr> +<td> +<p><a href="upload-url.html">uploadUrl</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">uploadUrl</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 optional URL for the upload processing action. +If not set the upload button action will default to form submission.</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.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.files/-file/index.html"><span class="identifier">File</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>File input value.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/draggable.html">draggable</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">draggable</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></code> +<p>Determines if the current widget is draggable.</p> +</td> +</tr> +<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/-container/index.html"><span class="identifier">Container</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-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="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.upload.UploadInput$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="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="cancel.html">cancel</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">cancel</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>Cancel an ongoing ajax upload (only for ajax mode).</p> +</td> +</tr> +<tr> +<td> +<p><a href="clear-input.html">clearInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">clearInput</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>Clears the file input control (including the native input).</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="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="get-value-as-string.html">getValueAsString</a></p> +</td> +<td> +<code><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 file input control as a String.</p> +</td> +</tr> +<tr> +<td> +<p><a href="lock.html">lock</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">lock</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>Locks the file input (disabling all buttons except a cancel button).</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> +<tr> +<td> +<p><a href="reset-input.html">resetInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">resetInput</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>Resets the file input control.</p> +</td> +</tr> +<tr> +<td> +<p><a href="unlock.html">unlock</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">unlock</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>Unlocks the file input.</p> +</td> +</tr> +<tr> +<td> +<p><a href="upload.html">upload</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">upload</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>Trigger ajax upload (only for ajax mode).</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-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.core.Widget$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="../../pl.treksoft.kvision.core/-widget/clear-drag-drop-data.html">clearDragDropData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">clearDragDropData</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>Clears D&D data for the current widget. It also makes it not draggable.</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-context-menu.html">setContextMenu</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setContextMenu</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setContextMenu(pl.treksoft.kvision.dropdown.ContextMenu)/contextMenu">contextMenu</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.dropdown/-context-menu/index.html"><span class="identifier">ContextMenu</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 context menu for the current widget.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drag-drop-data.html">setDragDropData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDragDropData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDragDropData(kotlin.String, kotlin.String)/format">format</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$setDragDropData(kotlin.String, kotlin.String)/data">data</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Sets D&D data for the current widget. It also makes it draggable.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drop-target.html">setDropTarget</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDropTarget</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.String, kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/format">format</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$setDropTarget(kotlin.String, kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/callback">callback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-drag-event/index.html"><span class="identifier">DragEvent</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code><br/> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDropTarget</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.collections.Set((kotlin.String)), kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/formats">formats</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> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTarget(kotlin.collections.Set((kotlin.String)), kotlin.Function1((org.w3c.dom.DragEvent, kotlin.Unit)))/callback">callback</span><span class="symbol">:</span> <span class="symbol">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-drag-event/index.html"><span class="identifier">DragEvent</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Sets the current widget as a D&D drop target.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-widget/set-drop-target-data.html">setDropTargetData</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">setDropTargetData</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Widget$setDropTargetData(kotlin.String, kotlin.Function1((kotlin.String, kotlin.Unit)))/format">format</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$setDropTargetData(kotlin.String, kotlin.Function1((kotlin.String, kotlin.Unit)))/callback">callback</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><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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Sets the current widget as a D&D drop target with helper callback accepting String data.</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> +<h3>Companion Object Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="upload-input.html">uploadInput</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">uploadInput</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.upload.UploadInput.Companion$uploadInput(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.upload.UploadInput, kotlin.Unit)))/uploadUrl">uploadUrl</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.upload.UploadInput.Companion$uploadInput(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.upload.UploadInput, kotlin.Unit)))/multiple">multiple</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.upload.UploadInput.Companion$uploadInput(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.upload.UploadInput, 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.upload.UploadInput.Companion$uploadInput(pl.treksoft.kvision.core.Container, kotlin.String, kotlin.Boolean, kotlin.collections.Set((kotlin.String)), kotlin.Function1((pl.treksoft.kvision.form.upload.UploadInput, kotlin.Unit)))/init">init</span><span class="symbol">:</span> <a href="./index.html"><span class="identifier">UploadInput</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">UploadInput</span></a></code> +<p>DSL builder extension function.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |