diff options
Diffstat (limited to 'docs/api/pl.treksoft.kvision.core/-styled-component/index.html')
| -rw-r--r-- | docs/api/pl.treksoft.kvision.core/-styled-component/index.html | 386 |
1 files changed, 386 insertions, 0 deletions
diff --git a/docs/api/pl.treksoft.kvision.core/-styled-component/index.html b/docs/api/pl.treksoft.kvision.core/-styled-component/index.html new file mode 100644 index 00000000..4c6cc6bc --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-styled-component/index.html @@ -0,0 +1,386 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>StyledComponent - 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">StyledComponent</a><br/> +<br/> +<h1>StyledComponent</h1> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">StyledComponent</span> <span class="symbol">:</span> <a href="../-component/index.html"><span class="identifier">Component</span></a></code> +<p>Base class for components supporting CSS styling.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">StyledComponent</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>Base class for components supporting CSS styling.</p> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="background.html">background</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">background</span><span class="symbol">: </span><a href="../-background/index.html"><span class="identifier">Background</span></a><span class="symbol">?</span></code> +<p>Background of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="border.html">border</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">border</span><span class="symbol">: </span><a href="../-border/index.html"><span class="identifier">Border</span></a><span class="symbol">?</span></code> +<p>Border of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="border-bottom.html">borderBottom</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">borderBottom</span><span class="symbol">: </span><a href="../-border/index.html"><span class="identifier">Border</span></a><span class="symbol">?</span></code> +<p>Bottom border of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="border-left.html">borderLeft</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">borderLeft</span><span class="symbol">: </span><a href="../-border/index.html"><span class="identifier">Border</span></a><span class="symbol">?</span></code> +<p>Left border of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="border-right.html">borderRight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">borderRight</span><span class="symbol">: </span><a href="../-border/index.html"><span class="identifier">Border</span></a><span class="symbol">?</span></code> +<p>Right border of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="border-top.html">borderTop</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">borderTop</span><span class="symbol">: </span><a href="../-border/index.html"><span class="identifier">Border</span></a><span class="symbol">?</span></code> +<p>Top border of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="color.html">color</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">color</span><span class="symbol">: </span><a href="../-color/index.html"><span class="identifier">Color</span></a><span class="symbol">?</span></code> +<p>Text color for the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="color-hex.html">colorHex</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">colorHex</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span></code> +<p>Text color for the current component given in hex format (write only).</p> +</td> +</tr> +<tr> +<td> +<p><a href="color-name.html">colorName</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">colorName</span><span class="symbol">: </span><a href="../-c-o-l-o-r/index.html"><span class="identifier">COLOR</span></a><span class="symbol">?</span></code> +<p>Text color for the current component given with named constant (write only).</p> +</td> +</tr> +<tr> +<td> +<p><a href="height.html">height</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">height</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Height of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="margin.html">margin</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">margin</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Margin of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="margin-bottom.html">marginBottom</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">marginBottom</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Bottom margin of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="margin-left.html">marginLeft</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">marginLeft</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Left margin of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="margin-right.html">marginRight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">marginRight</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Right margin of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="margin-top.html">marginTop</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">marginTop</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Top margin of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="max-height.html">maxHeight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">maxHeight</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Maximal height of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="max-width.html">maxWidth</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">maxWidth</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Maximal width of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="min-height.html">minHeight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">minHeight</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Minimal height of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="min-width.html">minWidth</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">minWidth</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Minimal width of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="opacity.html">opacity</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">opacity</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html"><span class="identifier">Double</span></a><span class="symbol">?</span></code> +<p>Opacity of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="padding.html">padding</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">padding</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Padding of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="padding-bottom.html">paddingBottom</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">paddingBottom</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Bottom padding of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="padding-left.html">paddingLeft</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">paddingLeft</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Left padding of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="padding-right.html">paddingRight</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">paddingRight</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Right padding of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="padding-top.html">paddingTop</a></p> +</td> +<td> +<code><span class="keyword">var </span><span class="identifier">paddingTop</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Top padding of the current component.</p> +</td> +</tr> +<tr> +<td> +<p><a href="width.html">width</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">var </span><span class="identifier">width</span><span class="symbol">: </span><a href="../-css-size.html"><span class="identifier">CssSize</span></a><span class="symbol">?</span></code> +<p>Width of the current component.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-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="../-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="../-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-sn-style.html">getSnStyle</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">getSnStyle</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="../-string-pair.html"><span class="identifier">StringPair</span></a><span class="symbol">></span></code> +<p>Returns the list of String pairs defining CSS style attributes and their values.</p> +</td> +</tr> +</tbody> +</table> +<h3>Inherited Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../-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="../-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="../-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="../-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="../-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="../-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="../-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="../-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="../-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="../-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="../-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="../-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="./index.html"><span class="identifier">StyledComponent</span></a></code> +<p>Base widget class. The parent of all component classes.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |