From a81c549e277d1a07e87cf8e2eecf89662deda323 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 23 Dec 2018 01:32:27 +0100 Subject: API documentation for KVision 0.0.22 --- .../-remote-select/-init-.html | 33 ++ .../-remote-select/add-all.html | 21 ++ .../-remote-select/add.html | 21 ++ .../-remote-select/autofocus.html | 15 + .../-remote-select/blur.html | 16 + .../-remote-select/empty-option.html | 15 + .../-remote-select/flabel.html | 16 + .../-remote-select/focus.html | 16 + .../-remote-select/get-children.html | 18 ++ .../-remote-select/get-sn-class.html | 18 ++ .../-remote-select/hide-options.html | 15 + .../-remote-select/index.html | 354 +++++++++++++++++++++ .../-remote-select/input.html | 16 + .../-remote-select/label.html | 15 + .../-remote-select/max-options.html | 15 + .../-remote-select/multiple.html | 15 + .../-remote-select/placeholder.html | 15 + .../-remote-select/remote-select.html | 16 + .../-remote-select/remove-all.html | 18 ++ .../-remote-select/remove-event-listeners.html | 18 ++ .../-remote-select/remove.html | 21 ++ .../-remote-select/rich.html | 15 + .../-remote-select/select-width-type.html | 15 + .../-remote-select/select-width.html | 15 + .../-remote-select/set-event-listener.html | 54 ++++ .../-remote-select/show-options.html | 15 + .../-remote-select/style.html | 15 + .../-remote-select/toggle-options.html | 15 + .../-remote-select/validation-info.html | 16 + .../-remote-select/value.html | 16 + 30 files changed, 883 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/add-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/add.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/blur.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/empty-option.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/flabel.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/focus.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/get-children.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/hide-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/input.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/label.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/max-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/multiple.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/placeholder.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/remote-select.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/remove-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/remove.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/rich.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/select-width-type.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/select-width.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/show-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/style.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/toggle-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.select/-remote-select/value.html (limited to 'api/pl.treksoft.kvision.form.select/-remote-select') diff --git a/api/pl.treksoft.kvision.form.select/-remote-select/-init-.html b/api/pl.treksoft.kvision.form.select/-remote-select/-init-.html new file mode 100644 index 00000000..fd07a8a9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/-init-.html @@ -0,0 +1,33 @@ + + + +RemoteSelect.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / <init>
+
+

<init>

+ +RemoteSelect(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false) +

Parameters

+

+value - selected value

+

+serviceManager - multiplatform service manager

+

+function - multiplatform service method returning the list of options

+

+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 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/-remote-select/add-all.html b/api/pl.treksoft.kvision.form.select/-remote-select/add-all.html new file mode 100644 index 00000000..e6ddcc5d --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/add-all.html @@ -0,0 +1,21 @@ + + + +RemoteSelect.addAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / 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/-remote-select/add.html b/api/pl.treksoft.kvision.form.select/-remote-select/add.html new file mode 100644 index 00000000..e9e3f41a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/add.html @@ -0,0 +1,21 @@ + + + +RemoteSelect.add - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / 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/-remote-select/autofocus.html b/api/pl.treksoft.kvision.form.select/-remote-select/autofocus.html new file mode 100644 index 00000000..af886b20 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/autofocus.html @@ -0,0 +1,15 @@ + + + +RemoteSelect.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the select is automatically focused.

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

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

+

Makes the input element blur.

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

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

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

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

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

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

+

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-remote-select/get-children.html b/api/pl.treksoft.kvision.form.select/-remote-select/get-children.html new file mode 100644 index 00000000..02ca8009 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/get-children.html @@ -0,0 +1,18 @@ + + + +RemoteSelect.getChildren - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / 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/-remote-select/get-sn-class.html b/api/pl.treksoft.kvision.form.select/-remote-select/get-sn-class.html new file mode 100644 index 00000000..dc8e8d97 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/get-sn-class.html @@ -0,0 +1,18 @@ + + + +RemoteSelect.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / 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/-remote-select/hide-options.html b/api/pl.treksoft.kvision.form.select/-remote-select/hide-options.html new file mode 100644 index 00000000..4b07698c --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/hide-options.html @@ -0,0 +1,15 @@ + + + +RemoteSelect.hideOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect / hideOptions
+
+

hideOptions

+ +open fun hideOptions(): Unit +

Hides dropdown with options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-remote-select/index.html b/api/pl.treksoft.kvision.form.select/-remote-select/index.html new file mode 100644 index 00000000..716ed5c1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-remote-select/index.html @@ -0,0 +1,354 @@ + + + +RemoteSelect - kvision + + + +kvision / pl.treksoft.kvision.form.select / RemoteSelect
+
+

RemoteSelect

+open class RemoteSelect<T : Any> : SimplePanel, StringFormControl +

The form field component for RemoteSelect control.

+

Constructors

+ + + + + + + +
+

<init>

+		 +RemoteSelect(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false)
+

Properties

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

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: RemoteSelectInput<T> +

The actual input component.

+
+

label

+		 +var label: String? +

The label text bound to the select element.

+
+

maxOptions

+		 +var maxOptions: Int? +

Maximal number of selected options.

+
+

multiple

+		 +var multiple: Boolean +

Determines if multiple value selection is allowed.

+
+

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

+ + + + + + + +
+

remoteSelect

+		 +fun <T : Any> Container.remoteSelect(value: String? = null, serviceManager: KVServiceManager<T>, function: T.(String?, String?) -> List<<ERROR CLASS>>, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: RemoteSelect<T>.() -> Unit = null): RemoteSelect<T> +

DSL builder extension function.

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

input

+ +val input: RemoteSelectInput<T> +

Overrides FormControl.input

+

The actual input component.

+ + d