From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-select/-init-.html | 31 ++ .../-select/add-all.html | 21 ++ .../-select/add.html | 21 ++ .../-select/ajax-options.html | 15 + .../-select/autofocus.html | 15 + .../-select/blur.html | 16 + .../-select/empty-option.html | 15 + .../-select/flabel.html | 16 + .../-select/focus.html | 16 + .../-select/get-children.html | 18 + .../-select/get-sn-class.html | 18 + .../-select/hide-options.html | 15 + .../-select/index.html | 383 +++++++++++++++++++++ .../-select/input.html | 16 + .../-select/label.html | 15 + .../-select/live-search.html | 15 + .../-select/max-options.html | 15 + .../-select/multiple.html | 15 + .../-select/options.html | 15 + .../-select/placeholder.html | 15 + .../-select/remove-all.html | 18 + .../-select/remove-event-listeners.html | 18 + .../-select/remove.html | 21 ++ .../-select/rich.html | 15 + .../-select/select-width-type.html | 15 + .../-select/select-width.html | 15 + .../-select/select.html | 16 + .../-select/set-event-listener.html | 54 +++ .../-select/show-options.html | 15 + .../-select/style.html | 15 + .../-select/toggle-options.html | 15 + .../-select/validation-info.html | 16 + .../-select/value.html | 16 + 33 files changed, 955 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-select/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/add-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/add.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/ajax-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/blur.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/empty-option.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/flabel.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/focus.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/get-children.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/hide-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/input.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/label.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/live-search.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/max-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/multiple.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/placeholder.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/remove-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/remove.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/rich.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/select-width-type.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/select-width.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/select.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/show-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/style.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/toggle-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.select/-select/value.html (limited to 'api/pl.treksoft.kvision.form.select/-select') diff --git a/api/pl.treksoft.kvision.form.select/-select/-init-.html b/api/pl.treksoft.kvision.form.select/-select/-init-.html new file mode 100644 index 00000000..b01349b5 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/-init-.html @@ -0,0 +1,31 @@ + + + +Select.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / <init>
+
+

<init>

+ +Select(options: List<StringPair>? = null, value: String? = null, name: 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 control

+

+value - selected value

+

+name - the name attribute of the generated HTML input element

+

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

+

+ajaxOptions - additional options for remote (AJAX) data source

+

+label - label text bound to the input element

+

+rich - determines if label can contain HTML code

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/add-all.html b/api/pl.treksoft.kvision.form.select/-select/add-all.html new file mode 100644 index 00000000..344089e6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/add-all.html @@ -0,0 +1,21 @@ + + + +Select.addAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): SimplePanel +

Overrides SimplePanel.addAll

+

Adds a list of components to the current container.

+

Parameters

+

+children - list of child components

+

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/add.html b/api/pl.treksoft.kvision.form.select/-select/add.html new file mode 100644 index 00000000..757b78a3 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/add.html @@ -0,0 +1,21 @@ + + + +Select.add - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / add
+
+

add

+ +open fun add(child: Component): SimplePanel +

Overrides SimplePanel.add

+

Adds given component to the current container.

+

Parameters

+

+child - child component

+

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/ajax-options.html b/api/pl.treksoft.kvision.form.select/-select/ajax-options.html new file mode 100644 index 00000000..db0fbe42 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/ajax-options.html @@ -0,0 +1,15 @@ + + + +Select.ajaxOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / ajaxOptions
+
+

ajaxOptions

+ +var ajaxOptions: AjaxOptions? +

Additional options for remote (AJAX) data source.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/autofocus.html b/api/pl.treksoft.kvision.form.select/-select/autofocus.html new file mode 100644 index 00000000..b7e18582 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/autofocus.html @@ -0,0 +1,15 @@ + + + +Select.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the select is automatically focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/blur.html b/api/pl.treksoft.kvision.form.select/-select/blur.html new file mode 100644 index 00000000..0ea52ec6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/blur.html @@ -0,0 +1,16 @@ + + + +Select.blur - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

