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 --- .../-widget-wrapper/-init-.html | 21 ++ .../-widget-wrapper/index.html | 304 +++++++++++++++++++++ .../-widget-wrapper/render.html | 18 ++ .../-widget-wrapper/visible.html | 22 ++ 4 files changed, 365 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget-wrapper/index.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget-wrapper/render.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget-wrapper/visible.html (limited to 'docs/api/pl.treksoft.kvision.core/-widget-wrapper') diff --git a/docs/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html b/docs/api/pl.treksoft.kvision.core/-widget-wrapper/-init-.html new file mode 100644 index 00000000..191683d7 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.core/-widget-wrapper/index.html b/docs/api/pl.treksoft.kvision.core/-widget-wrapper/index.html new file mode 100644 index 00000000..ac06f2ec --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget-wrapper/index.html @@ -0,0 +1,304 @@ + + + +WidgetWrapper - kvision + + + +kvision / pl.treksoft.kvision.core / WidgetWrapper
+
+

WidgetWrapper

+open class WidgetWrapper : Widget +

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 +

Visibility state of the current component.

Inherited Properties

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

+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ parent +	+`open var parent: Component?` + Parent of the current component. +
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ title +	+`var title: String?` + A title attribute of generated HTML element. +

Functions

+ + + + + + + +

render

+open fun render(): VNode +

Renders current component as a Snabbdom vnode.

Inherited Functions

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

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ afterPostpatch +	+`open fun afterPostpatch(node: VNode): Unit` + Method called after updating Snabbdom vnode. +
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +

Inheritors

+ + + + + + + +

GridWrapper

+class GridWrapper : WidgetWrapper

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget-wrapper/render.html b/docs/api/pl.treksoft.kvision.core/-widget-wrapper/render.html new file mode 100644 index 00000000..311aec9c --- /dev/null +++ b/docs/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 Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

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

visible

+ +open var visible: Boolean +

Overrides Widget.visible

Visibility state of the current component.

Getter
+

Visibility state of the current component.

Setter
+

Visibility state of the current component.

+ + -- cgit