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 | |
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')
13 files changed, 444 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.core/-component/add-css-class.html b/api1/pl.treksoft.kvision.core/-component/add-css-class.html new file mode 100644 index 00000000..1cdfc8fc --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/add-css-class.html @@ -0,0 +1,28 @@ +<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> +<a name="pl.treksoft.kvision.core.Component$addCssClass(pl.treksoft.kvision.core.Style)"></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(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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS style object</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html b/api1/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html new file mode 100644 index 00000000..592a645b --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html @@ -0,0 +1,28 @@ +<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> +<a name="pl.treksoft.kvision.core.Component$addSurroundingCssClass(pl.treksoft.kvision.core.Style)"></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(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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS style object</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/get-attribute.html b/api1/pl.treksoft.kvision.core/-component/get-attribute.html new file mode 100644 index 00000000..8694776f --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/get-attribute.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.getAttribute - 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-attribute.html">getAttribute</a><br/> +<br/> +<h1>getAttribute</h1> +<a name="pl.treksoft.kvision.core.Component$getAttribute(kotlin.String)"></a> +<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> +<h3>Parameters</h3> +<p><a name="name"></a> +<code>name</code> - the name of the attribute</p> +<p><strong>Return</strong><br/> +the value of the attribute</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/get-element-j-query-d.html b/api1/pl.treksoft.kvision.core/-component/get-element-j-query-d.html new file mode 100644 index 00000000..1f811a99 --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.core/-component/get-element-j-query.html b/api1/pl.treksoft.kvision.core/-component/get-element-j-query.html new file mode 100644 index 00000000..b5782d0b --- /dev/null +++ b/api1/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/api1/pl.treksoft.kvision.core/-component/get-element.html b/api1/pl.treksoft.kvision.core/-component/get-element.html new file mode 100644 index 00000000..934cb2c1 --- /dev/null +++ b/api1/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/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> diff --git a/api1/pl.treksoft.kvision.core/-component/parent.html b/api1/pl.treksoft.kvision.core/-component/parent.html new file mode 100644 index 00000000..2c055b91 --- /dev/null +++ b/api1/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="../-container/index.html"><span class="identifier">Container</span></a><span class="symbol">?</span></code> +<p>Parent of the current component.</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/remove-attribute.html b/api1/pl.treksoft.kvision.core/-component/remove-attribute.html new file mode 100644 index 00000000..460611a2 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/remove-attribute.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.removeAttribute - 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-attribute.html">removeAttribute</a><br/> +<br/> +<h1>removeAttribute</h1> +<a name="pl.treksoft.kvision.core.Component$removeAttribute(kotlin.String)"></a> +<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> +<h3>Parameters</h3> +<p><a name="name"></a> +<code>name</code> - the name of the attribute</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/remove-css-class.html b/api1/pl.treksoft.kvision.core/-component/remove-css-class.html new file mode 100644 index 00000000..f54d5881 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/remove-css-class.html @@ -0,0 +1,28 @@ +<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> +<a name="pl.treksoft.kvision.core.Component$removeCssClass(pl.treksoft.kvision.core.Style)"></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(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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS style object</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html b/api1/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html new file mode 100644 index 00000000..13f8c401 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html @@ -0,0 +1,28 @@ +<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> +<a name="pl.treksoft.kvision.core.Component$removeSurroundingCssClass(pl.treksoft.kvision.core.Style)"></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(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> +<h3>Parameters</h3> +<p><a name="css"></a> +<code>css</code> - CSS style object</p> +<p><strong>Return</strong><br/> +current component</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/set-attribute.html b/api1/pl.treksoft.kvision.core/-component/set-attribute.html new file mode 100644 index 00000000..521cb74e --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-component/set-attribute.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Component.setAttribute - 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="./set-attribute.html">setAttribute</a><br/> +<br/> +<h1>setAttribute</h1> +<a name="pl.treksoft.kvision.core.Component$setAttribute(kotlin.String, kotlin.String)"></a> +<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> +<h3>Parameters</h3> +<p><a name="name"></a> +<code>name</code> - the name of the attribute</p> +<p><a name="value"></a> +<code>value</code> - the value of the attribute</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.core/-component/visible.html b/api1/pl.treksoft.kvision.core/-component/visible.html new file mode 100644 index 00000000..f9f7397d --- /dev/null +++ b/api1/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> |