+

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/empty-option.html b/api/pl.treksoft.kvision.form.select/-select/empty-option.html new file mode 100644 index 00000000..10235d84 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/empty-option.html @@ -0,0 +1,15 @@ + + + +Select.emptyOption - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / emptyOption
+
+

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/flabel.html b/api/pl.treksoft.kvision.form.select/-select/flabel.html new file mode 100644 index 00000000..77a1aca4 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/flabel.html @@ -0,0 +1,16 @@ + + + +Select.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/focus.html b/api/pl.treksoft.kvision.form.select/-select/focus.html new file mode 100644 index 00000000..a598250a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/focus.html @@ -0,0 +1,16 @@ + + + +Select.focus - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / focus
+
+

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

+

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/get-children.html b/api/pl.treksoft.kvision.form.select/-select/get-children.html new file mode 100644 index 00000000..d2695945 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/get-children.html @@ -0,0 +1,18 @@ + + + +Select.getChildren - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / getChildren
+
+

getChildren

+ +open fun getChildren(): List<Component> +

Overrides SimplePanel.getChildren

+

Returns a list of children of the current container.

+

Return
+list of children

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html new file mode 100644 index 00000000..7056df18 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Select.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / getSnClass
+
+

getSnClass

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

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/hide-options.html b/api/pl.treksoft.kvision.form.select/-select/hide-options.html new file mode 100644 index 00000000..a9d285fc --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/hide-options.html @@ -0,0 +1,15 @@ + + + +Select.hideOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / hideOptions
+
+

hideOptions

+ +open fun hideOptions(): Unit +

Hides dropdown with options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/index.html b/api/pl.treksoft.kvision.form.select/-select/index.html new file mode 100644 index 00000000..ee8b39f9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/index.html @@ -0,0 +1,383 @@ + + + +Select - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select
+
+

Select

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

+

Constructors

+ + + + + + + +
+

<init>

+		 +Select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)
+

Properties

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

ajaxOptions

+		 +var ajaxOptions: AjaxOptions? +

Additional options for remote (AJAX) data source.

+
+

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: SelectInput +

The actual input component.

+
+

label

+		 +var label: String? +

The label text bound to the select element.

+
+

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.

+
+

options

+		 +var options: List<StringPair>? +

A list of options (label to value pairs) for the select control.

+
+

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

+ + + + + + + +
+

select

+		 +fun Container.select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit = null): Select +

DSL builder extension function.

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

input

+ +val input: SelectInput +

Overrides FormControl.input

+

The actual input component.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/label.html b/api/pl.treksoft.kvision.form.select/-select/label.html new file mode 100644 index 00000000..fa69c42c --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/label.html @@ -0,0 +1,15 @@ + + + +Select.label - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / label
+
+

label

+ +var label: String? +

The label text bound to the select element.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/live-search.html b/api/pl.treksoft.kvision.form.select/-select/live-search.html new file mode 100644 index 00000000..7623c56d --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/live-search.html @@ -0,0 +1,15 @@ + + + +Select.liveSearch - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / liveSearch
+
+

liveSearch

+ +var liveSearch: Boolean +

Determines if live search is available.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/max-options.html b/api/pl.treksoft.kvision.form.select/-select/max-options.html new file mode 100644 index 00000000..9d472c4f --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/max-options.html @@ -0,0 +1,15 @@ + + + +Select.maxOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / maxOptions
+
+

maxOptions

+ +var maxOptions: Int? +

Maximal number of selected options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/multiple.html b/api/pl.treksoft.kvision.form.select/-select/multiple.html new file mode 100644 index 00000000..a5932e98 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/multiple.html @@ -0,0 +1,15 @@ + + + +Select.multiple - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / multiple
+
+

multiple

+ +var multiple: Boolean +

Determines if multiple value selection is allowed.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/options.html b/api/pl.treksoft.kvision.form.select/-select/options.html new file mode 100644 index 00000000..0af371aa --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/options.html @@ -0,0 +1,15 @@ + + + +Select.options - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / options
+
+

options

+ +var options: List<StringPair>? +

A list of options (label to value pairs) for the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/placeholder.html b/api/pl.treksoft.kvision.form.select/-select/placeholder.html new file mode 100644 index 00000000..7a1c3aea --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/placeholder.html @@ -0,0 +1,15 @@ + + + +Select.placeholder - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / placeholder
+
+

