From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-component/add-css-class.html | 20 +++ .../-component/add-surrounding-css-class.html | 20 +++ .../-component/get-element-j-query-d.html | 17 +++ .../-component/get-element-j-query.html | 17 +++ .../-component/get-element.html | 17 +++ .../pl.treksoft.kvision.core/-component/index.html | 137 +++++++++++++++++++++ .../-component/parent.html | 15 +++ .../-component/remove-css-class.html | 20 +++ .../-component/remove-surrounding-css-class.html | 20 +++ .../-component/visible.html | 15 +++ 10 files changed, 298 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.core/-component/add-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/get-element-j-query-d.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/get-element-j-query.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/get-element.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/index.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/parent.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/remove-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-component/visible.html (limited to 'docs/api/pl.treksoft.kvision.core/-component') 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 @@ + + + +Component.addCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Component / addCssClass
+
+

addCssClass

+ +abstract fun addCssClass(css: String): Component +

Adds given value to the set of CSS classes generated in html code of current component.

Parameters

+css - CSS class name

Return
+current component

+ + 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 @@ + + + +Component.addSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Component / addSurroundingCssClass
+
+

addSurroundingCssClass

+ +abstract fun addSurroundingCssClass(css: String): Component +

Adds given value to the set of CSS classes generated in html code of parent component.

Parameters

+css - CSS class name

Return
+current component

+ + 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 @@ + + + +Component.getElementJQueryD - kvision + + + +kvision / pl.treksoft.kvision.core / Component / getElementJQueryD
+
+

getElementJQueryD

+ +abstract fun getElementJQueryD(): dynamic +

Returns JQuery element bound to the current component as a dynamic type.

Return
+JQuery element as a dynamic type

+ + 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 @@ + + + +Component.getElementJQuery - kvision + + + +kvision / pl.treksoft.kvision.core / Component / getElementJQuery
+
+

getElementJQuery

+ +abstract fun getElementJQuery(): JQuery? +

Returns JQuery element bound to the current component.

Return
+JQuery element

+ + 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 @@ + + + +Component.getElement - kvision + + + +kvision / pl.treksoft.kvision.core / Component / getElement
+
+

getElement

+ +abstract fun getElement(): Node? +

Returns DOM element bound to the current component.

Return
+DOM element

+ + 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 @@ + + + +Component - kvision + + + +kvision / pl.treksoft.kvision.core / Component
+
+

Component

+interface Component +

Base interface for all components.

Properties

+ + + + + + + + + + + +

+ parent +	+`abstract var parent: Component?` + Parent of the current component. +
+ visible +	+`abstract var visible: Boolean` + Visibility state of the current component. +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ addCssClass +	+`abstract fun addCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`abstract fun addSurroundingCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ getElement +	+`abstract fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`abstract fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`abstract fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ removeCssClass +	+`abstract fun removeCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeSurroundingCssClass +	+`abstract fun removeSurroundingCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of parent component. +

Inheritors

+ + + + + + + + + + + + + + + +

+ Container +	+`interface Container : Component` + Base interface for all containers. +
+ FormControl +	+`interface FormControl : Component` + Base interface of a form control. +
+ StyledComponent +	+`abstract class StyledComponent : Component` + Base class for components supporting CSS styling. +

+ + 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 @@ + + + +Component.parent - kvision + + + +kvision / pl.treksoft.kvision.core / Component / parent
+
+

parent

+ +abstract var parent: Component? +

Parent of the current component.

+ + 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 @@ + + + +Component.removeCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Component / removeCssClass
+
+

removeCssClass

+ +abstract fun removeCssClass(css: String): Component +

Removes given value from the set of CSS classes generated in html code of current component.

Parameters

+css - CSS class name

Return
+current component

+ + 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 @@ + + + +Component.removeSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Component / removeSurroundingCssClass
+
+

removeSurroundingCssClass

+ +abstract fun removeSurroundingCssClass(css: String): Component +

Removes given value from the set of CSS classes generated in html code of parent component.

Parameters

+css - CSS class name

Return
+current component

+ + 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 @@ + + + +Component.visible - kvision + + + +kvision / pl.treksoft.kvision.core / Component / visible
+
+

visible

+ +abstract var visible: Boolean +

Visibility state of the current component.

+ + -- cgit