From a8ff23c5e58394c21e2e7c2a4880302b43b60dfd Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 16 May 2019 15:06:28 +0200 Subject: API documentation for KVision 0.0.36 --- .../-simple-select/-init-.html | 29 ++ .../-simple-select/add-all.html | 21 ++ .../-simple-select/add.html | 21 ++ .../-simple-select/autofocus.html | 15 + .../-simple-select/blur.html | 16 ++ .../-simple-select/empty-option.html | 15 + .../-simple-select/flabel.html | 16 ++ .../-simple-select/focus.html | 16 ++ .../-simple-select/get-children.html | 18 ++ .../-simple-select/get-sn-class.html | 18 ++ .../-simple-select/index.html | 305 +++++++++++++++++++++ .../-simple-select/input.html | 16 ++ .../-simple-select/label.html | 15 + .../-simple-select/options.html | 15 + .../-simple-select/remove-all.html | 18 ++ .../-simple-select/remove-event-listeners.html | 18 ++ .../-simple-select/remove.html | 21 ++ .../-simple-select/rich.html | 15 + .../-simple-select/set-event-listener.html | 54 ++++ .../-simple-select/simple-select.html | 16 ++ .../-simple-select/start-value.html | 17 ++ .../-simple-select/validation-info.html | 16 ++ .../-simple-select/value.html | 16 ++ 23 files changed, 727 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/add-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/add.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/blur.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/flabel.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/focus.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/get-children.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/input.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/label.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/options.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/remove-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/remove.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/rich.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/simple-select.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/start-value.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select/value.html (limited to 'api/pl.treksoft.kvision.form.select/-simple-select') diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/-init-.html b/api/pl.treksoft.kvision.form.select/-simple-select/-init-.html new file mode 100644 index 00000000..2d31d4bb --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/-init-.html @@ -0,0 +1,29 @@ + + + +SimpleSelect.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / <init>
+
+

<init>

+ +

SimpleSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)

Parameters

+options - an optional list of options (value to label pairs) for the select control

+value - selected value

+emptyOption - determines if an empty option is automatically generated

+name - the name attribute of the generated HTML input element

+label - label text bound to the input element

+rich - determines if label can contain HTML code

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/add-all.html b/api/pl.treksoft.kvision.form.select/-simple-select/add-all.html new file mode 100644 index 00000000..54b52223 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/add-all.html @@ -0,0 +1,21 @@ + + + +SimpleSelect.addAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): SimplePanel +

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/add.html b/api/pl.treksoft.kvision.form.select/-simple-select/add.html new file mode 100644 index 00000000..554ad8de --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/add.html @@ -0,0 +1,21 @@ + + + +SimpleSelect.add - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / add
+
+

add

+ +open fun add(child: Component): SimplePanel +

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html b/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html new file mode 100644 index 00000000..8999ec7a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html @@ -0,0 +1,15 @@ + + + +SimpleSelect.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the select is automatically focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/blur.html b/api/pl.treksoft.kvision.form.select/-simple-select/blur.html new file mode 100644 index 00000000..b8dc4b27 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/blur.html @@ -0,0 +1,16 @@ + + + +SimpleSelect.blur - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html b/api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html new file mode 100644 index 00000000..3b0937ab --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html @@ -0,0 +1,15 @@ + + + +SimpleSelect.emptyOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / emptyOption
+
+

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/flabel.html b/api/pl.treksoft.kvision.form.select/-simple-select/flabel.html new file mode 100644 index 00000000..5f7f26d4 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/flabel.html @@ -0,0 +1,16 @@ + + + +SimpleSelect.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

Form field label.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/focus.html b/api/pl.treksoft.kvision.form.select/-simple-select/focus.html new file mode 100644 index 00000000..a6d46141 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/focus.html @@ -0,0 +1,16 @@ + + + +SimpleSelect.focus - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / focus
+
+

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/get-children.html b/api/pl.treksoft.kvision.form.select/-simple-select/get-children.html new file mode 100644 index 00000000..114f4013 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/get-children.html @@ -0,0 +1,18 @@ + + + +SimpleSelect.getChildren - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / getChildren
+
+

getChildren

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

Overrides SimplePanel.getChildren

Returns a list of children of the current container.

Return
+list of children

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-simple-select/get-sn-class.html new file mode 100644 index 00000000..e05e0edf --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/get-sn-class.html @@ -0,0 +1,18 @@ + + + +SimpleSelect.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / getSnClass
+
+

