From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-widget-wrapper/-init-.html | 21 +++ .../-widget-wrapper/index.html | 146 +++++++++++++++++++++ .../-widget-wrapper/render.html | 18 +++ .../-widget-wrapper/visible.html | 16 +++ .../-widget-wrapper/widget-wrapper.html | 16 +++ 5 files changed, 217 insertions(+) create mode 100644 api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html create mode 100644 api/pl.treksoft.kvision.core/-widget-wrapper/index.html create mode 100644 api/pl.treksoft.kvision.core/-widget-wrapper/render.html create mode 100644 api/pl.treksoft.kvision.core/-widget-wrapper/visible.html create mode 100644 api/pl.treksoft.kvision.core/-widget-wrapper/widget-wrapper.html (limited to 'api/pl.treksoft.kvision.core/-widget-wrapper') diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html b/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html new file mode 100644 index 00000000..191683d7 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html @@ -0,0 +1,21 @@ + + + +WidgetWrapper.<init> - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper / <init>
+
+

<init>

+ +WidgetWrapper(wrapped: Component?, classes: Set<String> = setOf()) +

Parameters

+wrapped - wrapped component

+classes - Set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/index.html b/api/pl.treksoft.kvision.core/-widget-wrapper/index.html new file mode 100644 index 00000000..6db540f8 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/index.html @@ -0,0 +1,146 @@ + + + +WidgetWrapper - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper
+
+

WidgetWrapper

+open class WidgetWrapper : SimplePanel +

This class allows to wrap a component into separately styled DIV element.

Constructors

+ + + + + + + +

<init>

+WidgetWrapper(wrapped: Component?, classes: Set<String> = setOf())

Properties

+ + + + + + + +

visible

+open var visible: Boolean

Functions

+ + + + + + + +

render

+open fun render(): VNode +

Renders current component as a Snabbdom vnode.

Inherited Functions

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +

Companion Object Functions

+ + + + + + + +

widgetWrapper

fun Container.widgetWrapper(wrapped: Component?, classes: Set<String> = setOf(), init: WidgetWrapper.() -> Unit = null): WidgetWrapper

DSL builder extension function.

Inheritors

+ + + + + + + +

GridWrapper

+class GridWrapper : WidgetWrapper

+ + diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/render.html b/api/pl.treksoft.kvision.core/-widget-wrapper/render.html new file mode 100644 index 00000000..577b695c --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/render.html @@ -0,0 +1,18 @@ + + + +WidgetWrapper.render - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html b/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html new file mode 100644 index 00000000..4c6d0cc0 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html @@ -0,0 +1,16 @@ + + + +WidgetWrapper.visible - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper / visible
+
+

visible

+ +open var visible: Boolean +

Overrides Widget.visible

Overrides Component.visible

+ + diff --git a/api/pl.treksoft.kvision.core/-widget-wrapper/widget-wrapper.html b/api/pl.treksoft.kvision.core/-widget-wrapper/widget-wrapper.html new file mode 100644 index 00000000..8a9ef6c5 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-widget-wrapper/widget-wrapper.html @@ -0,0 +1,16 @@ + + + +WidgetWrapper.widgetWrapper - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper / widgetWrapper
+
+

widgetWrapper

+ +

fun Container.widgetWrapper(wrapped: Component?, classes: Set<String> = setOf(), init: WidgetWrapper.() -> Unit = null): WidgetWrapper

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + -- cgit