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/-init-.html | 4 +- .../-select-remote/add-all.html | 3 +- .../-select-remote/add.html | 3 +- .../-select-remote/autofocus.html | 2 +- .../-select-remote/blur.html | 3 +- .../-select-remote/dropdown-align.html | 2 +- .../-select-remote/empty-option.html | 2 +- .../-select-remote/flabel.html | 3 +- .../-select-remote/focus.html | 3 +- .../-select-remote/get-children.html | 3 +- .../-select-remote/get-sn-class.html | 3 +- .../-select-remote/hide-options.html | 2 +- .../-select-remote/index.html | 832 ++++++++++----------- .../-select-remote/input.html | 5 +- .../-select-remote/invalid-feedback.html | 3 +- .../-select-remote/label.html | 2 +- .../-select-remote/max-options.html | 2 +- .../-select-remote/multiple.html | 2 +- .../-select-remote/placeholder.html | 2 +- .../-select-remote/remove-all.html | 3 +- .../-select-remote/remove-event-listener.html | 3 +- .../-select-remote/remove-event-listeners.html | 3 +- .../-select-remote/remove.html | 3 +- .../-select-remote/rich.html | 2 +- .../-select-remote/select-width-type.html | 2 +- .../-select-remote/select-width.html | 2 +- .../-select-remote/set-event-listener.html | 5 +- .../-select-remote/show-options.html | 2 +- .../-select-remote/style.html | 2 +- .../-select-remote/toggle-options.html | 2 +- .../-select-remote/value.html | 3 +- 31 files changed, 417 insertions(+), 496 deletions(-) (limited to 'api/pl.treksoft.kvision.form.select/-select-remote') diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html index c72c155e..86c0f87a 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / <init>

<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) +(js) +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)

Parameters

value - selected value

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html b/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html index 15175cd1..399f2c7e 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/add.html b/api/pl.treksoft.kvision.form.select/-select-remote/add.html index e8a1a03a..42256cb5 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/add.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/autofocus.html b/api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html index d0d692fd..6693f6ef 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the select is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/blur.html b/api/pl.treksoft.kvision.form.select/-select-remote/blur.html index bf5af145..8abc47b2 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/blur.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/dropdown-align.html b/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html index cb66d6eb..3c289eca 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/dropdown-align.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / dropdownAlign

dropdownAlign

- +(js) var dropdownAlign: SelectDropdownAlign

The dropdown align of the select control.

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/empty-option.html b/api/pl.treksoft.kvision.form.select/-select-remote/empty-option.html index 72b685d4..f173dd76 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/empty-option.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/empty-option.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / emptyOption

emptyOption

- +(js) var emptyOption: Boolean

Determines if an empty option is automatically generated.

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/flabel.html b/api/pl.treksoft.kvision.form.select/-select-remote/flabel.html index 3de4f49b..03218431 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/flabel.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/focus.html b/api/pl.treksoft.kvision.form.select/-select-remote/focus.html index 5bf18e3d..bafbb3de 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/focus.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/get-children.html b/api/pl.treksoft.kvision.form.select/-select-remote/get-children.html index 4ea7a466..230f53f6 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/get-children.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-select-remote/get-sn-class.html index 5eff8787..8802231e 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/hide-options.html b/api/pl.treksoft.kvision.form.select/-select-remote/hide-options.html index 04b19644..7362546f 100644 --- a/api/pl.treksoft.kvision.form.select/-select-remote/hide-options.html +++ b/api/pl.treksoft.kvision.form.select/-select-remote/hide-options.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.select / SelectRemote / hideOptions

hideOptions

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

Hides dropdown with options.

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