From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- .../-radio-group/-init-.html | 29 +++ .../-radio-group/blur.html | 16 ++ .../-radio-group/disabled.html | 16 ++ .../-radio-group/flabel.html | 16 ++ .../-radio-group/focus.html | 16 ++ .../-radio-group/get-sn-class.html | 18 ++ .../-radio-group/index.html | 282 +++++++++++++++++++++ .../-radio-group/inline.html | 21 ++ .../-radio-group/input.html | 16 ++ .../-radio-group/label.html | 15 ++ .../-radio-group/name.html | 16 ++ .../-radio-group/options.html | 21 ++ .../-radio-group/radio-group.html | 16 ++ .../-radio-group/rich.html | 15 ++ .../-radio-group/size.html | 16 ++ .../-radio-group/validation-info.html | 16 ++ .../-radio-group/value.html | 22 ++ 17 files changed, 567 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/-init-.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/blur.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/disabled.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/flabel.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/focus.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/index.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/inline.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/input.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/label.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/name.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/options.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/radio-group.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/rich.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/size.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.check/-radio-group/value.html (limited to 'api/pl.treksoft.kvision.form.check/-radio-group') diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html b/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html new file mode 100644 index 00000000..ab46a0c9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html @@ -0,0 +1,29 @@ + + + +RadioGroup.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / <init>
+
+

<init>

+ +

RadioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: 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

+label - label text of the options group

+rich - determines if label can contain HTML code

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/blur.html b/api/pl.treksoft.kvision.form.check/-radio-group/blur.html new file mode 100644 index 00000000..82a46729 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/blur.html @@ -0,0 +1,16 @@ + + + +RadioGroup.blur - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html b/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html new file mode 100644 index 00000000..67fd5054 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html @@ -0,0 +1,16 @@ + + + +RadioGroup.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / disabled
+
+

disabled

+ +open var disabled: Boolean +

Overrides FormControl.disabled

Determines if the field is disabled.

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

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

Form field label.

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

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html new file mode 100644 index 00000000..45f2e97a --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html @@ -0,0 +1,18 @@ + + + +RadioGroup.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / 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/index.html b/api/pl.treksoft.kvision.form.check/-radio-group/index.html new file mode 100644 index 00000000..d1775942 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/index.html @@ -0,0 +1,282 @@ + + + +RadioGroup - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup
+
+

RadioGroup

+open class RadioGroup : SimplePanel, StringFormControl +

The form field 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>

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

Properties

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

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ inline +	+`var inline: Boolean` + Determines if the options are rendered inline. +
+ input +	+`val input: CheckInput` + The actual input component. +
+ label +	+`var label: String?` + The label text of the options group. +
+ 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. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ size +	+`open var size: InputSize?` + Input control field size. +
+ validationInfo +	+`val validationInfo: HelpBlock` + Validation info component. +
+ value +	+`open var value: String?` + A value of the selected option. +

Functions

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

+ blur +	+`open fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`open fun focus(): Unit` + Makes the input element focused. +
+ 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. +
+ 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. +
+ 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. +
+ setValue +	+`open fun setValue(v: Any?): Unit` + Sets the value of the control. +

Companion Object Functions

+ + + + + + + +

radioGroup

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

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/inline.html b/api/pl.treksoft.kvision.form.check/-radio-group/inline.html new file mode 100644 index 00000000..47eb8575 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/inline.html @@ -0,0 +1,21 @@ + + + +RadioGroup.inline - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / 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.html b/api/pl.treksoft.kvision.form.check/-radio-group/input.html new file mode 100644 index 00000000..3b1eccae --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/input.html @@ -0,0 +1,16 @@ + + + +RadioGroup.input - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / input
+
+

input

+ +val input: CheckInput +

Overrides FormControl.input

The actual input component.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/label.html b/api/pl.treksoft.kvision.form.check/-radio-group/label.html new file mode 100644 index 00000000..c8409200 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/label.html @@ -0,0 +1,15 @@ + + + +RadioGroup.label - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / label
+
+

label

+ +var label: String? +

The label text of the options group.

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

name

+ +open var name: String? +

Overrides FormControl.name

The name attribute of the generated HTML input element.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/options.html b/api/pl.treksoft.kvision.form.check/-radio-group/options.html new file mode 100644 index 00000000..f1120584 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/options.html @@ -0,0 +1,21 @@ + + + +RadioGroup.options - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / 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/radio-group.html b/api/pl.treksoft.kvision.form.check/-radio-group/radio-group.html new file mode 100644 index 00000000..aa1a0741 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/radio-group.html @@ -0,0 +1,16 @@ + + + +RadioGroup.radioGroup - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / radioGroup
+
+

radioGroup

+ +

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

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/rich.html b/api/pl.treksoft.kvision.form.check/-radio-group/rich.html new file mode 100644 index 00000000..1863196c --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/rich.html @@ -0,0 +1,15 @@ + + + +RadioGroup.rich - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

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

size

+ +open var size: InputSize? +

Overrides FormControl.size

Input control field size.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/validation-info.html b/api/pl.treksoft.kvision.form.check/-radio-group/validation-info.html new file mode 100644 index 00000000..40d3409b --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/validation-info.html @@ -0,0 +1,16 @@ + + + +RadioGroup.validationInfo - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / validationInfo
+
+

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

Validation info component.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/value.html b/api/pl.treksoft.kvision.form.check/-radio-group/value.html new file mode 100644 index 00000000..534db71a --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-radio-group/value.html @@ -0,0 +1,22 @@ + + + +RadioGroup.value - kvision + + + +kvision / pl.treksoft.kvision.form.check / RadioGroup / value
+
+

value

+ +open var value: String? +

Overrides StringFormControl.value

A value of the selected option.

Getter
+

A value of the selected option.

Setter
+

A value of the selected option.

+ + -- cgit