getSnClass

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

Overrides Widget.getSnClass

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

Return
+list of CSS class names

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/index.html b/api/pl.treksoft.kvision.form.select/-simple-select/index.html new file mode 100644 index 00000000..4a4d80bd --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/index.html @@ -0,0 +1,305 @@ + + + +SimpleSelect - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect
+
+

SimpleSelect

+open class SimpleSelect : SimplePanel, StringFormControl +

The form field component for SimpleSelect control.

Constructors

+ + + + + + + +

<init>

SimpleSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the select is automatically focused. +
+ emptyOption +	+`var emptyOption: Boolean` + Determines if an empty option is automatically generated. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ input +	+`val input: SimpleSelectInput` + The actual input component. +
+ label +	+`var label: String?` + The label text bound to the select element. +
+ options +	+`var options: List<StringPair>?` + A list of options (value to label pairs) for the select control. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ startValue +	+`var startValue: String?` + The value of the selected child option. +
+ validationInfo +	+`val validationInfo: HelpBlock` + Validation info component. +
+ value +	+`open var value: String?` + A value of the selected option. +

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. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ 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. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ 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. +

Inherited Functions

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

+ 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. +
+ getValue +	+`open fun getValue(): String?` + Returns the value of the control. +
+ getValueAsString +	+`open fun getValueAsString(): String?` + Returns the value of the control as a String. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ setValue +	+`open fun setValue(v: Any?): Unit` + Sets the value of the control. +

Companion Object Functions

+ + + + + + + +

simpleSelect

fun Container.simpleSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (SimpleSelect.() -> Unit)? = null): SimpleSelect

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/input.html b/api/pl.treksoft.kvision.form.select/-simple-select/input.html new file mode 100644 index 00000000..cfabd4f7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/input.html @@ -0,0 +1,16 @@ + + + +SimpleSelect.input - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / input
+
+

input

+ +val input: SimpleSelectInput +

Overrides FormControl.input

The actual input component.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/label.html b/api/pl.treksoft.kvision.form.select/-simple-select/label.html new file mode 100644 index 00000000..8f2ae01e --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/label.html @@ -0,0 +1,15 @@ + + + +SimpleSelect.label - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / label
+
+

label

+ +var label: String? +

The label text bound to the select element.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/options.html b/api/pl.treksoft.kvision.form.select/-simple-select/options.html new file mode 100644 index 00000000..6b56e20e --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/options.html @@ -0,0 +1,15 @@ + + + +SimpleSelect.options - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / options
+
+

options

+ +var options: List<StringPair>? +

A list of options (value to label pairs) for the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/remove-all.html b/api/pl.treksoft.kvision.form.select/-simple-select/remove-all.html new file mode 100644 index 00000000..df6e12bd --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/remove-all.html @@ -0,0 +1,18 @@ + + + +SimpleSelect.removeAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/remove-event-listeners.html b/api/pl.treksoft.kvision.form.select/-simple-select/remove-event-listeners.html new file mode 100644 index 00000000..b5410b38 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +SimpleSelect.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

Removes all event listeners from current widget.

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/remove.html b/api/pl.treksoft.kvision.form.select/-simple-select/remove.html new file mode 100644 index 00000000..7c8b5f91 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/remove.html @@ -0,0 +1,21 @@ + + + +SimpleSelect.remove - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / remove
+
+

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/rich.html b/api/pl.treksoft.kvision.form.select/-simple-select/rich.html new file mode 100644 index 00000000..76cadb21 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/rich.html @@ -0,0 +1,15 @@ + + + +SimpleSelect.rich - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/set-event-listener.html b/api/pl.treksoft.kvision.form.select/-simple-select/set-event-listener.html new file mode 100644 index 00000000..9c01ab57 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/set-event-listener.html @@ -0,0 +1,54 @@ + + + +SimpleSelect.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / setEventListener
+
+

setEventListener

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

Overrides Widget.setEventListener

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 +

Overrides Widget.setEventListener

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/api/pl.treksoft.kvision.form.select/-simple-select/simple-select.html b/api/pl.treksoft.kvision.form.select/-simple-select/simple-select.html new file mode 100644 index 00000000..8c49f2fb --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select/simple-select.html @@ -0,0 +1,16 @@ + + + +SimpleSelect.simpleSelect - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelect / simpleSelect
+
+

simpleSelect

+ +fun Container.simpleSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: