From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-select-input/-init-.html | 27 ++ .../-select-input/add-all.html | 21 ++ .../-select-input/add.html | 21 ++ .../-select-input/after-insert.html | 16 ++ .../-select-input/ajax-options.html | 15 ++ .../-select-input/autofocus.html | 15 ++ .../-select-input/disabled.html | 15 ++ .../-select-input/empty-option.html | 15 ++ .../-select-input/get-sn-attrs.html | 18 ++ .../-select-input/get-sn-class.html | 18 ++ .../-select-input/hide-options.html | 15 ++ .../-select-input/index.html | 295 +++++++++++++++++++++ .../-select-input/live-search.html | 15 ++ .../-select-input/max-options.html | 15 ++ .../-select-input/multiple.html | 15 ++ .../-select-input/name.html | 15 ++ .../-select-input/placeholder.html | 15 ++ .../-select-input/remove-all.html | 18 ++ .../-select-input/remove.html | 21 ++ .../-select-input/render.html | 18 ++ .../-select-input/select-width-type.html | 15 ++ .../-select-input/select-width.html | 15 ++ .../-select-input/show-options.html | 15 ++ .../-select-input/size.html | 15 ++ .../-select-input/style.html | 15 ++ .../-select-input/toggle-options.html | 15 ++ .../-select-input/value.html | 15 ++ 27 files changed, 728 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/add-all.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/add.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/ajax-options.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/autofocus.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/empty-option.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/hide-options.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/live-search.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/max-options.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/multiple.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/placeholder.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/remove-all.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/remove.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/render.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/select-width-type.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/select-width.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/show-options.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/style.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-select-input/value.html (limited to 'docs/api/pl.treksoft.kvision.form.select/-select-input') diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/-init-.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/-init-.html new file mode 100644 index 00000000..1ea1cc60 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/-init-.html @@ -0,0 +1,27 @@ + + + +SelectInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / <init>
+
+

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

+

+value - selected value

+

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

+

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

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/add-all.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/add-all.html new file mode 100644 index 00000000..5becd914 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/add-all.html @@ -0,0 +1,21 @@ + + + +SelectInput.addAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / 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/docs/api/pl.treksoft.kvision.form.select/-select-input/add.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/add.html new file mode 100644 index 00000000..39171a2a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/add.html @@ -0,0 +1,21 @@ + + + +SelectInput.add - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / 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/docs/api/pl.treksoft.kvision.form.select/-select-input/after-insert.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/after-insert.html new file mode 100644 index 00000000..aab8ccb0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/after-insert.html @@ -0,0 +1,16 @@ + + + +SelectInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Overrides Widget.afterInsert

+

Method called after inserting Snabbdom vnode into the DOM.

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

ajaxOptions

+ +var ajaxOptions: AjaxOptions? +

Additional options for remote (AJAX) data source.

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

autofocus

+ +var autofocus: Boolean? +

Determines if the select is automatically focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/disabled.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/disabled.html new file mode 100644 index 00000000..286f35da --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/disabled.html @@ -0,0 +1,15 @@ + + + +SelectInput.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / disabled
+
+

disabled

+ +var disabled: Boolean +

Determines if the field is disabled.

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

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html new file mode 100644 index 00000000..371b3bd7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +SelectInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / getSnAttrs
+
+

getSnAttrs

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

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-class.html new file mode 100644 index 00000000..28b40573 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +SelectInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / 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/docs/api/pl.treksoft.kvision.form.select/-select-input/hide-options.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/hide-options.html new file mode 100644 index 00000000..d1b371ec --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/hide-options.html @@ -0,0 +1,15 @@ + + + +SelectInput.hideOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / hideOptions
+
+

hideOptions

+ +open fun hideOptions(): Unit +

Hides dropdown with options.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/index.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/index.html new file mode 100644 index 00000000..6fa9cfe5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/index.html @@ -0,0 +1,295 @@ + + + +SelectInput - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput
+
+

SelectInput

+open class SelectInput : SimplePanel +

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.

+

Constructors

+ + + + + + + +
+

<init>

+		 +SelectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf())
+

Properties

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

ajaxOptions

+		 +var ajaxOptions: AjaxOptions? +

Additional options for remote (AJAX) data source.

+
+

autofocus

+		 +var autofocus: Boolean? +

Determines if the select is automatically focused.

+
+

disabled

+		 +var disabled: Boolean +

Determines if the field is disabled.

+
+

emptyOption

+		 +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

+
+

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.

+
+

name

+		 +var name: String? +

The name attribute of the generated HTML select element.

+
+

placeholder

+		 +var placeholder: String? +

The placeholder for the select control.

+
+

selectWidth

+		 +var selectWidth: CssSize? +

The width of the select control.

+
+

selectWidthType

+		 +var selectWidthType: SELECTWIDTHTYPE? +

The width type of the select control.

+
+

size

+		 +var size: INPUTSIZE? +

The size of the input.

+
+

style

+		 +var style: BUTTONSTYLE? +

The style of the select control.

+
+

value

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

+
+

afterInsert

+		 +open fun afterInsert(node: VNode): Unit +

Method called after inserting Snabbdom vnode into the DOM.

+
+

getSnAttrs

+		 +open fun getSnAttrs(): List<StringPair> +

Returns list of element attributes in the form of a List.

+
+

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.

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

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.

+
+

getChildren

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

Returns a list of children of the current container.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/live-search.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/live-search.html new file mode 100644 index 00000000..8a4991a4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/live-search.html @@ -0,0 +1,15 @@ + + + +SelectInput.liveSearch - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / liveSearch
+
+

liveSearch

+ +var liveSearch: Boolean +

Determines if live search is available.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/max-options.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/max-options.html new file mode 100644 index 00000000..94af9393 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/max-options.html @@ -0,0 +1,15 @@ + + + +SelectInput.maxOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / maxOptions
+
+

maxOptions

+ +var maxOptions: Int? +

Maximal number of selected options.

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

multiple

+ +var multiple: Boolean +

Determines if multiple value selection is allowed.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/name.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/name.html new file mode 100644 index 00000000..7fb56e4e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/name.html @@ -0,0 +1,15 @@ + + + +SelectInput.name - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / name
+
+

name

+ +var name: String? +

The name attribute of the generated HTML select element.

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

placeholder

+ +var placeholder: String? +

The placeholder for the select control.

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

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

+

Removes all children from the current container.

+

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/remove.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/remove.html new file mode 100644 index 00000000..0d1cd965 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/remove.html @@ -0,0 +1,21 @@ + + + +SelectInput.remove - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / 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/docs/api/pl.treksoft.kvision.form.select/-select-input/render.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/render.html new file mode 100644 index 00000000..105094e3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/render.html @@ -0,0 +1,18 @@ + + + +SelectInput.render - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / render
+
+

render

+ +protected open fun render(): VNode +

Overrides SimplePanel.render

+

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

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

selectWidthType

+ +var selectWidthType: SELECTWIDTHTYPE? +

The width type of the select control.

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

selectWidth

+ +var selectWidth: CssSize? +

The width of the select control.

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

showOptions

+ +open fun showOptions(): Unit +

Opens dropdown with options.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/size.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/size.html new file mode 100644 index 00000000..5a085e4b --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/size.html @@ -0,0 +1,15 @@ + + + +SelectInput.size - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / size
+
+

size

+ +var size: INPUTSIZE? +

The size of the input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/style.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/style.html new file mode 100644 index 00000000..4efe941a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/style.html @@ -0,0 +1,15 @@ + + + +SelectInput.style - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / style
+
+

style

+ +var style: BUTTONSTYLE? +

The style of the select control.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html new file mode 100644 index 00000000..725c5cc7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/toggle-options.html @@ -0,0 +1,15 @@ + + + +SelectInput.toggleOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / toggleOptions
+
+

toggleOptions

+ +open fun toggleOptions(): Unit +

Toggles visibility of dropdown with options.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-select-input/value.html b/docs/api/pl.treksoft.kvision.form.select/-select-input/value.html new file mode 100644 index 00000000..891f1f9f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-select-input/value.html @@ -0,0 +1,15 @@ + + + +SelectInput.value - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectInput / value
+
+

value

+ +var value: String? +

A value of the selected option.

+ + -- cgit