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 --- .../-container/add-all.html | 20 ++ api1/pl.treksoft.kvision.core/-container/add.html | 20 ++ .../-container/get-children.html | 17 ++ .../pl.treksoft.kvision.core/-container/index.html | 236 +++++++++++++++++++++ .../-container/invoke.html | 20 ++ .../-container/remove-all.html | 17 ++ .../-container/remove.html | 20 ++ 7 files changed, 350 insertions(+) create mode 100644 api1/pl.treksoft.kvision.core/-container/add-all.html create mode 100644 api1/pl.treksoft.kvision.core/-container/add.html create mode 100644 api1/pl.treksoft.kvision.core/-container/get-children.html create mode 100644 api1/pl.treksoft.kvision.core/-container/index.html create mode 100644 api1/pl.treksoft.kvision.core/-container/invoke.html create mode 100644 api1/pl.treksoft.kvision.core/-container/remove-all.html create mode 100644 api1/pl.treksoft.kvision.core/-container/remove.html (limited to 'api1/pl.treksoft.kvision.core/-container') diff --git a/api1/pl.treksoft.kvision.core/-container/add-all.html b/api1/pl.treksoft.kvision.core/-container/add-all.html new file mode 100644 index 00000000..49408f67 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/add-all.html @@ -0,0 +1,20 @@ + + + +Container.addAll - kvision + + + +kvision / pl.treksoft.kvision.core / Container / addAll
+
+

addAll

+ +abstract fun addAll(children: List<Component>): Container +

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/add.html b/api1/pl.treksoft.kvision.core/-container/add.html new file mode 100644 index 00000000..97bcad9e --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/add.html @@ -0,0 +1,20 @@ + + + +Container.add - kvision + + + +kvision / pl.treksoft.kvision.core / Container / add
+
+

add

+ +abstract fun add(child: Component): Container +

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/get-children.html b/api1/pl.treksoft.kvision.core/-container/get-children.html new file mode 100644 index 00000000..60274443 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/get-children.html @@ -0,0 +1,17 @@ + + + +Container.getChildren - kvision + + + +kvision / pl.treksoft.kvision.core / Container / getChildren
+
+

getChildren

+ +abstract fun getChildren(): List<Component> +

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/index.html b/api1/pl.treksoft.kvision.core/-container/index.html new file mode 100644 index 00000000..56cf68c7 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/index.html @@ -0,0 +1,236 @@ + + + +Container - kvision + + + +kvision / pl.treksoft.kvision.core / Container
+
+

Container

+interface Container : Component +

Base interface for all containers.

Inherited Properties

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

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

Functions

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

+ add +	+`abstract fun add(child: Component): Container` + Adds given component to the current container. +
+ addAll +	+`abstract fun addAll(children: List<Component>): Container` + Adds a list of components to the current container. +
+ getChildren +	+`abstract fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ invoke +	+`open operator fun invoke(vararg children: Component): Container` + Operator function for adding children in a DSL style. +
+ remove +	+`abstract fun remove(child: Component): Container` + Removes given component from the current container. +
+ removeAll +	+`abstract fun removeAll(): Container` + Removes all children from the current container. +

Inherited 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

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

+ DataContainer +	+`class DataContainer<M, C : Component, CONT : Container> : Widget, Container, DataUpdatable` + A container class with support for mutable/observable data model. +
+ SimplePanel +	+`open class SimplePanel : Widget, Container` + Basic container class, rendered as a DIV element with all children directly within. +

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/invoke.html b/api1/pl.treksoft.kvision.core/-container/invoke.html new file mode 100644 index 00000000..367c8fb1 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/invoke.html @@ -0,0 +1,20 @@ + + + +Container.invoke - kvision + + + +kvision / pl.treksoft.kvision.core / Container / invoke
+
+

invoke

+ +open operator fun invoke(vararg children: Component): Container +

Operator function for adding children in a DSL style.

Parameters

+children - children components

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/remove-all.html b/api1/pl.treksoft.kvision.core/-container/remove-all.html new file mode 100644 index 00000000..84676301 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/remove-all.html @@ -0,0 +1,17 @@ + + + +Container.removeAll - kvision + + + +kvision / pl.treksoft.kvision.core / Container / removeAll
+
+

removeAll

+ +abstract fun removeAll(): Container +

Removes all children from the current container.

Return
+current container

+ + diff --git a/api1/pl.treksoft.kvision.core/-container/remove.html b/api1/pl.treksoft.kvision.core/-container/remove.html new file mode 100644 index 00000000..f1c609e1 --- /dev/null +++ b/api1/pl.treksoft.kvision.core/-container/remove.html @@ -0,0 +1,20 @@ + + + +Container.remove - kvision + + + +kvision / pl.treksoft.kvision.core / Container / remove
+
+

remove

+ +abstract fun remove(child: Component): Container +

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + -- cgit