From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-component/add-css-class.html | 28 +++ .../-component/add-surrounding-css-class.html | 28 +++ .../-component/get-attribute.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 | 193 +++++++++++++++++++++ .../-component/parent.html | 15 ++ .../-component/remove-attribute.html | 18 ++ .../-component/remove-css-class.html | 28 +++ .../-component/remove-surrounding-css-class.html | 28 +++ .../-component/set-attribute.html | 20 +++ .../-component/visible.html | 15 ++ 13 files changed, 444 insertions(+) create mode 100644 api1/pl.treksoft.kvision.core/-component/add-css-class.html create mode 100644 api1/pl.treksoft.kvision.core/-component/add-surrounding-css-class.html create mode 100644 api1/pl.treksoft.kvision.core/-component/get-attribute.html create mode 100644 api1/pl.treksoft.kvision.core/-component/get-element-j-query-d.html create mode 100644 api1/pl.treksoft.kvision.core/-component/get-element-j-query.html create mode 100644 api1/pl.treksoft.kvision.core/-component/get-element.html create mode 100644 api1/pl.treksoft.kvision.core/-component/index.html create mode 100644 api1/pl.treksoft.kvision.core/-component/parent.html create mode 100644 api1/pl.treksoft.kvision.core/-component/remove-attribute.html create mode 100644 api1/pl.treksoft.kvision.core/-component/remove-css-class.html create mode 100644 api1/pl.treksoft.kvision.core/-component/remove-surrounding-css-class.html create mode 100644 api1/pl.treksoft.kvision.core/-component/set-attribute.html create mode 100644 api1/pl.treksoft.kvision.core/-component/visible.html (limited to 'api1/pl.treksoft.kvision.core/-component') 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 @@ + + + +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

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

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

Parameters

+css - CSS style object

Return
+current component

+ + 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 @@ + + + +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

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

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

Parameters

+css - CSS style object

Return
+current component

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

getAttribute

+ +abstract fun getAttribute(name: String): String? +

Returns the value of an additional attribute.

Parameters

+name - the name of the attribute

Return
+the value of the attribute

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

Component

+interface Component +

Base interface for all components.

Properties

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

+ parent +	+`abstract var parent: Container?` + 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. +`abstract fun addCssClass(css: Style): Component` + Adds given style object 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. +`abstract fun addSurroundingCssClass(css: Style): Component` + Adds given style object to the set of CSS classes generated in html code of parent component. +
+ getAttribute +	+`abstract fun getAttribute(name: String): String?` + Returns the value of an additional attribute. +
+ 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. +
+ removeAttribute +	+`abstract fun removeAttribute(name: String): Component` + Removes the value of additional attribute. +
+ removeCssClass +	+`abstract fun removeCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of current component. +`abstract fun removeCssClass(css: Style): Component` + Removes given style object 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. +`abstract fun removeSurroundingCssClass(css: Style): Component` + Removes given style object from the set of CSS classes generated in html code of parent component. +
+ setAttribute +	+`abstract fun setAttribute(name: String, value: String): Component` + Sets the value of additional attribute. +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

Inheritors

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

+ Container +	+`interface Container : Component` + Base interface for all containers. +
+ FormControl +	+`interface FormControl : Component` + Base interface of a form control. +
+ FormInput +	+`interface FormInput : Component`
+ Widget +	+`open class Widget : StyledComponent, Component` + Base widget class. The parent of all component classes. +

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

parent

+ +abstract var parent: Container? +

Parent of the current component.

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

removeAttribute

+ +abstract fun removeAttribute(name: String): Component +

Removes the value of additional attribute.

Parameters

+name - the name of the attribute

+ + 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 @@ + + + +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

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

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

Parameters

+css - CSS style object

Return
+current component

+ + 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 @@ + + + +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

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

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

Parameters

+css - CSS style object

Return
+current component

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

setAttribute

+ +abstract fun setAttribute(name: String, value: String): Component +

Sets the value of additional attribute.

Parameters

+name - the name of the attribute

+value - the value of the attribute

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

visible

+ +abstract var visible: Boolean +

Visibility state of the current component.

+ + -- cgit