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. |
fun Container.select(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit = null): Select
DSL builder extension function. |