From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001
From: Robert Jaros
+
+
+
+ Constructor Overrides SimplePanel.addAll Adds a list of components to the current container.
+ Return Overrides SimplePanel.add Adds given component to the current container. Return Overrides Widget.afterInsert Method called after inserting Snabbdom vnode into the DOM. Additional options for remote (AJAX) data source. Getter Additional options for remote (AJAX) data source.
+
+<init>
+
+SelectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf())
+Parameters
+options
- an optional list of options (label to value pairs) for the select controlmultiple
- allows multiple value selection (multiple values are comma delimited)ajaxOptions
- additional options for remote (AJAX) data sourceclasses
- a set of CSS class names
+
+
+addAll
+
+open fun addAll(children: List<Component>): SimplePanel
+Parameters
+children
- list of child components
+current container
+
+add
+
+open fun add(child: Component): SimplePanel
+Parameters
+
+
+current container
+
+afterInsert
+
+protected open fun afterInsert(node: VNode): Unit
+
+
+ajaxOptions
+
+var ajaxOptions: AjaxOptions?
+
+
Setter
+
Additional options for remote (AJAX) data source.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/autofocus.html b/api/pl.treksoft.kvision.form.select/-select-input/autofocus.html new file mode 100644 index 00000000..cf5cb1ba --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/autofocus.html @@ -0,0 +1,21 @@ + + + +var autofocus: Boolean?
+Determines if the select is automatically focused.
+Getter
+
Determines if the select is automatically focused.
+ +Setter
+
Determines if the select is automatically focused.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/blur.html b/api/pl.treksoft.kvision.form.select/-select-input/blur.html new file mode 100644 index 00000000..1854eaec --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/blur.html @@ -0,0 +1,15 @@ + + + +open fun blur(): Unit
+Makes the input element blur.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/disabled.html b/api/pl.treksoft.kvision.form.select/-select-input/disabled.html new file mode 100644 index 00000000..21a1d754 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/disabled.html @@ -0,0 +1,22 @@ + + + +open var disabled: Boolean
+Overrides FormInput.disabled
+Determines if the field is disabled.
+Getter
+
Determines if the field is disabled.
+ +Setter
+
Determines if the field is disabled.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/empty-option.html b/api/pl.treksoft.kvision.form.select/-select-input/empty-option.html new file mode 100644 index 00000000..01cb6058 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/empty-option.html @@ -0,0 +1,21 @@ + + + +var emptyOption: Boolean
+Determines if an empty option is automatically generated.
+Getter
+
Determines if an empty option is automatically generated.
+ +Setter
+
Determines if an empty option is automatically generated.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/focus.html b/api/pl.treksoft.kvision.form.select/-select-input/focus.html new file mode 100644 index 00000000..fe406ef8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/focus.html @@ -0,0 +1,15 @@ + + + +open fun focus(): Unit
+Makes the input element focused.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html new file mode 100644 index 00000000..371b3bd7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +protected open fun getSnAttrs(): List<StringPair>
+Overrides Widget.getSnAttrs
+Returns list of element attributes in the form of a List.
+Return
+list of element attributes
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
open fun hideOptions(): Unit
+Hides dropdown with options.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/index.html b/api/pl.treksoft.kvision.form.select/-select-input/index.html new file mode 100644 index 00000000..ed47854a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/index.html @@ -0,0 +1,327 @@ + + + +open class SelectInput : SimplePanel, FormInput
+The basic 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.
++ + | +
+SelectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf()) |
+
+ + | +
+var ajaxOptions: AjaxOptions?
+Additional options for remote (AJAX) data source. + |
+
+ + | +
+var autofocus: Boolean?
+Determines if the select is automatically focused. + |
+
+ + | +
+open var disabled: Boolean
+Determines if the field is disabled. + |
+
+ + | +
+var emptyOption: Boolean
+Determines if an empty option is automatically generated. + |
+
+ + | +
+var liveSearch: Boolean
+Determines if live search is available. + |
+
+ + | +
+var maxOptions: Int?
+Maximal number of selected options. + |
+
+ + | +
+var multiple: Boolean
+Determines if multiple value selection is allowed. + |
+
+ + | +
+open var name: String?
+The name attribute of the generated HTML select element. + |
+
+ + | +
+var placeholder: String?
+The placeholder for the select control. + |
+
+ + | +
+var selectWidth: CssSize?
+The width of the select control. + |
+
+ + | +
+var selectWidthType: SelectWidthType?
+The width type of the select control. + |
+
+ + | +
+open var size: InputSize?
+The size of the input. + |
+
+ + | +
+var style: ButtonStyle?
+The style of the select control. + |
+
+ + | +
+var value: String?
+A value of the selected option. + |
+
+ + | +
+open fun add(child: Component): SimplePanel
+Adds given component to the current container. + |
+
+ + | +
+open fun addAll(children: List<Component>): SimplePanel
+Adds a list of components to the current container. + |
+
+ + | +
+open fun afterInsert(node: VNode): Unit
+Method called after inserting Snabbdom vnode into the DOM. + |
+
+ + | +
+open fun blur(): Unit
+Makes the input element blur. + |
+
+ + | +
+open fun focus(): Unit
+Makes the input element focused. + |
+
+ + | +
+open fun getSnAttrs(): List<StringPair>
+Returns list of element attributes in the form of a List. + |
+
+ + | +
+open fun getSnClass(): List<StringBoolPair>
+Returns list of CSS class names for current widget in the form of a List. + |
+
+ + | +
+open fun hideOptions(): Unit
+Hides dropdown with options. + |
+
+ + | +
+open fun remove(child: Component): SimplePanel
+Removes given component from the current container. + |
+
+ + | +
+open fun removeAll(): SimplePanel
+Removes all children from the current container. + |
+
+ + | +
+open fun render(): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun showOptions(): Unit
+Opens dropdown with options. + |
+
+ + | +
+open fun toggleOptions(): Unit
+Toggles visibility of dropdown with options. + |
+
+ + | +
+fun addInternal(child: Component): SimplePanel
+Protected and final method to add given component to the current container. + |
+
+ + | +
+open fun childrenVNodes(): Array<VNode>
+Returns the array of the children Snabbdom vnodes. + |
+
+ + | +
+open fun getChildren(): List<Component>
+Returns a list of children of the current container. + |
+
+ + | +
+fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: SelectInput.() -> Unit = null): SelectInput
+DSL builder extension function. + |
+
var liveSearch: Boolean
+Determines if live search is available.
+Getter
+
Determines if live search is available.
+ +Setter
+
Determines if live search is available.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/max-options.html b/api/pl.treksoft.kvision.form.select/-select-input/max-options.html new file mode 100644 index 00000000..76349c48 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/max-options.html @@ -0,0 +1,21 @@ + + + +var maxOptions: Int?
+Maximal number of selected options.
+Getter
+
Maximal number of selected options.
+ +Setter
+
Maximal number of selected options.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/multiple.html b/api/pl.treksoft.kvision.form.select/-select-input/multiple.html new file mode 100644 index 00000000..f7f2b1ba --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/multiple.html @@ -0,0 +1,21 @@ + + + +var multiple: Boolean
+Determines if multiple value selection is allowed.
+Getter
+
Determines if multiple value selection is allowed.
+ +Setter
+
Determines if multiple value selection is allowed.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/name.html b/api/pl.treksoft.kvision.form.select/-select-input/name.html new file mode 100644 index 00000000..6a9a2e7b --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/name.html @@ -0,0 +1,22 @@ + + + +open var name: String?
+Overrides FormInput.name
+The name attribute of the generated HTML select element.
+Getter
+
The name attribute of the generated HTML select element.
+ +Setter
+
The name attribute of the generated HTML select element.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/placeholder.html b/api/pl.treksoft.kvision.form.select/-select-input/placeholder.html new file mode 100644 index 00000000..7ec7138b --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/placeholder.html @@ -0,0 +1,21 @@ + + + +var placeholder: String?
+The placeholder for the select control.
+Getter
+
The placeholder for the select control.
+ +Setter
+
The placeholder for the select control.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/remove-all.html b/api/pl.treksoft.kvision.form.select/-select-input/remove-all.html new file mode 100644 index 00000000..ea8cda8e --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/remove-all.html @@ -0,0 +1,18 @@ + + + +open fun removeAll(): SimplePanel
+Overrides SimplePanel.removeAll
+Removes all children from the current container.
+Return
+current container
open fun remove(child: Component): SimplePanel
+Overrides SimplePanel.remove
+Removes given component from the current container.
+Return
+current container
protected open fun render(): VNode
+Overrides SimplePanel.render
+Renders current component as a Snabbdom vnode.
+Return
+Snabbdom vnode
fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: SelectInput.() -> Unit = null): SelectInput
+DSL builder extension function.
+It takes the same parameters as the constructor of the built component.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/select-width-type.html b/api/pl.treksoft.kvision.form.select/-select-input/select-width-type.html new file mode 100644 index 00000000..e0cb223d --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/select-width-type.html @@ -0,0 +1,21 @@ + + + +var selectWidthType: SelectWidthType?
+The width type of the select control.
+Getter
+
The width type of the select control.
+ +Setter
+
The width type of the select control.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/select-width.html b/api/pl.treksoft.kvision.form.select/-select-input/select-width.html new file mode 100644 index 00000000..65dd9467 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/select-width.html @@ -0,0 +1,21 @@ + + + +var selectWidth: CssSize?
+The width of the select control.
+Getter
+
The width of the select control.
+ +Setter
+
The width of the select control.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/show-options.html b/api/pl.treksoft.kvision.form.select/-select-input/show-options.html new file mode 100644 index 00000000..d3f371c8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/show-options.html @@ -0,0 +1,15 @@ + + + +open fun showOptions(): Unit
+Opens dropdown with options.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/size.html b/api/pl.treksoft.kvision.form.select/-select-input/size.html new file mode 100644 index 00000000..2037173f --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/size.html @@ -0,0 +1,22 @@ + + + +open var size: InputSize?
+Overrides FormInput.size
+The size of the input.
+Getter
+
The size of the input.
+ +Setter
+
The size of the input.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/style.html b/api/pl.treksoft.kvision.form.select/-select-input/style.html new file mode 100644 index 00000000..aae942c5 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/style.html @@ -0,0 +1,21 @@ + + + +var style: ButtonStyle?
+The style of the select control.
+Getter
+
The style of the select control.
+ +Setter
+
The style of the select control.
+ + + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html b/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html new file mode 100644 index 00000000..725c5cc7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html @@ -0,0 +1,15 @@ + + + +open fun toggleOptions(): Unit
+Toggles visibility of dropdown with options.
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-input/value.html b/api/pl.treksoft.kvision.form.select/-select-input/value.html new file mode 100644 index 00000000..19e13af6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-input/value.html @@ -0,0 +1,21 @@ + + + +var value: String?
+A value of the selected option.
+Getter
+
A value of the selected option.
+ +Setter
+
A value of the selected option.
+ + + -- cgit