diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-03-01 15:19:44 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-03-01 15:19:44 +0100 |
| commit | 415afec335659ca6bc206b34bdd3c2fe4635718f (patch) | |
| tree | 69446330560c0b89a38299e5ced7d3db4b3f5266 /api/pl.treksoft.kvision.form/-string-form-control/index.html | |
| parent | 8b298c0c5bb377863baf3e0125289957fd2afe5e (diff) | |
| download | kvision-415afec335659ca6bc206b34bdd3c2fe4635718f.tar.gz kvision-415afec335659ca6bc206b34bdd3c2fe4635718f.tar.bz2 kvision-415afec335659ca6bc206b34bdd3c2fe4635718f.zip | |
KVision site with Jekyll
Diffstat (limited to 'api/pl.treksoft.kvision.form/-string-form-control/index.html')
| -rw-r--r-- | api/pl.treksoft.kvision.form/-string-form-control/index.html | 151 |
1 files changed, 151 insertions, 0 deletions
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..0df074f2 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-string-form-control/index.html @@ -0,0 +1,151 @@ +<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">abstract</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="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a></code> +<p>The actual input component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-form-control/size.html">size</a></p> +</td> +<td> +<code><span class="keyword">abstract</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 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>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> |