placeholder

+ +var placeholder: String? +

The placeholder for the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/remove-all.html b/api/pl.treksoft.kvision.form.select/-select/remove-all.html new file mode 100644 index 00000000..5ef0367a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/remove-all.html @@ -0,0 +1,18 @@ + + + +Select.removeAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

+

Removes all children from the current container.

+

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html b/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html new file mode 100644 index 00000000..7114bc55 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +Select.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

+

Removes all event listeners from current widget.

+

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/remove.html b/api/pl.treksoft.kvision.form.select/-select/remove.html new file mode 100644 index 00000000..c8513957 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/remove.html @@ -0,0 +1,21 @@ + + + +Select.remove - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / remove
+
+

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

+

Removes given component from the current container.

+

Parameters

+

+child - child component

+

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/rich.html b/api/pl.treksoft.kvision.form.select/-select/rich.html new file mode 100644 index 00000000..c9558d15 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/rich.html @@ -0,0 +1,15 @@ + + + +Select.rich - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/select-width-type.html b/api/pl.treksoft.kvision.form.select/-select/select-width-type.html new file mode 100644 index 00000000..d9cc7552 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/select-width-type.html @@ -0,0 +1,15 @@ + + + +Select.selectWidthType - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / selectWidthType
+
+

selectWidthType

+ +var selectWidthType: SelectWidthType? +

The width type of the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/select-width.html b/api/pl.treksoft.kvision.form.select/-select/select-width.html new file mode 100644 index 00000000..1bde09e8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/select-width.html @@ -0,0 +1,15 @@ + + + +Select.selectWidth - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / selectWidth
+
+

selectWidth

+ +var selectWidth: CssSize? +

The width of the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/select.html b/api/pl.treksoft.kvision.form.select/-select/select.html new file mode 100644 index 00000000..5ad4159c --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/select.html @@ -0,0 +1,16 @@ + + + +Select.select - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / select
+
+

select

+ +fun Container.select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit = null): Select +

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/set-event-listener.html b/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html new file mode 100644 index 00000000..e287eb24 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html @@ -0,0 +1,54 @@ + + + +Select.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / setEventListener
+
+

setEventListener

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

+

Parameters

+

+T - widget type

+

+block - event handler

+

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.

+

Parameters

+

+block - event handler

+

Return
+

current widget

+ + +

Example:

+ + +
    button.setEventListener {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Widget here
+        }
+    }

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/show-options.html b/api/pl.treksoft.kvision.form.select/-select/show-options.html new file mode 100644 index 00000000..fa16c71c --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/show-options.html @@ -0,0 +1,15 @@ + + + +Select.showOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / showOptions
+
+

showOptions

+ +open fun showOptions(): Unit +

Opens dropdown with options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/style.html b/api/pl.treksoft.kvision.form.select/-select/style.html new file mode 100644 index 00000000..14b2e480 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/style.html @@ -0,0 +1,15 @@ + + + +Select.style - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / style
+
+

style

+ +var style: ButtonStyle? +

The style of the select control.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/toggle-options.html b/api/pl.treksoft.kvision.form.select/-select/toggle-options.html new file mode 100644 index 00000000..3958bb97 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/toggle-options.html @@ -0,0 +1,15 @@ + + + +Select.toggleOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / toggleOptions
+
+

toggleOptions

+ +open fun toggleOptions(): Unit +

Toggles visibility of dropdown with options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/validation-info.html b/api/pl.treksoft.kvision.form.select/-select/validation-info.html new file mode 100644 index 00000000..bb315130 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/validation-info.html @@ -0,0 +1,16 @@ + + + +Select.validationInfo - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / validationInfo
+
+

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

+

Validation info component.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select/value.html b/api/pl.treksoft.kvision.form.select/-select/value.html new file mode 100644 index 00000000..28570db7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select/value.html @@ -0,0 +1,16 @@ + + + +Select.value - kvision + + + +kvision / pl.treksoft.kvision.form.select / Select / value
+
+

value

+ +open var value: String? +

Overrides StringFormControl.value

+

A value of the selected option.

+ + -- cgit