From a81c549e277d1a07e87cf8e2eecf89662deda323 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 23 Dec 2018 01:32:27 +0100 Subject: API documentation for KVision 0.0.22 --- .../-remote-select-input/-init-.html | 29 ++ .../-remote-select-input/index.html | 300 +++++++++++++++++++++ .../-remote-select-input/remote-select-input.html | 16 ++ 3 files changed, 345 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select-input/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select-input/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select-input/remote-select-input.html (limited to 'api/pl.treksoft.kvision.form.select/-remote-select-input') diff --git a/api/pl.treksoft.kvision.form.select/-remote-select-input/-init-.html b/api/pl.treksoft.kvision.form.select/-remote-select-input/-init-.html new file mode 100644 index 00000000..0b7cb054 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select-input/-init-.html @@ -0,0 +1,29 @@ + + + +RemoteSelectInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelectInput / <init>
+
+

<init>

+ +

RemoteSelectInput(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf())

Parameters

+value - selected value

+serviceManager - multiplatform service manager

+function - multiplatform service method returning the list of options

+multiple - allows multiple value selection (multiple values are comma delimited)

+ajaxOptions - additional options for remote data source

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.select/-remote-select-input/index.html b/api/pl.treksoft.kvision.form.select/-remote-select-input/index.html new file mode 100644 index 00000000..6c1b27e9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select-input/index.html @@ -0,0 +1,300 @@ + + + +RemoteSelectInput - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelectInput
+
+

RemoteSelectInput

+open class RemoteSelectInput<T : Any> : SelectInput +

The Select control connected to the multiplatform service.

Constructors

+ + + + + + + +

<init>

RemoteSelectInput(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf())

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ ajaxOptions +	+`var ajaxOptions: AjaxOptions?` + Additional options for remote (AJAX) data source. +
+ autofocus +	+`var autofocus: Boolean?` + Determines if the select is automatically focused. +
+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ emptyOption +	+`var emptyOption: Boolean` + Determines if an empty option is automatically generated. +
+ liveSearch +	+`var liveSearch: Boolean` + Determines if live search is available. +
+ maxOptions +	+`var maxOptions: Int?` + Maximal number of selected options. +
+ multiple +	+`var multiple: Boolean` + Determines if multiple value selection is allowed. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML select element. +
+ placeholder +	+`var placeholder: String?` + The placeholder for the select control. +
+ selectWidth +	+`var selectWidth: CssSize?` + The width of the select control. +
+ selectWidthType +	+`var selectWidthType: SelectWidthType?` + The width type of the select control. +
+ size +	+`open var size: InputSize?` + The size of the input. +
+ style +	+`var style: ButtonStyle?` + The style of the select control. +
+ value +	+`var value: String?` + A value of the selected option. +

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ 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. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ hideOptions +	+`open fun hideOptions(): Unit` + Hides dropdown with options. +
+ refreshSelectInput +	+`fun refreshSelectInput(): Unit`
+ 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. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +
+ showOptions +	+`open fun showOptions(): Unit` + Opens dropdown with options. +
+ toggleOptions +	+`open fun toggleOptions(): Unit` + Toggles visibility of dropdown with options. +

Companion Object Functions

+ + + + + + + +

remoteSelectInput

fun <T : Any> Container.remoteSelectInput(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: RemoteSelectInput<T>.() -> Unit = null): RemoteSelectInput<T>

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-remote-select-input/remote-select-input.html b/api/pl.treksoft.kvision.form.select/-remote-select-input/remote-select-input.html new file mode 100644 index 00000000..bb059bf6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select-input/remote-select-input.html @@ -0,0 +1,16 @@ + + + +RemoteSelectInput.remoteSelectInput - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelectInput / remoteSelectInput
+
+

remoteSelectInput

+ +

fun <T : Any> Container.remoteSelectInput(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: RemoteSelectInput<T>.() -> Unit = null): RemoteSelectInput<T>

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + -- cgit