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 --- .../pl.treksoft.kvision.core/-widget/-init-.html | 20 + .../-widget/add-css-class.html | 21 + .../-widget/add-surrounding-css-class.html | 21 + .../-widget/after-create.html | 15 + .../-widget/after-destroy.html | 15 + .../-widget/after-insert.html | 15 + .../-widget/after-postpatch.html | 15 + .../-widget/get-element-j-query-d.html | 18 + .../-widget/get-element-j-query.html | 18 + .../-widget/get-element.html | 18 + .../-widget/get-sn-attrs.html | 17 + .../-widget/get-sn-class.html | 17 + .../-widget/get-sn-hooks.html | 17 + .../-widget/get-sn-on.html | 17 + .../api/pl.treksoft.kvision.core/-widget/hide.html | 17 + docs/api/pl.treksoft.kvision.core/-widget/id.html | 15 + .../pl.treksoft.kvision.core/-widget/index.html | 634 +++++++++++++++++++++ .../pl.treksoft.kvision.core/-widget/parent.html | 16 + .../-widget/remove-css-class.html | 21 + .../-widget/remove-event-listeners.html | 17 + .../-widget/remove-surrounding-css-class.html | 21 + .../pl.treksoft.kvision.core/-widget/render.html | 35 ++ .../api/pl.treksoft.kvision.core/-widget/role.html | 15 + .../-widget/set-event-listener.html | 52 ++ .../api/pl.treksoft.kvision.core/-widget/show.html | 17 + .../pl.treksoft.kvision.core/-widget/title.html | 15 + .../-widget/toggle-visible.html | 17 + .../pl.treksoft.kvision.core/-widget/visible.html | 19 + 28 files changed, 1155 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/add-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/after-create.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/after-destroy.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/after-postpatch.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-element.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/get-sn-on.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/hide.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/id.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/index.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/parent.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/remove-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/remove-event-listeners.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/render.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/role.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/set-event-listener.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/show.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/title.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/toggle-visible.html create mode 100644 docs/api/pl.treksoft.kvision.core/-widget/visible.html (limited to 'docs/api/pl.treksoft.kvision.core/-widget') diff --git a/docs/api/pl.treksoft.kvision.core/-widget/-init-.html b/docs/api/pl.treksoft.kvision.core/-widget/-init-.html new file mode 100644 index 00000000..3d40fa05 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/-init-.html @@ -0,0 +1,20 @@ + + + +Widget.<init> - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / <init>
+
+

<init>

+ +Widget(classes: Set<String> = setOf()) +

Creates basic Widget with given CSS class names.

+

Parameters

+

+classes - Set of CSS class names

+

Constructor
+Creates basic Widget with given CSS class names.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/add-css-class.html b/docs/api/pl.treksoft.kvision.core/-widget/add-css-class.html new file mode 100644 index 00000000..6f78cf17 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/add-css-class.html @@ -0,0 +1,21 @@ + + + +Widget.addCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / addCssClass
+
+

addCssClass

+ +open fun addCssClass(css: String): Widget +

Overrides Component.addCssClass

+

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/-widget/add-surrounding-css-class.html b/docs/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html new file mode 100644 index 00000000..ddcf07ae --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/add-surrounding-css-class.html @@ -0,0 +1,21 @@ + + + +Widget.addSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / addSurroundingCssClass
+
+

addSurroundingCssClass

+ +open fun addSurroundingCssClass(css: String): Widget +

Overrides Component.addSurroundingCssClass

+

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/-widget/after-create.html b/docs/api/pl.treksoft.kvision.core/-widget/after-create.html new file mode 100644 index 00000000..eddad85d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/after-create.html @@ -0,0 +1,15 @@ + + + +Widget.afterCreate - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / afterCreate
+
+

afterCreate

+ +protected open fun afterCreate(node: VNode): Unit +

Method called after creating Snabbdom vnode.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/after-destroy.html b/docs/api/pl.treksoft.kvision.core/-widget/after-destroy.html new file mode 100644 index 00000000..cfdc5f09 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/after-destroy.html @@ -0,0 +1,15 @@ + + + +Widget.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/after-insert.html b/docs/api/pl.treksoft.kvision.core/-widget/after-insert.html new file mode 100644 index 00000000..04ed6c72 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/after-insert.html @@ -0,0 +1,15 @@ + + + +Widget.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/after-postpatch.html b/docs/api/pl.treksoft.kvision.core/-widget/after-postpatch.html new file mode 100644 index 00000000..48e0fe23 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/after-postpatch.html @@ -0,0 +1,15 @@ + + + +Widget.afterPostpatch - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / afterPostpatch
+
+

afterPostpatch

+ +protected open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html b/docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html new file mode 100644 index 00000000..18f83cee --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query-d.html @@ -0,0 +1,18 @@ + + + +Widget.getElementJQueryD - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getElementJQueryD
+
+

getElementJQueryD

+ +open fun getElementJQueryD(): dynamic +

Overrides Component.getElementJQueryD

+

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/-widget/get-element-j-query.html b/docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html new file mode 100644 index 00000000..ea593270 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-element-j-query.html @@ -0,0 +1,18 @@ + + + +Widget.getElementJQuery - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getElementJQuery
+
+

getElementJQuery

+ +open fun getElementJQuery(): JQuery? +

Overrides Component.getElementJQuery

+

Returns JQuery element bound to the current component.

+

Return
+JQuery element

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-element.html b/docs/api/pl.treksoft.kvision.core/-widget/get-element.html new file mode 100644 index 00000000..440bd249 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-element.html @@ -0,0 +1,18 @@ + + + +Widget.getElement - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getElement
+
+

getElement

+ +open fun getElement(): Node? +

Overrides Component.getElement

+

Returns DOM element bound to the current component.

+

Return
+DOM element

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html new file mode 100644 index 00000000..d884aedf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-attrs.html @@ -0,0 +1,17 @@ + + + +Widget.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Returns list of element attributes in the form of a List.

+

Return
+list of element attributes

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-sn-class.html b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-class.html new file mode 100644 index 00000000..9e93c61e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-class.html @@ -0,0 +1,17 @@ + + + +Widget.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+

Return
+list of CSS class names

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html new file mode 100644 index 00000000..0d34c2f7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-hooks.html @@ -0,0 +1,17 @@ + + + +Widget.getSnHooks - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getSnHooks
+
+

getSnHooks

+ +protected open fun getSnHooks(): Hooks? +

Returns list of hooks in the form of a Snabbdom Hooks object.

+

Return
+list of hooks

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/get-sn-on.html b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-on.html new file mode 100644 index 00000000..1bdb14a3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/get-sn-on.html @@ -0,0 +1,17 @@ + + + +Widget.getSnOn - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / getSnOn
+
+

getSnOn

+ +protected open fun getSnOn(): On? +

Returns list of event handlers in the form of a Snabbdom On object.

+

Return
+list of event handlers

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/hide.html b/docs/api/pl.treksoft.kvision.core/-widget/hide.html new file mode 100644 index 00000000..ac375539 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/hide.html @@ -0,0 +1,17 @@ + + + +Widget.hide - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / hide
+
+

hide

+ +open fun hide(): Widget +

Makes current widget invisible.

+

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/id.html b/docs/api/pl.treksoft.kvision.core/-widget/id.html new file mode 100644 index 00000000..b2df32cd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/id.html @@ -0,0 +1,15 @@ + + + +Widget.id - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / id
+
+

id

+ +var id: String? +

An ID attribute of generated HTML element.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/index.html b/docs/api/pl.treksoft.kvision.core/-widget/index.html new file mode 100644 index 00000000..7fc8cf3d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/index.html @@ -0,0 +1,634 @@ + + + +Widget - kvision + + + +kvision / pl.treksoft.kvision.core / Widget
+
+

Widget

+open class Widget : StyledComponent +

Base widget class. The parent of all component classes.

+

A simple widget is rendered as HTML DIV element.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Widget(classes: Set<String> = setOf()) +

Creates basic Widget with given CSS class names.

+
+

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.

+
+

visible

+		 +open var visible: Boolean +

Visibility state of the current component.

+
+

Inherited Properties

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

background

+		 +var background: Background? +

Background of the current component.

+
+

border

+		 +var border: Border? +

