diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.core/-component/index.html | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.core/-component/index.html')
| -rw-r--r-- | api1/pl.treksoft.kvision.core/-component/index.html | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.core/-component/index.html b/api1/pl.treksoft.kvision.core/-component/index.html new file mode 100644 index 00000000..3042d07c --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/index.html @@ -0,0 +1,193 @@ +<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="../-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="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> +<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(pl.treksoft.kvision.core.Style)/css">css</span><span class="symbol">:</span> <a href="../-style/index.html"><span class="identifier">Style</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Adds given style object 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> +<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(pl.treksoft.kvision.core.Style)/css">css</span><span class="symbol">:</span> <a href="../-style/index.html"><span class="identifier">Style</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Adds given style object to the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="get-attribute.html">getAttribute</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">getAttribute</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$getAttribute(kotlin.String)/name">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><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 an additional attribute.</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-attribute.html">removeAttribute</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">removeAttribute</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$removeAttribute(kotlin.String)/name">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><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Removes the value of additional attribute.</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> +<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(pl.treksoft.kvision.core.Style)/css">css</span><span class="symbol">:</span> <a href="../-style/index.html"><span class="identifier">Style</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Removes given style object 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> +<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(pl.treksoft.kvision.core.Style)/css">css</span><span class="symbol">:</span> <a href="../-style/index.html"><span class="identifier">Style</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Removes given style object from the set of CSS classes generated in html code of parent component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="set-attribute.html">setAttribute</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">setAttribute</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.core.Component$setAttribute(kotlin.String, kotlin.String)/name">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><span class="identifier" id="pl.treksoft.kvision.core.Component$setAttribute(kotlin.String, kotlin.String)/value">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><span class="symbol">: </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Sets the value of additional attribute.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</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="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</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="../../pl.treksoft.kvision.form/-form-input/index.html">FormInput</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">FormInput</span> <span class="symbol">:</span> <a href="./index.html"><span class="identifier">Component</span></a></code></td> +</tr> +<tr> +<td> +<p><a href="../-widget/index.html">Widget</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Widget</span> <span class="symbol">:</span> <a href="../-styled-component/index.html"><span class="identifier">StyledComponent</span></a><span class="symbol">, </span><a href="./index.html"><span class="identifier">Component</span></a></code> +<p>Base widget class. The parent of all component classes.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |