From f3c9d405382dd81d426c7eab1f6390ec8e6dad00 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:45:25 +0100 Subject: Documentation update. --- .../-select/-init-.html | 29 -- .../-select/add-all.html | 21 -- .../-select/add.html | 21 -- .../-select/ajax-options.html | 15 - .../-select/autofocus.html | 15 - .../-select/disabled.html | 22 -- .../-select/empty-option.html | 15 - .../-select/flabel.html | 16 - .../-select/get-children.html | 18 - .../-select/get-sn-class.html | 18 - .../-select/hide-options.html | 15 - .../-select/index.html | 392 --------------------- .../-select/input.html | 16 - .../-select/label.html | 15 - .../-select/live-search.html | 15 - .../-select/max-options.html | 15 - .../-select/multiple.html | 15 - .../-select/name.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/size.html | 22 -- .../-select/style.html | 15 - .../-select/toggle-options.html | 15 - .../-select/validation-info.html | 16 - .../-select/value.html | 22 -- 34 files changed, 995 deletions(-) delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/-init-.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/add-all.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/add.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/ajax-options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/autofocus.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/disabled.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/flabel.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/get-children.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/hide-options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/index.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/input.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/label.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/live-search.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/max-options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/multiple.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/name.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/remove.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/rich.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/select-width-type.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/select-width.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/select.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/set-event-listener.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/show-options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/size.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/style.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/toggle-options.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/validation-info.html delete mode 100644 docs/api/pl.treksoft.kvision.form.select/-select/value.html (limited to 'docs/api/pl.treksoft.kvision.form.select/-select') diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/-init-.html b/docs/api/pl.treksoft.kvision.form.select/-select/-init-.html deleted file mode 100644 index 52fd3990..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/-init-.html +++ /dev/null @@ -1,29 +0,0 @@ - - - -Select.<init> - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / <init>
-
-

<init>

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

-

-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/docs/api/pl.treksoft.kvision.form.select/-select/add-all.html b/docs/api/pl.treksoft.kvision.form.select/-select/add-all.html deleted file mode 100644 index 344089e6..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/add.html b/docs/api/pl.treksoft.kvision.form.select/-select/add.html deleted file mode 100644 index 757b78a3..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/ajax-options.html b/docs/api/pl.treksoft.kvision.form.select/-select/ajax-options.html deleted file mode 100644 index db0fbe42..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/ajax-options.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/autofocus.html b/docs/api/pl.treksoft.kvision.form.select/-select/autofocus.html deleted file mode 100644 index b7e18582..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/autofocus.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/disabled.html b/docs/api/pl.treksoft.kvision.form.select/-select/disabled.html deleted file mode 100644 index 89dde5bd..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/disabled.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -Select.disabled - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / disabled
-
-

disabled

- -open var disabled: Boolean -

Overrides FormControl.disabled

-

Determines if the field is disabled.

-

Getter
-

Determines if the field is disabled.

-

-

Setter
-

Determines if the field is disabled.

-

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html b/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html deleted file mode 100644 index 10235d84..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/empty-option.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html b/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html deleted file mode 100644 index 77a1aca4..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/flabel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Select.flabel - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / flabel
-
-

flabel

- -val flabel: FieldLabel -

Overrides FormControl.flabel

-

Form field label.

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html b/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html deleted file mode 100644 index d2695945..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html deleted file mode 100644 index 7056df18..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/hide-options.html b/docs/api/pl.treksoft.kvision.form.select/-select/hide-options.html deleted file mode 100644 index a9d285fc..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/hide-options.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Select.hideOptions - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / hideOptions
-
-

hideOptions

- -open fun hideOptions(): Unit -

Hides dropdown with options.

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/index.html b/docs/api/pl.treksoft.kvision.form.select/-select/index.html deleted file mode 100644 index e5055168..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/index.html +++ /dev/null @@ -1,392 +0,0 @@ - - - -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, 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.

-
-

disabled

-		 -open var disabled: Boolean -

Determines if the field is disabled.

-
-

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.

-
-

name

-		 -var name: String? -

The name attribute of the generated HTML select element.

-
-

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.

-
-

size

-		 -open var size: InputSize? -

Input control size.

-
-

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.

-
-

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, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: Select.() -> Unit = null): Select -

DSL builder extension function.

-
- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/input.html b/docs/api/pl.treksoft.kvision.form.select/-select/input.html deleted file mode 100644 index c05a12ca..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/label.html b/docs/api/pl.treksoft.kvision.form.select/-select/label.html deleted file mode 100644 index fa69c42c..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/label.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html b/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html deleted file mode 100644 index 7623c56d..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/live-search.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Select.liveSearch - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / liveSearch
-
-

liveSearch

- -var liveSearch: Boolean -

Determines if live search is available.

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

maxOptions

- -var maxOptions: Int? -

Maximal number of selected options.

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html b/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html deleted file mode 100644 index a5932e98..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/multiple.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/name.html b/docs/api/pl.treksoft.kvision.form.select/-select/name.html deleted file mode 100644 index 06181eaf..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/name.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Select.name - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / 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/options.html b/docs/api/pl.treksoft.kvision.form.select/-select/options.html deleted file mode 100644 index 0af371aa..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/options.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html b/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html deleted file mode 100644 index 7a1c3aea..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/placeholder.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Select.placeholder - kvision - - - -kvision / pl.treksoft.kvision.form.select / Select / placeholder
-
-

placeholder

- -var placeholder: String? -

The placeholder for the select control.

- - diff --git a/docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html b/docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html deleted file mode 100644 index 5ef0367a..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/docs/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html b/docs/api/pl.treksoft.kvision.form.select/-select/remove-event-listeners.html deleted file mode 100644 index 7114bc55..00000000 --- a/docs/api/pl.treksoft.kvision.form.select/-select/remove-event-list