Border of the current component.

+
+

borderBottom

+		 +var borderBottom: Border? +

Bottom border of the current component.

+
+

borderLeft

+		 +var borderLeft: Border? +

Left border of the current component.

+
+

borderRight

+		 +var borderRight: Border? +

Right border of the current component.

+
+

borderTop

+		 +var borderTop: Border? +

Top border of the current component.

+
+

color

+		 +var color: Color? +

Text color for the current component.

+
+

colorHex

+		 +var colorHex: Int? +

Text color for the current component given in hex format (write only).

+
+

colorName

+		 +var colorName: COLOR? +

Text color for the current component given with named constant (write only).

+
+

height

+		 +var height: CssSize? +

Height of the current component.

+
+

margin

+		 +var margin: CssSize? +

Margin of the current component.

+
+

marginBottom

+		 +var marginBottom: CssSize? +

Bottom margin of the current component.

+
+

marginLeft

+		 +var marginLeft: CssSize? +

Left margin of the current component.

+
+

marginRight

+		 +var marginRight: CssSize? +

Right margin of the current component.

+
+

marginTop

+		 +var marginTop: CssSize? +

Top margin of the current component.

+
+

maxHeight

+		 +var maxHeight: CssSize? +

Maximal height of the current component.

+
+

maxWidth

+		 +var maxWidth: CssSize? +

Maximal width of the current component.

+
+

minHeight

+		 +var minHeight: CssSize? +

Minimal height of the current component.

+
+

minWidth

+		 +var minWidth: CssSize? +

Minimal width of the current component.

+
+

opacity

+		 +var opacity: Double? +

Opacity of the current component.

+
+

padding

+		 +var padding: CssSize? +

Padding of the current component.

+
+

paddingBottom

+		 +var paddingBottom: CssSize? +

Bottom padding of the current component.

+
+

paddingLeft

+		 +var paddingLeft: CssSize? +

Left padding of the current component.

+
+

paddingRight

+		 +var paddingRight: CssSize? +

Right padding of the current component.

+
+

paddingTop

+		 +var paddingTop: CssSize? +

Top padding of the current component.

+
+

width

+		 +open var width: CssSize? +

Width of the current component.

+
+

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(): VNode
+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.

+
+

Inherited Functions

+ + + + + + + +
+

getSnStyle

+		 +open fun getSnStyle(): List<StringPair> +

Returns the list of String pairs defining CSS style attributes and their values.

+
+

Inheritors

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

AbstractTextInput

+		 +abstract class AbstractTextInput : Widget +

Base class for basic text components.

+
+

Button

+		 +open class Button : Widget +

Button component.

+
+

CheckInput

+		 +open class CheckInput : Widget +

The basic input component rendered as HTML input type="checkbox" or input type="radio".

+
+

CloseIcon

+		 +open class CloseIcon : Widget +

Helper class for close icon component.

+
+

DataContainer

+		 +class DataContainer<M : DataComponent, C : Component> : Widget, Container, DataUpdatable +

A container class with support for observable data model.

+
+

DateTimeInput

+		 +open class DateTimeInput : Widget +

Basic date/time chooser component.

+
+

Image

+		 +open class Image : Widget +

Image component.

+
+

SelectOption

+		 +open class SelectOption : Widget +

The helper component for adding options to Select or SelectOptGroup.

+
+

SimplePanel

+		 +open class SimplePanel : Widget, Container +

Basic container class, rendered as a DIV element with all children directly within.

+
+

SpinnerInput

+		 +open class SpinnerInput : Widget +

The basic component for spinner control.

+
+

WidgetWrapper

+		 +open class WidgetWrapper : Widget +

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

+
+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/parent.html b/docs/api/pl.treksoft.kvision.core/-widget/parent.html new file mode 100644 index 00000000..c841d124 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/parent.html @@ -0,0 +1,16 @@ + + + +Widget.parent - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / parent
+
+

parent

+ +open var parent: Component? +

Overrides Component.parent

+

Parent of the current component.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/remove-css-class.html b/docs/api/pl.treksoft.kvision.core/-widget/remove-css-class.html new file mode 100644 index 00000000..9db6b40b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/remove-css-class.html @@ -0,0 +1,21 @@ + + + +Widget.removeCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / removeCssClass
+
+

removeCssClass

+ +open fun removeCssClass(css: String): Widget +

Overrides Component.removeCssClass

+

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/-widget/remove-event-listeners.html b/docs/api/pl.treksoft.kvision.core/-widget/remove-event-listeners.html new file mode 100644 index 00000000..eacadb04 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/remove-event-listeners.html @@ -0,0 +1,17 @@ + + + +Widget.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Removes all event listeners from current widget.

+

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html b/docs/api/pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html new file mode 100644 index 00000000..c2997166 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/remove-surrounding-css-class.html @@ -0,0 +1,21 @@ + + + +Widget.removeSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / removeSurroundingCssClass
+
+

removeSurroundingCssClass

+ +open fun removeSurroundingCssClass(css: String): Widget +

Overrides Component.removeSurroundingCssClass

+

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/-widget/render.html b/docs/api/pl.treksoft.kvision.core/-widget/render.html new file mode 100644 index 00000000..a4569c99 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/render.html @@ -0,0 +1,35 @@ + + + +Widget.render - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / render
+
+

render

+ +protected open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

+ +protected open fun render(elementName: String): VNode +

Renders current component as a Snabbdom vnode.

+

Parameters

+

+elementName - HTML element name

+

Return
+Snabbdom vnode

+ +protected open fun render(elementName: String, children: Array<dynamic>): VNode +

Renders current component as a Snabbdom vnode.

+

Parameters

+

+elementName - HTML element name

+

+children - array of children nodes

+

Return
+Snabbdom vnode

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/role.html b/docs/api/pl.treksoft.kvision.core/-widget/role.html new file mode 100644 index 00000000..1b08d3b9 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/role.html @@ -0,0 +1,15 @@ + + + +Widget.role - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / role
+
+

role

+ +var role: String? +

A role attribute of generated HTML element.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/set-event-listener.html b/docs/api/pl.treksoft.kvision.core/-widget/set-event-listener.html new file mode 100644 index 00000000..d87e5cec --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/set-event-listener.html @@ -0,0 +1,52 @@ + + + +Widget.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / setEventListener
+
+

setEventListener

+ +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Sets an event listener for current widget, keeping the actual type of component.

+

Parameters

+

+T - widget type

+

+block - event handler

+

Return
+

current widget

+ + +

Example:

+ + +
    button.setEventListener<Button> {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Button here
+        }
+    }

+ +open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Sets an event listener for current widget.

+

Parameters

+

+block - event handler

+

Return
+

current widget

+ + +

Example:

+ + +
    button.setEventListener {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Widget here
+        }
+    }

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/show.html b/docs/api/pl.treksoft.kvision.core/-widget/show.html new file mode 100644 index 00000000..05e0f752 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/show.html @@ -0,0 +1,17 @@ + + + +Widget.show - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / show
+
+

show

+ +open fun show(): Widget +

Makes current widget visible.

+

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/title.html b/docs/api/pl.treksoft.kvision.core/-widget/title.html new file mode 100644 index 00000000..98fe3eda --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/title.html @@ -0,0 +1,15 @@ + + + +Widget.title - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / title
+
+

title

+ +var title: String? +

A title attribute of generated HTML element.

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/toggle-visible.html b/docs/api/pl.treksoft.kvision.core/-widget/toggle-visible.html new file mode 100644 index 00000000..8e7aa167 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/toggle-visible.html @@ -0,0 +1,17 @@ + + + +Widget.toggleVisible - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / toggleVisible
+
+

toggleVisible

+ +open fun toggleVisible(): Widget +

Toggles visibility of current widget.

+

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.core/-widget/visible.html b/docs/api/pl.treksoft.kvision.core/-widget/visible.html new file mode 100644 index 00000000..927159f6 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.core/-widget/visible.html @@ -0,0 +1,19 @@ + + + +Widget.visible - kvision + + + +kvision / pl.treksoft.kvision.core / Widget / visible
+
+

visible

+ +open var visible: Boolean +

Overrides Component.visible

+

Visibility state of the current component.

+

Setter
+

Visibility state of the current component.

+

+ + -- cgit