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/-init-.html | 2 +- .../-simple-select/add-all.html | 3 +- .../-simple-select/add.html | 3 +- .../-simple-select/autofocus.html | 2 +- .../-simple-select/blur.html | 3 +- .../-simple-select/empty-option.html | 2 +- .../-simple-select/flabel.html | 3 +- .../-simple-select/focus.html | 3 +- .../-simple-select/get-children.html | 3 +- .../-simple-select/get-sn-class.html | 3 +- .../-simple-select/index.html | 782 ++++++++++----------- .../-simple-select/input.html | 3 +- .../-simple-select/invalid-feedback.html | 3 +- .../-simple-select/label.html | 2 +- .../-simple-select/options.html | 2 +- .../-simple-select/remove-all.html | 3 +- .../-simple-select/remove-event-listener.html | 3 +- .../-simple-select/remove-event-listeners.html | 3 +- .../-simple-select/remove.html | 3 +- .../-simple-select/rich.html | 2 +- .../-simple-select/set-event-listener.html | 5 +- .../-simple-select/start-value.html | 2 +- .../-simple-select/value.html | 3 +- 23 files changed, 382 insertions(+), 461 deletions(-) (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 index 2d31d4bb..5162fbac 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/-init-.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / <init>

<init>

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

Parameters

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 index 54b52223..b327cc49 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/add-all.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / addAll

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/add.html b/api/pl.treksoft.kvision.form.select/-simple-select/add.html index 554ad8de..512eedb0 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/add.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / add

add

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html b/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html index 8999ec7a..138d2554 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / autofocus

autofocus

- +(js) 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 index b8dc4b27..291d41b6 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/blur.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / blur

blur

- +(js) 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 index 3b0937ab..2413a23a 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/empty-option.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / emptyOption

emptyOption

- +(js) 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 index 5f7f26d4..619fd61a 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/flabel.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / flabel

flabel

- +(js) 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 index a6d46141..fd446cec 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/focus.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / focus

focus

- +(js) 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 index 114f4013..ec7e5ca2 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/get-children.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / getChildren

getChildren

- +(js) 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 index e05e0edf..c5eb1f35 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect / 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/index.html b/api/pl.treksoft.kvision.form.select/-simple-select/index.html index 7f838af7..fcc9e81f 100644 --- a/api/pl.treksoft.kvision.form.select/-simple-select/index.html +++ b/api/pl.treksoft.kvision.form.select/-simple-select/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.select / SimpleSelect

SimpleSelect

-open class SimpleSelect : SimplePanel, StringFormControl +(js) open class SimpleSelect : SimplePanel, StringFormControl

The form field component for SimpleSelect control.

Constructors

@@ -27,105 +28,93 @@ +var autofocus: Boolean? +var emptyOption: Boolean +val flabel: FieldLabel +val input: SimpleSelectInput +val invalidFeedback: InvalidFeedback +var label: String? +var options: List<StringPair>? +var rich: Boolean +var startValue: String? - - -
-

<init>

+(js) +

<init>

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

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the select is automatically focused.

-
-

emptyOption

+(js) +

emptyOption

 -var emptyOption: Boolean

Determines if an empty option is automatically generated.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

input

+(js) +

input

 -val input: SimpleSelectInput

The actual input component.

-
-

invalidFeedback

+(js) +

invalidFeedback

 -val invalidFeedback: InvalidFeedback

Invalid feedback component.

-
-

label

+(js) +

label

 -var label: String?

The label text bound to the select element.

-
-

options

+(js) +

options

 -var options: List<StringPair>?

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

-
-

rich

+(js) +

rich

 -var rich: Boolean

Determines if label can contain HTML code.

-
-

startValue

+(js) +

startValue

 -var startValue: String?

The value of the selected child option.

-
-

value

+(js) +

value

 -open var value: String?

A value of the selected option.

-
-

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -134,161 +123,102 @@ -

add

+(js) +

add

-open fun add(child: Component): SimplePanel

Adds given component to the current container.

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

addAll

+(js) +

addAll

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

Adds a list of components to the current container.

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

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 -

getChildren

+(js) +

getChildren

-open fun getChildren(): List<Component>

Returns a list of children of the current container.

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

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> -

remove

+(js) +

remove

-open fun remove(child: Component): SimplePanel

Removes given component from the current container.

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

removeAll

+(js) +

removeAll

-open fun removeAll(): SimplePanel

Removes all children from the current container.

- +open fun removeAll(): SimplePanel -

removeEventListener

+(js) +

removeEventListener

-open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

- +open fun removeEventListener(id: Int): Widget -

removeEventListeners

+(js) +

removeEventListeners

-open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

- +open fun removeEventListeners(): Widget -

setEventListener

+(js) +

setEventListener

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

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

- - - - -

Inherited Functions

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

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.

-
@@ -297,24 +227,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> @@ -323,867 +256,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(),