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 --- .../-select/-init-.html | 2 +- .../-select/add-all.html | 3 +- .../-select/add.html | 3 +- .../-select/ajax-options.html | 2 +- .../-select/autofocus.html | 2 +- .../-select/blur.html | 3 +- .../-select/dropdown-align.html | 2 +- .../-select/empty-option.html | 2 +- .../-select/flabel.html | 3 +- .../-select/focus.html | 3 +- .../-select/get-children.html | 3 +- .../-select/get-sn-class.html | 3 +- .../-select/hide-options.html | 2 +- .../-select/index.html | 860 ++++++++++----------- .../-select/input.html | 3 +- .../-select/invalid-feedback.html | 3 +- .../-select/label.html | 2 +- .../-select/live-search.html | 2 +- .../-select/max-options.html | 2 +- .../-select/multiple.html | 2 +- .../-select/options.html | 2 +- .../-select/placeholder.html | 2 +- .../-select/remove-all.html | 3 +- .../-select/remove-event-listener.html | 3 +- .../-select/remove-event-listeners.html | 3 +- .../-select/remove.html | 3 +- .../-select/rich.html | 2 +- .../-select/select-width-type.html | 2 +- .../-select/select-width.html | 2 +- .../-select/set-event-listener.html | 5 +- .../-select/show-options.html | 2 +- .../-select/style.html | 2 +- .../-select/toggle-options.html | 2 +- .../-select/value.html | 3 +- 34 files changed, 432 insertions(+), 511 deletions(-) (limited to 'api/pl.treksoft.kvision.form.select/-select') diff --git a/api/pl.treksoft.kvision.form.select/-select/-init-.html b/api/pl.treksoft.kvision.form.select/-select/-init-.html index 712986e6..badc610e 100644 --- a/api/pl.treksoft.kvision.form.select/-select/-init-.html +++ b/api/pl.treksoft.kvision.form.select/-select/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / <init>

<init>

- +(js) Select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.select/-select/add-all.html b/api/pl.treksoft.kvision.form.select/-select/add-all.html index 344089e6..6482ce89 100644 --- a/api/pl.treksoft.kvision.form.select/-select/add-all.html +++ b/api/pl.treksoft.kvision.form.select/-select/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / 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/-select/add.html b/api/pl.treksoft.kvision.form.select/-select/add.html index 757b78a3..75399635 100644 --- a/api/pl.treksoft.kvision.form.select/-select/add.html +++ b/api/pl.treksoft.kvision.form.select/-select/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / 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/-select/ajax-options.html b/api/pl.treksoft.kvision.form.select/-select/ajax-options.html index db0fbe42..72c1e40e 100644 --- a/api/pl.treksoft.kvision.form.select/-select/ajax-options.html +++ b/api/pl.treksoft.kvision.form.select/-select/ajax-options.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / ajaxOptions

ajaxOptions

- +(js) var ajaxOptions: AjaxOptions?

Additional options for remote (AJAX) data source.

diff --git a/api/pl.treksoft.kvision.form.select/-select/autofocus.html b/api/pl.treksoft.kvision.form.select/-select/autofocus.html index b7e18582..5c974318 100644 --- a/api/pl.treksoft.kvision.form.select/-select/autofocus.html +++ b/api/pl.treksoft.kvision.form.select/-select/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the select is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.select/-select/blur.html b/api/pl.treksoft.kvision.form.select/-select/blur.html index 0ea52ec6..bdce10dc 100644 --- a/api/pl.treksoft.kvision.form.select/-select/blur.html +++ b/api/pl.treksoft.kvision.form.select/-select/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / blur

blur

- +(js) open fun blur(): Unit -

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.select/-select/dropdown-align.html b/api/pl.treksoft.kvision.form.select/-select/dropdown-align.html index 21f215d9..f913b500 100644 --- a/api/pl.treksoft.kvision.form.select/-select/dropdown-align.html +++ b/api/pl.treksoft.kvision.form.select/-select/dropdown-align.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / dropdownAlign

dropdownAlign

- +(js) var dropdownAlign: SelectDropdownAlign

The dropdown align of the select control.

diff --git a/api/pl.treksoft.kvision.form.select/-select/empty-option.html b/api/pl.treksoft.kvision.form.select/-select/empty-option.html index 10235d84..49530600 100644 --- a/api/pl.treksoft.kvision.form.select/-select/empty-option.html +++ b/api/pl.treksoft.kvision.form.select/-select/empty-option.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / emptyOption

emptyOption

- +(js) var emptyOption: Boolean

Determines if an empty option is automatically generated.

