From f23e74c2eb0cae2f6ce674881e86ab5d5659ad77 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 29 Jan 2019 23:41:38 +0100 Subject: API documentation for KVision 0.0.23 --- .../-radio-group-input/-init-.html | 25 +++ .../-radio-group-input/blur.html | 14 ++ .../-radio-group-input/disabled.html | 16 ++ .../-radio-group-input/focus.html | 14 ++ .../-radio-group-input/get-sn-class.html | 18 ++ .../-radio-group-input/index.html | 206 +++++++++++++++++++++ .../-radio-group-input/inline.html | 21 +++ .../-radio-group-input/name.html | 16 ++ .../-radio-group-input/options.html | 21 +++ .../-radio-group-input/radio-group-input.html | 16 ++ .../-radio-group-input/size.html | 16 ++ .../-radio-group-input/value.html | 21 +++ 12 files changed, 404 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/-init-.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/blur.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/disabled.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/focus.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/index.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/inline.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/name.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/options.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/radio-group-input.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/size.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group-input/value.html (limited to 'api/pl.treksoft.kvision.form.check/-radio-group-input') diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/-init-.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/-init-.html new file mode 100644 index 00000000..9fe38137 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/-init-.html @@ -0,0 +1,25 @@ + + + +RadioGroupInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / <init>
+
+

<init>

+ +

RadioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false)

Parameters

+options - an optional list of options (label to value pairs) for the group

+value - selected option

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

+inline - determines if the options are rendered inline

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/blur.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/blur.html new file mode 100644 index 00000000..cdfaed41 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/blur.html @@ -0,0 +1,14 @@ + + + +RadioGroupInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / blur
+
+

blur

+ +fun blur(): Unit + + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/disabled.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/disabled.html new file mode 100644 index 00000000..d84a2325 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/disabled.html @@ -0,0 +1,16 @@ + + + +RadioGroupInput.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / disabled
+
+

disabled

+ +open var disabled: Boolean +

Overrides FormInput.disabled

Determines if the field is disabled.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/focus.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/focus.html new file mode 100644 index 00000000..798e048d --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/focus.html @@ -0,0 +1,14 @@ + + + +RadioGroupInput.focus - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / focus
+
+

focus

+ +fun focus(): Unit + + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/get-sn-class.html new file mode 100644 index 00000000..c2922ecd --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +RadioGroupInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / 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.check/-radio-group-input/index.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/index.html new file mode 100644 index 00000000..e70ea8bf --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/index.html @@ -0,0 +1,206 @@ + + + +RadioGroupInput - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput
+
+

RadioGroupInput

+open class RadioGroupInput : SimplePanel, FormInput +

The input component rendered as a group of HTML input type="radio" elements with the same name attribute.

The radio group can be populated directly from options parameter or manually by adding +Radio components to the container.

Constructors

+ + + + + + + +

<init>

RadioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false)

Properties

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

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ inline +	+`var inline: Boolean` + Determines if the options are rendered inline. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML input element. +
+ options +	+`var options: List<StringPair>?` + A list of options (label to value pairs) for the group. +
+ size +	+`open var size: InputSize?` + Input control field size. +
+ value +	+`var value: String?` + A value of the selected option. +

Functions

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

+ blur +	+`fun blur(): Unit`
+ focus +	+`fun focus(): Unit`
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +

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

Companion Object Functions

+ + + + + + + +

radioGroupInput

fun Container.radioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, init: RadioGroupInput.() -> Unit = null): RadioGroupInput

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/inline.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/inline.html new file mode 100644 index 00000000..56b90f63 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/inline.html @@ -0,0 +1,21 @@ + + + +RadioGroupInput.inline - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / inline
+
+

inline

+ +var inline: Boolean +

Determines if the options are rendered inline.

Getter
+

Determines if the options are rendered inline.

Setter
+

Determines if the options are rendered inline.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/name.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/name.html new file mode 100644 index 00000000..eebd6161 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/name.html @@ -0,0 +1,16 @@ + + + +RadioGroupInput.name - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / name
+
+

name

+ +open var name: String? +

Overrides FormInput.name

The name attribute of the generated HTML input element.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/options.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/options.html new file mode 100644 index 00000000..e2234e8c --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/options.html @@ -0,0 +1,21 @@ + + + +RadioGroupInput.options - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / options
+
+

options

+ +var options: List<StringPair>? +

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

Getter
+

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

Setter
+

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

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/radio-group-input.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/radio-group-input.html new file mode 100644 index 00000000..4d9c367f --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/radio-group-input.html @@ -0,0 +1,16 @@ + + + +RadioGroupInput.radioGroupInput - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / radioGroupInput
+
+

radioGroupInput

+ +

fun Container.radioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, init: RadioGroupInput.() -> Unit = null): RadioGroupInput

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/size.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/size.html new file mode 100644 index 00000000..740e8ff0 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/size.html @@ -0,0 +1,16 @@ + + + +RadioGroupInput.size - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / size
+
+

size

+ +open var size: InputSize? +

Overrides FormInput.size

Input control field size.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group-input/value.html b/api/pl.treksoft.kvision.form.check/-radio-group-input/value.html new file mode 100644 index 00000000..b5622ae7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group-input/value.html @@ -0,0 +1,21 @@ + + + +RadioGroupInput.value - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroupInput / value
+
+

value

+ +var value: String? +

A value of the selected option.

Getter
+

A value of the selected option.

Setter
+

A value of the selected option.

+ + -- cgit