From 2febd99a43e367e7100e9fc21bd6eef1cd1ea47e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 13 Jul 2019 02:13:41 +0200 Subject: API documentation for KVision 0.0.38 --- .../-select-remote/index.html | 368 +++++++++++++++++++++ 1 file changed, 368 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/index.html (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 new file mode 100644 index 00000000..19275a04 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/index.html @@ -0,0 +1,368 @@ + + + +SelectRemote - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote
+
+

SelectRemote

+open class SelectRemote<T : Any> : SimplePanel, StringFormControl +

The form field component for SelectRemote control.

Constructors

+ + + + + + + +

<init>

SelectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the select is automatically focused. +
+ emptyOption +	+`var emptyOption: Boolean` + Determines if an empty option is automatically generated. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ input +	+`val input: SelectRemoteInput<T>` + The actual input component. +
+ label +	+`var label: String?` + The label text bound to the select element. +
+ maxOptions +	+`var maxOptions: Int?` + Maximal number of selected options. +
+ multiple +	+`var multiple: Boolean` + Determines if multiple value selection is allowed. +
+ placeholder +	+`var placeholder: String?` + The placeholder for the select control. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ selectWidth +	+`var selectWidth: CssSize?` + The width of the select control. +
+ selectWidthType +	+`var selectWidthType: SelectWidthType?` + The width type of the select control. +
+ style +	+`var style: ButtonStyle?` + The style of the select control. +
+ validationInfo +	+`val validationInfo: HelpBlock` + Validation info component. +
+ value +	+`open var value: String?` + A value of the selected option. +

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. +
+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ 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. +
+ 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. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ showOptions +	+`open fun showOptions(): Unit` + Opens dropdown with options. +
+ toggleOptions +	+`open fun toggleOptions(): Unit` + Toggles visibility of dropdown with options. +

Inherited Functions

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

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

Companion Object Functions

+ + + + + + + +

selectRemote

fun <T : Any> Container.selectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: (SelectRemote<T>.() -> Unit)? = null): SelectRemote<T>

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + -- cgit