diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-10-22 00:01:39 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-10-22 00:01:39 +0200 |
| commit | eb930482e9972a21d39f2aea8b813acf58ff5b64 (patch) | |
| tree | 1c64052b39527aca51793860894baa37791cc94f /api/pl.treksoft.kvision.form/-string-form-control | |
| parent | 7c2850063697f94a0d8b8d8f8588136dd4b3d05e (diff) | |
| download | kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.gz kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.bz2 kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.zip | |
API documentation for KVision 0.0.19
Diffstat (limited to 'api/pl.treksoft.kvision.form/-string-form-control')
5 files changed, 251 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html b/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html new file mode 100644 index 00000000..65693283 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/get-value-as-string.html @@ -0,0 +1,16 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StringFormControl.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">StringFormControl</a> / <a href="./get-value-as-string.html">getValueAsString</a><br/> +<br/> +<h1>getValueAsString</h1> +<a name="pl.treksoft.kvision.form.StringFormControl$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/api/pl.treksoft.kvision.form/-string-form-control/get-value.html b/api/pl.treksoft.kvision.form/-string-form-control/get-value.html new file mode 100644 index 00000000..edfa3c58 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/get-value.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StringFormControl.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">StringFormControl</a> / <a href="./get-value.html">getValue</a><br/> +<br/> +<h1>getValue</h1> +<a name="pl.treksoft.kvision.form.StringFormControl$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/-string/index.html"><span class="identifier">String</span></a><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/api/pl.treksoft.kvision.form/-string-form-control/index.html b/api/pl.treksoft.kvision.form/-string-form-control/index.html new file mode 100644 index 00000000..2b6d030d --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/index.html @@ -0,0 +1,183 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StringFormControl - 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">StringFormControl</a><br/> +<br/> +<h1>StringFormControl</h1> +<code><span class="keyword">interface </span><span class="identifier">StringFormControl</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 text 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/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>Text 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-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/-string/index.html"><span class="identifier">String</span></a><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.StringFormControl$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>Inheritors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.text/-abstract-text/index.html">AbstractText</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractText</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">StringFormControl</span></a></code> +<p>Base class for form field text components.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.check/-radio-group/index.html">RadioGroup</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">RadioGroup</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">StringFormControl</span></a></code> +<p>The form field component rendered as a group of HTML <em>input type="radio"</em> elements with the same name attribute.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.select/-select/index.html">Select</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Select</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">StringFormControl</span></a></code> +<p>The form field component for Select control.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.form/-string-form-control/set-value.html b/api/pl.treksoft.kvision.form/-string-form-control/set-value.html new file mode 100644 index 00000000..7188abdc --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/set-value.html @@ -0,0 +1,19 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StringFormControl.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">StringFormControl</a> / <a href="./set-value.html">setValue</a><br/> +<br/> +<h1>setValue</h1> +<a name="pl.treksoft.kvision.form.StringFormControl$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.StringFormControl$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/api/pl.treksoft.kvision.form/-string-form-control/value.html b/api/pl.treksoft.kvision.form/-string-form-control/value.html new file mode 100644 index 00000000..d01cb792 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/value.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StringFormControl.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">StringFormControl</a> / <a href="./value.html">value</a><br/> +<br/> +<h1>value</h1> +<a name="pl.treksoft.kvision.form.StringFormControl$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/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code> +<p>Text value.</p> +</BODY> +</HTML> |