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-remote/index.html | 832 ++++++++++----------- 1 file changed, 384 insertions(+), 448 deletions(-) (limited to 'api/pl.treksoft.kvision.form.select/-select-remote/index.html') diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/index.html b/api/pl.treksoft.kvision.form.select/-select-remote/index.html index 58a7a2fc..3627531a 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/index.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/index.html @@ -8,17 +8,18 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote

SelectRemote

-open class SelectRemote<T : Any> : SimplePanel, StringFormControl +(js) open class SelectRemote<T : Any> : SimplePanel, StringFormControl

The form field component for SelectRemote control.

Constructors

+SelectRemote(serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<RemoteOption>, stateFunction: (() -> String)? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false)
-

<init>

+(js) +

<init>

 -SelectRemote(serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<<ERROR CLASS>>, stateFunction: (() -> String)? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, preload: Boolean = false, label: String? = null, rich: Boolean = false)
@@ -27,150 +28,138 @@ -

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: SelectRemoteInput<T>

The actual input component.

- +val input: SelectRemoteInput<T> -

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

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 -

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>
@@ -179,188 +168,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.

-
@@ -369,24 +299,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> @@ -395,867 +328,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: (