diff --git a/api/pl.treksoft.kvision.form.select/-select/flabel.html b/api/pl.treksoft.kvision.form.select/-select/flabel.html index 77a1aca4..84ac9dde 100644 --- a/api/pl.treksoft.kvision.form.select/-select/flabel.html +++ b/api/pl.treksoft.kvision.form.select/-select/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.select/-select/focus.html b/api/pl.treksoft.kvision.form.select/-select/focus.html index a598250a..daa00d52 100644 --- a/api/pl.treksoft.kvision.form.select/-select/focus.html +++ b/api/pl.treksoft.kvision.form.select/-select/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / focus

focus

- +(js) open fun focus(): Unit -

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.select/-select/get-children.html b/api/pl.treksoft.kvision.form.select/-select/get-children.html index d2695945..7ef8892e 100644 --- a/api/pl.treksoft.kvision.form.select/-select/get-children.html +++ b/api/pl.treksoft.kvision.form.select/-select/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / 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/-select/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html index 7056df18..e6eeb4fb 100644 --- a/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / Select / 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/-select/hide-options.html b/api/pl.treksoft.kvision.form.select/-select/hide-options.html index a9d285fc..619deb06 100644 --- a/api/pl.treksoft.kvision.form.select/-select/hide-options.html +++ b/api/pl.treksoft.kvision.form.select/-select/hide-options.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select / hideOptions

hideOptions

- +(js) open fun hideOptions(): Unit

Hides dropdown with options.

diff --git a/api/pl.treksoft.kvision.form.select/-select/index.html b/api/pl.treksoft.kvision.form.select/-select/index.html index 99fbdaad..a8ac7677 100644 --- a/api/pl.treksoft.kvision.form.select/-select/index.html +++ b/api/pl.treksoft.kvision.form.select/-select/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / Select

Select

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

The form field component for Select control.

The select control can be populated directly from options parameter or manually by adding SelectOption or SelectOptGroup components to the container.

@@ -17,7 +17,8 @@ -

<init>

+(js) +

<init>

Select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) @@ -29,177 +30,165 @@ -

ajaxOptions

+(js) +

ajaxOptions

-var ajaxOptions: AjaxOptions?

Additional options for remote (AJAX) data source.

- +var ajaxOptions: AjaxOptions? -

autofocus

+(js) +

autofocus

-var autofocus: Boolean?

Determines if the select is automatically focused.

- +var autofocus: Boolean? -

dropdownAlign

+(js) +

dropdownAlign

-var dropdownAlign: SelectDropdownAlign

The dropdown align of the select control.

- +var dropdownAlign: SelectDropdownAlign -

emptyOption

+(js) +

emptyOption

-var emptyOption: Boolean

Determines if an empty option is automatically generated.

- +var emptyOption: Boolean -

flabel

+(js) +

flabel

-val flabel: FieldLabel

Form field label.

- +val flabel: FieldLabel -

input

+(js) +

input

-val input: SelectInput

The actual input component.

- +val input: SelectInput -

invalidFeedback

+(js) +

invalidFeedback

-val invalidFeedback: InvalidFeedback

Invalid feedback component.

- +val invalidFeedback: InvalidFeedback -

label

+(js) +

label

-var label: String?

The label text bound to the select element.

- +var label: String? -

liveSearch

+(js) +

liveSearch

-var liveSearch: Boolean

Determines if live search is available.

- +var liveSearch: Boolean -

maxOptions

+(js) +

maxOptions

-var maxOptions: Int?

Maximal number of selected options.

- +var maxOptions: Int? -

multiple

+(js) +

multiple

-var multiple: Boolean

Determines if multiple value selection is allowed.

- +var multiple: Boolean -

options

+(js) +

options

-var options: List<StringPair>?

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

- +var options: List<StringPair>? -

placeholder

+(js) +

placeholder

-var placeholder: String?

The placeholder for the select control.

- +var placeholder: String? -

rich

+(js) +

rich

-var rich: Boolean

Determines if label can contain HTML code.

- +var rich: Boolean -

selectWidth

+(js) +

selectWidth

-var selectWidth: CssSize?

The width of the select control.

- +var selectWidth: CssSize? -

selectWidthType

+(js) +

selectWidthType

-var selectWidthType: SelectWidthType?

The width type of the select control.

- +var selectWidthType: SelectWidthType? -

style

+(js) +

style

-var style: ButtonStyle?

The style of the select control.

- +var style: ButtonStyle? -

value

+(js) +

value

-open var value: String?

A value of the selected option.

- - - - -

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -208,188 +197,129 @@ -

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

hideOptions

+(js) +

hideOptions

-open fun hideOptions(): Unit

Hides dropdown with options.

- +open fun hideOptions(): Unit -

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.

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

showOptions

+(js) +

showOptions

-open fun showOptions(): Unit

Opens dropdown with options.

- +open fun showOptions(): Unit -

toggleOptions

+(js) +

toggleOptions

-open fun toggleOptions(): Unit

Toggles visibility of dropdown with options.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - +open fun toggleOptions(): Unit
-

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.

-
@@ -398,24 +328,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