diff options
Diffstat (limited to 'docs/api/pl.treksoft.kvision.form/-form-control')
10 files changed, 377 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html b/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html new file mode 100644 index 00000000..ac5dc5aa --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.disabled - 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">FormControl</a> / <a href="./disabled.html">disabled</a><br/> +<br/> +<h1>disabled</h1> +<a name="pl.treksoft.kvision.form.FormControl$disabled"></a> +<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> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html b/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html new file mode 100644 index 00000000..51e4d46e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.flabel - 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">FormControl</a> / <a href="./flabel.html">flabel</a><br/> +<br/> +<h1>flabel</h1> +<a name="pl.treksoft.kvision.form.FormControl$flabel"></a> +<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> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html b/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html new file mode 100644 index 00000000..671320bf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.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">FormControl</a> / <a href="./get-value-as-string.html">getValueAsString</a><br/> +<br/> +<h1>getValueAsString</h1> +<a name="pl.treksoft.kvision.form.FormControl$getValueAsString()"></a> +<code><span class="keyword">abstract</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> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html b/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html new file mode 100644 index 00000000..6ac2fc1e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.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">FormControl</a> / <a href="./get-value.html">getValue</a><br/> +<br/> +<h1>getValue</h1> +<a name="pl.treksoft.kvision.form.FormControl$getValue()"></a> +<code><span class="keyword">abstract</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/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span></code> +<p>Returns the value of the control.</p> +<p><strong>Return</strong><br/> +the value</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/index.html b/docs/api/pl.treksoft.kvision.form/-form-control/index.html new file mode 100644 index 00000000..f5e493f4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/index.html @@ -0,0 +1,237 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl - 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">FormControl</a><br/> +<br/> +<h1>FormControl</h1> +<code><span class="keyword">interface </span><span class="identifier">FormControl</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a></code> +<p>Base interface of a form control.</p> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="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="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="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="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="../-i-n-p-u-t-s-i-z-e/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="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="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>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.core/-component/parent.html">parent</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">var </span><span class="identifier">parent</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</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/-component/visible.html">visible</a></p> +</td> +<td> +<code><span class="keyword">abstract</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="get-value.html">getValue</a></p> +</td> +<td> +<code><span class="keyword">abstract</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/-any/index.html"><span class="identifier">Any</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">abstract</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">abstract</span> <span class="keyword">fun </span><span class="identifier">setValue</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.FormControl$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="../../pl.treksoft.kvision.core/-component/add-css-class.html">addCssClass</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">addCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$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/-component/index.html"><span class="identifier">Component</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/-component/add-surrounding-css-class.html">addSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">addSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$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/-component/index.html"><span class="identifier">Component</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/-component/get-element.html">getElement</a></p> +</td> +<td> +<code><span class="keyword">abstract</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/-component/get-element-j-query.html">getElementJQuery</a></p> +</td> +<td> +<code><span class="keyword">abstract</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/-component/get-element-j-query-d.html">getElementJQueryD</a></p> +</td> +<td> +<code><span class="keyword">abstract</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/-component/remove-css-class.html">removeCssClass</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">removeCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$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/-component/index.html"><span class="identifier">Component</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/-component/remove-surrounding-css-class.html">removeSurroundingCssClass</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">removeSurroundingCssClass</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$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/-component/index.html"><span class="identifier">Component</span></a></code> +<p>Removes given value from the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inheritors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-bool-form-control/index.html">BoolFormControl</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">BoolFormControl</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">FormControl</span></a></code> +<p>Base interface of a form control with a boolean value.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-date-form-control/index.html">DateFormControl</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">DateFormControl</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">FormControl</span></a></code> +<p>Base interface of a form control with a date value.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-number-form-control/index.html">NumberFormControl</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">NumberFormControl</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">FormControl</span></a></code> +<p>Base interface of a form control with a numeric value.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-string-form-control/index.html">StringFormControl</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">StringFormControl</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">FormControl</span></a></code> +<p>Base interface of a form control with a text value.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/input.html b/docs/api/pl.treksoft.kvision.form/-form-control/input.html new file mode 100644 index 00000000..6ed80ddd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/input.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.input - 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">FormControl</a> / <a href="./input.html">input</a><br/> +<br/> +<h1>input</h1> +<a name="pl.treksoft.kvision.form.FormControl$input"></a> +<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> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html b/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html new file mode 100644 index 00000000..ab425936 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.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">FormControl</a> / <a href="./set-value.html">setValue</a><br/> +<br/> +<h1>setValue</h1> +<a name="pl.treksoft.kvision.form.FormControl$setValue(kotlin.Any)"></a> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">setValue</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.form.FormControl$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> +<h3>Parameters</h3> +<p><a name="v"></a> +<code>v</code> - the value</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/size.html b/docs/api/pl.treksoft.kvision.form/-form-control/size.html new file mode 100644 index 00000000..cb844a2a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/size.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.size - 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">FormControl</a> / <a href="./size.html">size</a><br/> +<br/> +<h1>size</h1> +<a name="pl.treksoft.kvision.form.FormControl$size"></a> +<code><span class="keyword">abstract</span> <span class="keyword">var </span><span class="identifier">size</span><span class="symbol">: </span><a href="../-i-n-p-u-t-s-i-z-e/index.html"><span class="identifier">INPUTSIZE</span></a><span class="symbol">?</span></code> +<p>Input control size.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html b/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html new file mode 100644 index 00000000..e477d349 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.validationInfo - 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">FormControl</a> / <a href="./validation-info.html">validationInfo</a><br/> +<br/> +<h1>validationInfo</h1> +<a name="pl.treksoft.kvision.form.FormControl$validationInfo"></a> +<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> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html b/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html new file mode 100644 index 00000000..9af55095 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormControl.validatorError - 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">FormControl</a> / <a href="./validator-error.html">validatorError</a><br/> +<br/> +<h1>validatorError</h1> +<a name="pl.treksoft.kvision.form.FormControl$validatorError"></a> +<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> +</BODY> +</HTML> |