From d8cd67062b8de6e8398dc6dfd00d201200c82414 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 Additional options for remote (AJAX) data source. Determines if the select is automatically focused. Overrides FormControl.disabled Determines if the field is disabled. Getter Determines if the field is disabled.
+
+<init>
+
+Select(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)
+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 sourcelabel
- label text bound to the input elementrich
- determines if label can contain HTML code
+
+
+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
+
+ajaxOptions
+
+var ajaxOptions: AjaxOptions?
+
+
+autofocus
+
+var autofocus: Boolean?
+
+
+disabled
+
+open var disabled: Boolean
+
+
Setter
+
Determines if the field is disabled.
+ + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html b/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html new file mode 100644 index 00000000..10235d84 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html @@ -0,0 +1,15 @@ + + + +var emptyOption: Boolean
+Determines if an empty option is automatically generated.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html b/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html new file mode 100644 index 00000000..77a1aca4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html @@ -0,0 +1,16 @@ + + + +val flabel: FieldLabel
+Overrides FormControl.flabel
+Form field label.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html b/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html new file mode 100644 index 00000000..d2695945 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html @@ -0,0 +1,18 @@ + + + +open fun getChildren(): List<Component>
+Overrides SimplePanel.getChildren
+Returns a list of children of the current container.
+Return
+list of children
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/docs/api/pl.treksoft.kvision.form.select/-select/index.html b/docs/api/pl.treksoft.kvision.form.select/-select/index.html new file mode 100644 index 00000000..0954c87a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/index.html @@ -0,0 +1,378 @@ + + + +open class Select : SimplePanel, StringFormControl
+The form field 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.
++ + | +
+Select(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) |
+
+ + | +
+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. + |
+
+ + | +
+val flabel: FieldLabel
+Form field label. + |
+
+ + | +
+val input: SelectInput
+The actual input component. + |
+
+ + | +
+var label: String?
+The label text bound to the select element. + |
+
+ + | +
+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. + |
+
+ + | +
+var name: String?
+The name attribute of the generated HTML select element. + |
+
+ + | +
+var options: List<StringPair>?
+A list of options (label to value pairs) for the select control. + |
+
+ + | +
+var placeholder: String?
+The placeholder for the select control. + |
+
+ + | +
+var rich: Boolean
+Determines if label can contain HTML code. + |
+
+ + | +
+var selectWidth: CssSize?
+The width of the select control. + |
+
+ + | +
+var selectWidthType: SELECTWIDTHTYPE?
+The width type of the select control. + |
+
+ + | +
+open var size: INPUTSIZE?
+Input control size. + |
+
+ + | +
+var style: BUTTONSTYLE?
+The style of the select control. + |
+
+ + | +
+val validationInfo: HelpBlock
+Validation info component. + |
+
+ + | +
+open 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 getChildren(): List<Component>
+Returns a list of children of the current container. + |
+
+ + | +
+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 removeEventListeners(): Widget
+Removes all event listeners from current widget. + |
+
+ + | +
+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. + |
+
+ + | +
+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 getValue(): String?
+Returns the value of the control. + |
+
+ + | +
+open fun getValueAsString(): String?
+Returns the value of the control as a String. + |
+
+ + | +
+open fun render(): VNode
+Renders current component as a Snabbdom vnode. + |
+
+ + | +
+open fun setValue(v: Any?): Unit
+Sets the value of the control. + |
+
val input: SelectInput
+Overrides FormControl.input
+The actual input component.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/label.html b/docs/api/pl.treksoft.kvision.form.select/-select/label.html new file mode 100644 index 00000000..fa69c42c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/label.html @@ -0,0 +1,15 @@ + + + +var label: String?
+The label text bound to the select element.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html b/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html new file mode 100644 index 00000000..7623c56d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html @@ -0,0 +1,15 @@ + + + +var liveSearch: Boolean
+Determines if live search is available.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/max-options.html b/docs/api/pl.treksoft.kvision.form.select/-select/max-options.html new file mode 100644 index 00000000..9d472c4f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/max-options.html @@ -0,0 +1,15 @@ + + + +var maxOptions: Int?
+Maximal number of selected options.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html b/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html new file mode 100644 index 00000000..a5932e98 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html @@ -0,0 +1,15 @@ + + + +var multiple: Boolean
+Determines if multiple value selection is allowed.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/name.html b/docs/api/pl.treksoft.kvision.form.select/-select/name.html new file mode 100644 index 00000000..06181eaf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/name.html @@ -0,0 +1,15 @@ + + + +var name: String?
+The name attribute of the generated HTML select element.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/options.html b/docs/api/pl.treksoft.kvision.form.select/-select/options.html new file mode 100644 index 00000000..0af371aa --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/options.html @@ -0,0 +1,15 @@ + + + +var options: List<StringPair>?
+A list of options (label to value pairs) for the select control.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html b/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html new file mode 100644 index 00000000..7a1c3aea --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html @@ -0,0 +1,15 @@ + + + +var placeholder: String?
+The placeholder for the select control.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html b/docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html new file mode 100644 index 00000000..5ef0367a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/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 removeEventListeners(): Widget
+Overrides Widget.removeEventListeners
+Removes all event listeners from current widget.
+Return
+current widget
open fun remove(child: Component): SimplePanel
+Overrides SimplePanel.remove
+Removes given component from the current container.
+Return
+current container
var rich: Boolean
+Determines if label can contain HTML code.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/select-width-type.html b/docs/api/pl.treksoft.kvision.form.select/-select/select-width-type.html new file mode 100644 index 00000000..d0855aa5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/select-width-type.html @@ -0,0 +1,15 @@ + + + +var selectWidthType: SELECTWIDTHTYPE?
+The width type of the select control.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/select-width.html b/docs/api/pl.treksoft.kvision.form.select/-select/select-width.html new file mode 100644 index 00000000..1bde09e8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/select-width.html @@ -0,0 +1,15 @@ + + + +var selectWidth: CssSize?
+The width of the select control.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html b/docs/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html new file mode 100644 index 00000000..e287eb24 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html @@ -0,0 +1,54 @@ + + + +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget
+Overrides Widget.setEventListener
+Sets an event listener for current widget, keeping the actual type of component.
+Return
+
current widget
+ + +Example:
+ + + button.setEventListener<Button> {
+ dblclick = {
+ Alert.show("Button double clicked!")
+ // self is of type Button here
+ }
+ }
+
+open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget
+Overrides Widget.setEventListener
+Sets an event listener for current widget.
+Return
+
current widget
+ + +Example:
+ + + button.setEventListener {
+ dblclick = {
+ Alert.show("Button double clicked!")
+ // self is of type Widget here
+ }
+ }
+
+
diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/show-options.html b/docs/api/pl.treksoft.kvision.form.select/-select/show-options.html
new file mode 100644
index 00000000..fa16c71c
--- /dev/null
+++ b/docs/api/pl.treksoft.kvision.form.select/-select/show-options.html
@@ -0,0 +1,15 @@
+
+
+
+open fun showOptions(): Unit
+Opens dropdown with options.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/size.html b/docs/api/pl.treksoft.kvision.form.select/-select/size.html new file mode 100644 index 00000000..cf50994b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/size.html @@ -0,0 +1,22 @@ + + + +open var size: INPUTSIZE?
+Overrides FormControl.size
+Input control size.
+Getter
+
Input control size.
+ +Setter
+
Input control size.
+ + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/style.html b/docs/api/pl.treksoft.kvision.form.select/-select/style.html new file mode 100644 index 00000000..0fa3e464 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/style.html @@ -0,0 +1,15 @@ + + + +var style: BUTTONSTYLE?
+The style of the select control.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/toggle-options.html b/docs/api/pl.treksoft.kvision.form.select/-select/toggle-options.html new file mode 100644 index 00000000..3958bb97 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/toggle-options.html @@ -0,0 +1,15 @@ + + + +open fun toggleOptions(): Unit
+Toggles visibility of dropdown with options.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/validation-info.html b/docs/api/pl.treksoft.kvision.form.select/-select/validation-info.html new file mode 100644 index 00000000..bb315130 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/validation-info.html @@ -0,0 +1,16 @@ + + + +val validationInfo: HelpBlock
+Overrides FormControl.validationInfo
+Validation info component.
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/value.html b/docs/api/pl.treksoft.kvision.form.select/-select/value.html new file mode 100644 index 00000000..5ce6848c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select/value.html @@ -0,0 +1,22 @@ + + + +open var value: String?
+Overrides StringFormControl.value
+A value of the selected option.
+Getter
+
Text value.
+ +Setter
+
Text value.
+ + + -- cgit