diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-02-09 13:40:35 +0100 |
| commit | d8cd67062b8de6e8398dc6dfd00d201200c82414 (patch) | |
| tree | 601082ec1eec73bc7a7d6ce8b51352e5345ffe81 /docs/api/pl.treksoft.kvision.core/-component | |
| parent | 955304789ea83aceacbdf4c8a9eb742f6c2518f6 (diff) | |
| download | kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.gz kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.tar.bz2 kvision-d8cd67062b8de6e8398dc6dfd00d201200c82414.zip | |
API doc and readme
Diffstat (limited to 'docs/api/pl.treksoft.kvision.core/-component')
10 files changed, 298 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.core/-component/add-css-class.html b/docs/api/pl.treksoft.kvision.core/-component/add-css-class.html new file mode 100644 index 00000000..971670b4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/add-css-class.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.addCssClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./add-css-class.html">addCssClass</a><br/> +<br/> +<h1>addCssClass</h1> +<a name="pl.treksoft.kvision.core.Component$addCssClass(kotlin.String)"></a> +<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="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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS class name</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html b/docs/api/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html new file mode 100644 index 00000000..20d8527a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.addSurroundingCssClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./add-surrounding-css-class.html">addSurroundingCssClass</a><br/> +<br/> +<h1>addSurroundingCssClass</h1> +<a name="pl.treksoft.kvision.core.Component$addSurroundingCssClass(kotlin.String)"></a> +<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="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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS class name</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query-d.html b/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query-d.html new file mode 100644 index 00000000..1f811a99 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query-d.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.getElementJQueryD - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./get-element-j-query-d.html">getElementJQueryD</a><br/> +<br/> +<h1>getElementJQueryD</h1> +<a name="pl.treksoft.kvision.core.Component$getElementJQueryD()"></a> +<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> +<p><strong>Return</strong><br/> +JQuery element as a <em>dynamic</em> type</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query.html b/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query.html new file mode 100644 index 00000000..b5782d0b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/get-element-j-query.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.getElementJQuery - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./get-element-j-query.html">getElementJQuery</a><br/> +<br/> +<h1>getElementJQuery</h1> +<a name="pl.treksoft.kvision.core.Component$getElementJQuery()"></a> +<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> +<p><strong>Return</strong><br/> +JQuery element</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/get-element.html b/docs/api/pl.treksoft.kvision.core/-component/get-element.html new file mode 100644 index 00000000..934cb2c1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/get-element.html @@ -0,0 +1,17 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.getElement - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./get-element.html">getElement</a><br/> +<br/> +<h1>getElement</h1> +<a name="pl.treksoft.kvision.core.Component$getElement()"></a> +<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> +<p><strong>Return</strong><br/> +DOM element</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/index.html b/docs/api/pl.treksoft.kvision.core/-component/index.html new file mode 100644 index 00000000..fb29f342 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/index.html @@ -0,0 +1,137 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="./index.html">Component</a><br/> +<br/> +<h1>Component</h1> +<code><span class="keyword">interface </span><span class="identifier">Component</span></code> +<p>Base interface for all components.</p> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="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="./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="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="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="./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="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="./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="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="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="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="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="./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="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="./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="../-container/index.html">Container</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">Container</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Base interface for all containers.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.form/-form-control/index.html">FormControl</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">FormControl</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Base interface of a form control.</p> +</td> +</tr> +<tr> +<td> +<p><a href="../-styled-component/index.html">StyledComponent</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">StyledComponent</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Base class for components supporting CSS styling.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/parent.html b/docs/api/pl.treksoft.kvision.core/-component/parent.html new file mode 100644 index 00000000..80cee78f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/parent.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.parent - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./parent.html">parent</a><br/> +<br/> +<h1>parent</h1> +<a name="pl.treksoft.kvision.core.Component$parent"></a> +<code><span class="keyword">abstract</span> <span class="keyword">var </span><span class="identifier">parent</span><span class="symbol">: </span><a href="index.html"><span class="identifier">Component</span></a><span class="symbol">?</span></code> +<p>Parent of the current component.</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/remove-css-class.html b/docs/api/pl.treksoft.kvision.core/-component/remove-css-class.html new file mode 100644 index 00000000..ccd69681 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/remove-css-class.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.removeCssClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./remove-css-class.html">removeCssClass</a><br/> +<br/> +<h1>removeCssClass</h1> +<a name="pl.treksoft.kvision.core.Component$removeCssClass(kotlin.String)"></a> +<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="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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS class name</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html b/docs/api/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html new file mode 100644 index 00000000..57f9acb1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.removeSurroundingCssClass - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./remove-surrounding-css-class.html">removeSurroundingCssClass</a><br/> +<br/> +<h1>removeSurroundingCssClass</h1> +<a name="pl.treksoft.kvision.core.Component$removeSurroundingCssClass(kotlin.String)"></a> +<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="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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS class name</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/docs/api/pl.treksoft.kvision.core/-component/visible.html b/docs/api/pl.treksoft.kvision.core/-component/visible.html new file mode 100644 index 00000000..f9f7397d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-component/visible.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.visible - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.core</a> / <a href="index.html">Component</a> / <a href="./visible.html">visible</a><br/> +<br/> +<h1>visible</h1> +<a name="pl.treksoft.kvision.core.Component$visible"></a> +<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> +</BODY> +</HTML> |