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/-form-input | |
| 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/-form-input')
| -rw-r--r-- | api/pl.treksoft.kvision.form/-form-input/disabled.html | 15 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.form/-form-input/index.html | 195 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.form/-form-input/name.html | 15 | ||||
| -rw-r--r-- | api/pl.treksoft.kvision.form/-form-input/size.html | 15 |
4 files changed, 240 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.form/-form-input/disabled.html b/api/pl.treksoft.kvision.form/-form-input/disabled.html new file mode 100644 index 00000000..be64c7f7 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-input/disabled.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormInput.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">FormInput</a> / <a href="./disabled.html">disabled</a><br/> +<br/> +<h1>disabled</h1> +<a name="pl.treksoft.kvision.form.FormInput$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/api/pl.treksoft.kvision.form/-form-input/index.html b/api/pl.treksoft.kvision.form/-form-input/index.html new file mode 100644 index 00000000..fd61b517 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-input/index.html @@ -0,0 +1,195 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormInput - 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">FormInput</a><br/> +<br/> +<h1>FormInput</h1> +<code><span class="keyword">interface </span><span class="identifier">FormInput</span> <span class="symbol">:</span> <a href="../../pl.treksoft.kvision.core/-component/index.html"><span class="identifier">Component</span></a></code> +<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="name.html">name</a></p> +</td> +<td> +<code><span class="keyword">abstract</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="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 field size.</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/-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/-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>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="../../pl.treksoft.kvision.form.text/-abstract-text-input/index.html">AbstractTextInput</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractTextInput</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="./index.html"><span class="identifier">FormInput</span></a></code> +<p>Base class for basic text components.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.check/-check-input/index.html">CheckInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CheckInput</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="./index.html"><span class="identifier">FormInput</span></a></code> +<p>The basic input component rendered as HTML <em>input type="checkbox"</em> or <em>input type="radio"</em>.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.time/-date-time-input/index.html">DateTimeInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">DateTimeInput</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="./index.html"><span class="identifier">FormInput</span></a></code> +<p>Basic date/time chooser component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.select/-select-input/index.html">SelectInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SelectInput</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">FormInput</span></a></code> +<p>The basic component for Select control.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.spinner/-spinner-input/index.html">SpinnerInput</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SpinnerInput</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="./index.html"><span class="identifier">FormInput</span></a></code> +<p>The basic component for spinner control.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form.upload/-upload-input/index.html">UploadInput</a></p> +</td> +<td> +<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="./index.html"><span class="identifier">FormInput</span></a></code> +<p>The file upload component.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.form/-form-input/name.html b/api/pl.treksoft.kvision.form/-form-input/name.html new file mode 100644 index 00000000..8d920881 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-input/name.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormInput.name - 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">FormInput</a> / <a href="./name.html">name</a><br/> +<br/> +<h1>name</h1> +<a name="pl.treksoft.kvision.form.FormInput$name"></a> +<code><span class="keyword">abstract</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> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.form/-form-input/size.html b/api/pl.treksoft.kvision.form/-form-input/size.html new file mode 100644 index 00000000..2952df45 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-input/size.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>FormInput.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">FormInput</a> / <a href="./size.html">size</a><br/> +<br/> +<h1>size</h1> +<a name="pl.treksoft.kvision.form.FormInput$size"></a> +<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 field size.</p> +</BODY> +</HTML> |