From 2febd99a43e367e7100e9fc21bd6eef1cd1ea47e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 13 Jul 2019 02:13:41 +0200 Subject: API documentation for KVision 0.0.38 --- .../-select-remote/-init-.html | 33 ++ .../-select-remote/add-all.html | 21 ++ .../-select-remote/add.html | 21 ++ .../-select-remote/autofocus.html | 15 + .../-select-remote/blur.html | 16 + .../-select-remote/empty-option.html | 15 + .../-select-remote/flabel.html | 16 + .../-select-remote/focus.html | 16 + .../-select-remote/get-children.html | 18 + .../-select-remote/get-sn-class.html | 18 + .../-select-remote/hide-options.html | 15 + .../-select-remote/index.html | 368 +++++++++++++++++++++ .../-select-remote/input.html | 16 + .../-select-remote/label.html | 15 + .../-select-remote/max-options.html | 15 + .../-select-remote/multiple.html | 15 + .../-select-remote/placeholder.html | 15 + .../-select-remote/remove-all.html | 18 + .../-select-remote/remove-event-listeners.html | 18 + .../-select-remote/remove.html | 21 ++ .../-select-remote/rich.html | 15 + .../-select-remote/select-remote.html | 16 + .../-select-remote/select-width-type.html | 15 + .../-select-remote/select-width.html | 15 + .../-select-remote/set-event-listener.html | 54 +++ .../-select-remote/show-options.html | 15 + .../-select-remote/style.html | 15 + .../-select-remote/toggle-options.html | 15 + .../-select-remote/validation-info.html | 16 + .../-select-remote/value.html | 16 + 30 files changed, 897 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/-init-.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/add-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/add.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/blur.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/empty-option.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/flabel.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/focus.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/get-children.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/hide-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/index.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/input.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/label.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/max-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/multiple.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/placeholder.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/remove-all.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/remove.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/rich.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/select-remote.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/select-width-type.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/select-width.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/show-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/style.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/toggle-options.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.select/-select-remote/value.html (limited to 'api/pl.treksoft.kvision.form.select/-select-remote') diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html new file mode 100644 index 00000000..273bf455 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/-init-.html @@ -0,0 +1,33 @@ + + + +SelectRemote.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote / <init>
+
+

<init>

+ +SelectRemote(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/-select-remote/add-all.html b/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html new file mode 100644 index 00000000..15175cd1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/add-all.html @@ -0,0 +1,21 @@ + + + +SelectRemote.addAll - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/add.html b/api/pl.treksoft.kvision.form.select/-select-remote/add.html new file mode 100644 index 00000000..e8a1a03a --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/add.html @@ -0,0 +1,21 @@ + + + +SelectRemote.add - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote / 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-remote/autofocus.html b/api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html new file mode 100644 index 00000000..d0d692fd --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/autofocus.html @@ -0,0 +1,15 @@ + + + +SelectRemote.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the select is automatically focused.

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

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

+

Makes the input element blur.

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

emptyOption

+ +var emptyOption: Boolean +

Determines if an empty option is automatically generated.

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

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

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

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

+

Makes the input element focused.

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

hideOptions

+ +open fun hideOptions(): Unit +

Hides dropdown with options.

+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-remote/index.html b/api/pl.treksoft.kvision.form.select/-select-remote/index.html new file mode 100644 index 00000000..19275a04 --- /dev/null +++ b/api/pl.treksoft.kvision.form.select/-select-remote/index.html @@ -0,0 +1,368 @@ + + + +SelectRemote - kvision + + + +kvision / pl.treksoft.kvision.form.select / SelectRemote
+
+

SelectRemote

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

The form field component for SelectRemote control.

+

Constructors

+ + + + + + + +
+

<init>

+		 +SelectRemote(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: SelectRemoteInput<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

+ + + + + + + +
+

selectRemote

+		 +fun <T : Any> Container.selectRemote(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: (SelectRemote<T>.() -> Unit)? = null): SelectRemote<T> +

DSL builder extension function.

+
+

Extension Functions

+ + + + + + + +
+

createInstance

+		 +fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+
+ + diff --git a/api/pl.treksoft.kvision.form.select/-select-rem