From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-simple-select-input/-init-.html | 2 +- .../-simple-select-input/after-insert.html | 3 +- .../-simple-select-input/autofocus.html | 2 +- .../-simple-select-input/blur.html | 3 +- .../-simple-select-input/disabled.html | 3 +- .../-simple-select-input/empty-option.html | 2 +- .../-simple-select-input/focus.html | 3 +- .../-simple-select-input/get-sn-attrs.html | 3 +- .../-simple-select-input/get-sn-class.html | 3 +- .../-simple-select-input/index.html | 755 ++++++++++----------- .../-simple-select-input/name.html | 3 +- .../-simple-select-input/options.html | 2 +- .../-simple-select-input/render.html | 3 +- .../-simple-select-input/size.html | 3 +- .../-simple-select-input/start-value.html | 2 +- .../-simple-select-input/validation-status.html | 3 +- .../-simple-select-input/value.html | 2 +- 17 files changed, 357 insertions(+), 440 deletions(-) (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 index 9be0a933..5de8e059 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / <init>

<init>

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

Parameters

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 index 8cea1b69..4a8046b0 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / afterInsert

afterInsert

- +(js) 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 index 91effa01..57b1aab6 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the text input is automatically focused.

Getter
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 index a9503eb7..9e739d94 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/blur.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / blur

blur

- +(js) 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 index cd60e220..15e9eb16 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/disabled.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / disabled

disabled

- +(js) open var disabled: Boolean -

Overrides FormInput.disabled

Determines if the field is disabled.

Getter

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 index e2f45748..aac31871 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / emptyOption

emptyOption

- +(js) var emptyOption: Boolean

Determines if an empty option is automatically generated.

Getter
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 index 47988abf..67cf440e 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/focus.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / focus

focus

- +(js) 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 index 724f20d7..dba93718 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / getSnAttrs

getSnAttrs

- +(js) 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 index 3e6bda58..23598c7a 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput / getSnClass

getSnClass

- +(js) 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 index 773c3982..0622f741 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select-input/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelectInput

SimpleSelectInput

-open class SimpleSelectInput : SimplePanel, FormInput +(js) open class SimpleSelectInput : SimplePanel, FormInput

Simple select component.

Constructors

@@ -27,96 +28,84 @@ +var autofocus: Boolean? +open var disabled: Boolean +var emptyOption: Boolean +open var name: String? +var options: List<StringPair>? +open var size: InputSize? +var startValue: String? +open var validationStatus: ValidationStatus? - - -
-

<init>

+(js) +

<init>

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

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the text input is automatically focused.

-
-

disabled

+(js) +

disabled

 -open var disabled: Boolean

Determines if the field is disabled.

-
-

emptyOption

+(js) +

emptyOption

 -var emptyOption: Boolean

Determines if an empty option is automatically generated.

-
-

name

+(js) +

name

 -open var name: String?

The name attribute of the generated HTML input element.

-
-

options

+(js) +

options

 -var options: List<StringPair>?

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

-
-

size

+(js) +

size

 -open var size: InputSize?

The size of the input.

-
-

startValue

+(js) +

startValue

 -var startValue: String?

The value of the selected child option.

-
-

validationStatus

+(js) +

validationStatus

 -open var validationStatus: ValidationStatus?

The validation status of the input.

-
-

value

+(js) +

value

 -var value: String?

Text input value.

-
-

Inherited Properties

- - - - - +var value: String?
-

children

-		 -val children: MutableList<Component>
@@ -125,125 +114,57 @@ -

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

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

blur

+(js) +

blur

-open fun blur(): Unit

Makes the input element blur.

- +open fun blur(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the input element focused.

- +open fun focus(): Unit -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

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

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

getSnClass

+(js) +

getSnClass

-open fun getSnClass(): List<StringBoolPair>

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

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

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun render(): VNode
-

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.

-
@@ -252,24 +173,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -278,867 +202,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

bold

+(js) +

bold

-fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold

DSL builder extension function.

- +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold -

button

+(js) +

button

-fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

- +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)