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-input/-init-.html | 25 ++ .../-simple-select-input/after-insert.html | 16 ++ .../-simple-select-input/autofocus.html | 21 ++ .../-simple-select-input/blur.html | 16 ++ .../-simple-select-input/disabled.html | 22 ++ .../-simple-select-input/empty-option.html | 21 ++ .../-simple-select-input/focus.html | 16 ++ .../-simple-select-input/get-sn-attrs.html | 18 ++ .../-simple-select-input/get-sn-class.html | 18 ++ .../-simple-select-input/index.html | 258 +++++++++++++++++++++ .../-simple-select-input/name.html | 22 ++ .../-simple-select-input/options.html | 21 ++ .../-simple-select-input/render.html | 18 ++ .../-simple-select-input/simple-select-input.html | 16 ++ .../-simple-select-input/size.html | 22 ++ .../-simple-select-input/start-value.html | 27 +++ .../-simple-select-input/value.html | 21 ++ 17 files changed, 578 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/after-insert.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/blur.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/disabled.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/empty-option.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/focus.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/name.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/options.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/render.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/simple-select-input.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/size.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/start-value.html create mode 100644 api/pl.treksoft.kvision.form.select/-simple-select-input/value.html (limited to 'api/pl.treksoft.kvision.form.select/-simple-select-input') diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html new file mode 100644 index 00000000..9be0a933 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html @@ -0,0 +1,25 @@ + + + +SimpleSelectInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / <init>
+
+

<init>

+ +

SimpleSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, classes: Set<String> = setOf())

Parameters

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

+value - text input value

+emptyOption - determines if an empty option is automatically generated

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/after-insert.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/after-insert.html new file mode 100644 index 00000000..8cea1b69 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/after-insert.html @@ -0,0 +1,16 @@ + + + +SimpleSelectInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / afterInsert
+
+

afterInsert

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

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html new file mode 100644 index 00000000..91effa01 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html @@ -0,0 +1,21 @@ + + + +SimpleSelectInput.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the text input is automatically focused.

Getter
+

Determines if the text input is automatically focused.

Setter
+

Determines if the text input is automatically focused.

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

blur

+ +open fun blur(): Unit +

Overrides FormInput.blur

Makes the input element blur.

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

disabled

+ +open var disabled: Boolean +

Overrides FormInput.disabled

Determines if the field is disabled.

Getter
+

Determines if the field is disabled.

Setter
+

Determines if the field is disabled.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/empty-option.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/empty-option.html new file mode 100644 index 00000000..e2f45748 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/empty-option.html @@ -0,0 +1,21 @@ + + + +SimpleSelectInput.emptyOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / emptyOption
+
+

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

Getter
+

Determines if an empty option is automatically generated.

Setter
+

Determines if an empty option is automatically generated.

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

focus

+ +open fun focus(): Unit +

Overrides FormInput.focus

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-attrs.html new file mode 100644 index 00000000..724f20d7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +SimpleSelectInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / getSnAttrs
+
+

getSnAttrs

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

Overrides Widget.getSnAttrs

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

Return
+list of element attributes

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-class.html new file mode 100644 index 00000000..3e6bda58 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +SimpleSelectInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / 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-input/index.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html new file mode 100644 index 00000000..f7e858d7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html @@ -0,0 +1,258 @@ + + + +SimpleSelectInput - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput
+
+

SimpleSelectInput

+open class SimpleSelectInput : SimplePanel, FormInput +

Simple select component.

Constructors

+ + + + + + + +

<init>

SimpleSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, classes: Set<String> = setOf())

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ emptyOption +	+`var emptyOption: Boolean` + Determines if an empty option is automatically generated. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML input element. +
+ options +	+`var options: List<StringPair>?` + A list of options (value to label pairs) for the select control. +
+ size +	+`open var size: InputSize?` + The size of the input. +
+ startValue +	+`var startValue: String?` + The value of the selected child option. +
+ value +	+`var value: String?` + Text input value. +

Functions

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

+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ 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. +
+ 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

+ + + + + + + +

simpleSelectInput

fun Container.simpleSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, classes: Set<String> = setOf(), init: (SimpleSelectInput.() -> Unit)? = null): SimpleSelectInput

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/name.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/name.html new file mode 100644 index 00000000..51226aeb --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/name.html @@ -0,0 +1,22 @@ + + + +SimpleSelectInput.name - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / name
+
+

name

+ +open var name: String? +

Overrides FormInput.name

The name attribute of the generated HTML input element.

Getter
+

The name attribute of the generated HTML input element.

Setter
+

The name attribute of the generated HTML input element.

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

options

+ +var options: List<StringPair>? +

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

Getter
+

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

Setter
+

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

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/render.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/render.html new file mode 100644 index 00000000..53648da0 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/render.html @@ -0,0 +1,18 @@ + + + +SimpleSelectInput.render - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / 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.form.select/-simple-select-input/simple-select-input.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/simple-select-input.html new file mode 100644 index 00000000..55cc36b7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/simple-select-input.html @@ -0,0 +1,16 @@ + + + +SimpleSelectInput.simpleSelectInput - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / simpleSelectInput
+
+

simpleSelectInput

+ +

fun Container.simpleSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, classes: Set<String> = setOf(), init: (SimpleSelectInput.() -> Unit)? = null): SimpleSelectInput

DSL builder extension function.

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

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/size.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/size.html new file mode 100644 index 00000000..269cda90 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/size.html @@ -0,0 +1,22 @@ + + + +SimpleSelectInput.size - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / size
+
+

size

+ +open var size: InputSize? +

Overrides FormInput.size

The size of the input.

Getter
+

The size of the input.

Setter
+

The size of the input.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-simple-select-input/start-value.html b/api/pl.treksoft.kvision.form.select/-simple-select-input/start-value.html new file mode 100644 index 00000000..e7956d7e --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/start-value.html @@ -0,0 +1,27 @@ + + + +SimpleSelectInput.startValue - kvision + + + +kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / startValue
+
+

startValue

+ +var startValue: String? +

The value of the selected child option.

This value is placed directly in the generated HTML code, while the value property is dynamically +bound to the select component.

Getter
+

The value of the selected child option.

This value is placed directly in the generated HTML code, while the value property is dynamically +bound to the select component.

Setter
+

The value of the selected child option.

This value is placed directly in the generated HTML code, while the value property is dynamically +bound to the select component.

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

value

+ +var value: String? +

Text input value.

Getter
+

Text input value.

Setter
+

Text input value.

+ + -- cgit