diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.form/-k-files-form-control | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.form/-k-files-form-control')
6 files changed, 276 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/get-native-file.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-native-file.html new file mode 100644 index 00000000..7223eed8 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-native-file.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl.getNativeFile - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="index.html">KFilesFormControl</a> / <a href="./get-native-file.html">getNativeFile</a><br/> +<br/> +<h1>getNativeFile</h1> +<a name="pl.treksoft.kvision.form.KFilesFormControl$getNativeFile(pl.treksoft.kvision.types.KFile)"></a> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">getNativeFile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.KFilesFormControl$getNativeFile(pl.treksoft.kvision.types.KFile)/kFile">kFile</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">)</span><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></code> +<p>Returns the native JavaScript File object.</p> +<h3>Parameters</h3> +<p><a name="kFile"></a> +<code>kFile</code> - KFile object</p> +<p><strong>Return</strong><br/> +File object</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value-as-string.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value-as-string.html new file mode 100644 index 00000000..6e890d6f --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value-as-string.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl.getValueAsString - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="index.html">KFilesFormControl</a> / <a href="./get-value-as-string.html">getValueAsString</a><br/> +<br/> +<h1>getValueAsString</h1> +<a name="pl.treksoft.kvision.form.KFilesFormControl$getValueAsString()"></a> +<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>Overrides <a href="../-form-control/get-value-as-string.html">FormControl.getValueAsString</a></p> +<p>Returns the value of the control as a String.</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value.html new file mode 100644 index 00000000..cfc28f64 --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/get-value.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl.getValue - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="index.html">KFilesFormControl</a> / <a href="./get-value.html">getValue</a><br/> +<br/> +<h1>getValue</h1> +<a name="pl.treksoft.kvision.form.KFilesFormControl$getValue()"></a> +<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.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>Overrides <a href="../-form-control/get-value.html">FormControl.getValue</a></p> +<p>Returns the value of the control.</p> +<p><strong>Return</strong><br/> +the value</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/index.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/index.html new file mode 100644 index 00000000..4cdc3b8e --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/index.html @@ -0,0 +1,188 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="./index.html">KFilesFormControl</a><br/> +<br/> +<h1>KFilesFormControl</h1> +<code><span class="keyword">interface </span><span class="identifier">KFilesFormControl</span> <span class="symbol">:</span> <a href="../-form-control/index.html"><span class="identifier">FormControl</span></a></code> +<p>Base interface of a form control with a list of files value.</p> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="value.html">value</a></p> +</td> +<td> +<code><span class="keyword">abstract</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.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>List of files value.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-form-control/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="../-form-control/flabel.html">flabel</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">flabel</span><span class="symbol">: </span><a href="../-field-label/index.html"><span class="identifier">FieldLabel</span></a></code> +<p>Form field label.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-form-control/input.html">input</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">input</span><span class="symbol">: </span><a href="../-form-input/index.html"><span class="identifier">FormInput</span></a></code> +<p>The actual input component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-form-control/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="../-form-control/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="../-input-size/index.html"><span class="identifier">InputSize</span></a><span class="symbol">?</span></code> +<p>Input control field size.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-form-control/validation-info.html">validationInfo</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">validationInfo</span><span class="symbol">: </span><a href="../-help-block/index.html"><span class="identifier">HelpBlock</span></a></code> +<p>Validation info component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-form-control/validator-error.html">validatorError</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">validatorError</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>Validator error message.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="get-native-file.html">getNativeFile</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">getNativeFile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.KFilesFormControl$getNativeFile(pl.treksoft.kvision.types.KFile)/kFile">kFile</span><span class="symbol">:</span> <a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">)</span><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></code> +<p>Returns the native JavaScript File object.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>Returns the value of the control.</p> +</td> +</tr> +<tr> +<td> +<p><a href="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="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.KFilesFormControl$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>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-form-control/blur.html">blur</a></p> +</td> +<td> +<code><span class="keyword">abstract</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="../-form-control/focus.html">focus</a></p> +</td> +<td> +<code><span class="keyword">abstract</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> +</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> +<h3>Inheritors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.upload/-upload/index.html">Upload</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Upload</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="./index.html"><span class="identifier">KFilesFormControl</span></a></code> +<p>The form field file upload component.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/set-value.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/set-value.html new file mode 100644 index 00000000..6bb16a8d --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/set-value.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl.setValue - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="index.html">KFilesFormControl</a> / <a href="./set-value.html">setValue</a><br/> +<br/> +<h1>setValue</h1> +<a name="pl.treksoft.kvision.form.KFilesFormControl$setValue(kotlin.Any)"></a> +<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.KFilesFormControl$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>Overrides <a href="../-form-control/set-value.html">FormControl.setValue</a></p> +<p>Sets the value of the control.</p> +<h3>Parameters</h3> +<p><a name="v"></a> +<code>v</code> - the value</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.form/-k-files-form-control/value.html b/api1/pl.treksoft.kvision.form/-k-files-form-control/value.html new file mode 100644 index 00000000..0692906c --- /dev/null +++ b/api1/pl.treksoft.kvision.form/-k-files-form-control/value.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>KFilesFormControl.value - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.form</a> / <a href="index.html">KFilesFormControl</a> / <a href="./value.html">value</a><br/> +<br/> +<h1>value</h1> +<a name="pl.treksoft.kvision.form.KFilesFormControl$value"></a> +<code><span class="keyword">abstract</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.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../../pl.treksoft.kvision.types/-k-file/index.html"><span class="identifier">KFile</span></a><span class="symbol">></span><span class="symbol">?</span></code> +<p>List of files value.</p> +</BODY> +</HTML> |