From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-check-box-style/-d-a-n-g-e-r.html | 14 + .../-check-box-style/-d-e-f-a-u-l-t.html | 14 + .../-check-box-style/-i-n-f-o.html | 14 + .../-check-box-style/-p-r-i-m-a-r-y.html | 14 + .../-check-box-style/-s-u-c-c-e-s-s.html | 14 + .../-check-box-style/-w-a-r-n-i-n-g.html | 14 + .../-check-box-style/index.html | 61 +++ .../-check-box/-init-.html | 25 ++ .../-check-box/blur.html | 16 + .../-check-box/check-box.html | 16 + .../-check-box/circled.html | 21 + .../-check-box/flabel.html | 16 + .../-check-box/focus.html | 16 + .../-check-box/get-sn-class.html | 18 + .../-check-box/index.html | 300 +++++++++++++ .../-check-box/inline.html | 21 + .../-check-box/input.html | 16 + .../-check-box/label.html | 15 + .../-check-box/on-click.html | 15 + .../-check-box/remove-event-listeners.html | 18 + .../-check-box/rich.html | 15 + .../-check-box/set-event-listener.html | 54 +++ .../-check-box/start-value.html | 17 + .../-check-box/style.html | 21 + .../-check-box/validation-info.html | 16 + .../-check-box/value.html | 16 + .../-check-input-type/-c-h-e-c-k-b-o-x.html | 14 + .../-check-input-type/-r-a-d-i-o.html | 14 + .../-check-input-type/index.html | 33 ++ .../-check-input/-init-.html | 23 + .../-check-input/after-insert.html | 16 + .../-check-input/after-postpatch.html | 16 + .../-check-input/blur.html | 15 + .../-check-input/check-input.html | 16 + .../-check-input/disabled.html | 22 + .../-check-input/extra-value.html | 21 + .../-check-input/focus.html | 15 + .../-check-input/get-sn-attrs.html | 18 + .../-check-input/get-sn-class.html | 18 + .../-check-input/index.html | 486 +++++++++++++++++++++ .../-check-input/name.html | 22 + .../-check-input/on-click.html | 15 + .../-check-input/render.html | 18 + .../-check-input/size.html | 22 + .../-check-input/start-value.html | 27 ++ .../-check-input/type.html | 21 + .../-check-input/value.html | 21 + .../-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 + .../-radio-style/-d-a-n-g-e-r.html | 14 + .../-radio-style/-d-e-f-a-u-l-t.html | 14 + .../-radio-style/-i-n-f-o.html | 14 + .../-radio-style/-p-r-i-m-a-r-y.html | 14 + .../-radio-style/-s-u-c-c-e-s-s.html | 14 + .../-radio-style/-w-a-r-n-i-n-g.html | 14 + .../-radio-style/index.html | 61 +++ .../-radio/-init-.html | 27 ++ .../-radio/blur.html | 16 + .../-radio/extra-value.html | 15 + .../-radio/flabel.html | 16 + .../-radio/focus.html | 16 + .../-radio/get-sn-class.html | 18 + .../-radio/index.html | 309 +++++++++++++ .../-radio/inline.html | 21 + .../-radio/input.html | 16 + .../-radio/label.html | 15 + .../-radio/on-click.html | 15 + .../-radio/radio.html | 16 + .../-radio/remove-event-listeners.html | 18 + .../-radio/rich.html | 15 + .../-radio/set-event-listener.html | 54 +++ .../-radio/squared.html | 21 + .../-radio/start-value.html | 17 + .../-radio/style.html | 21 + .../-radio/validation-info.html | 16 + .../-radio/value.html | 16 + .../pl.treksoft.kvision.form.check/index.html | 81 ++++ 92 files changed, 3141 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-a-n-g-e-r.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-e-f-a-u-l-t.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-i-n-f-o.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-p-r-i-m-a-r-y.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-s-u-c-c-e-s-s.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-w-a-r-n-i-n-g.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box-style/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/blur.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/check-box.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/circled.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/flabel.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/focus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/inline.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/input.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/label.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/on-click.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/rich.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/start-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/style.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/validation-info.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-box/value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input-type/-c-h-e-c-k-b-o-x.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input-type/-r-a-d-i-o.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input-type/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/after-insert.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/after-postpatch.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/blur.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/check-input.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/disabled.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/extra-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/focus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/get-sn-attrs.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/name.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/on-click.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/render.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/size.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/start-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/type.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-check-input/value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/blur.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/disabled.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/flabel.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/focus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/inline.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/input.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/label.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/name.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/options.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/radio-group.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/rich.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/size.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/validation-info.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-group/value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-d-a-n-g-e-r.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-d-e-f-a-u-l-t.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-i-n-f-o.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-p-r-i-m-a-r-y.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-s-u-c-c-e-s-s.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/-w-a-r-n-i-n-g.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio-style/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/blur.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/extra-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/flabel.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/focus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/inline.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/input.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/label.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/on-click.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/radio.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/remove-event-listeners.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/rich.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/set-event-listener.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/squared.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/start-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/style.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/validation-info.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/-radio/value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.check/index.html (limited to 'api/kvision/pl.treksoft.kvision.form.check') diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-a-n-g-e-r.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-a-n-g-e-r.html new file mode 100644 index 00000000..fcb5259b --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-a-n-g-e-r.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.DANGER - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / DANGER
+
+

DANGER

+ +DANGER + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-e-f-a-u-l-t.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-e-f-a-u-l-t.html new file mode 100644 index 00000000..ac33f0ed --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-d-e-f-a-u-l-t.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.DEFAULT - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / DEFAULT
+
+

DEFAULT

+ +DEFAULT + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-i-n-f-o.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-i-n-f-o.html new file mode 100644 index 00000000..2dd8f53b --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-i-n-f-o.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.INFO - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / INFO
+
+

INFO

+ +INFO + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-p-r-i-m-a-r-y.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-p-r-i-m-a-r-y.html new file mode 100644 index 00000000..e9e0b996 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-p-r-i-m-a-r-y.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.PRIMARY - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / PRIMARY
+
+

PRIMARY

+ +PRIMARY + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-s-u-c-c-e-s-s.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-s-u-c-c-e-s-s.html new file mode 100644 index 00000000..83dbd75a --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-s-u-c-c-e-s-s.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.SUCCESS - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / SUCCESS
+
+

SUCCESS

+ +SUCCESS + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-w-a-r-n-i-n-g.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-w-a-r-n-i-n-g.html new file mode 100644 index 00000000..2fbfc7b2 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/-w-a-r-n-i-n-g.html @@ -0,0 +1,14 @@ + + + +CheckBoxStyle.WARNING - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle / WARNING
+
+

WARNING

+ +WARNING + + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/index.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/index.html new file mode 100644 index 00000000..6a433927 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box-style/index.html @@ -0,0 +1,61 @@ + + + +CheckBoxStyle - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBoxStyle
+
+

CheckBoxStyle

+enum class CheckBoxStyle +

Checkbox style options.

+

Enum Values

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

DEFAULT

+		 +
+

PRIMARY

+		 +
+

SUCCESS

+		 +
+

INFO

+		 +
+

WARNING

+		 +
+

DANGER

+		 +
+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/-init-.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/-init-.html new file mode 100644 index 00000000..069d4b71 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/-init-.html @@ -0,0 +1,25 @@ + + + +CheckBox.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / <init>
+
+

<init>

+ +CheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false) +

Parameters

+

+value - selection state

+

+name - the name of the input element

+

+label - label text bound to the input element

+

+rich - determines if label can contain HTML code

+

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/blur.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/blur.html new file mode 100644 index 00000000..ac7ab781 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/blur.html @@ -0,0 +1,16 @@ + + + +CheckBox.blur - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

+

Makes the input element blur.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/check-box.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/check-box.html new file mode 100644 index 00000000..31c07058 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/check-box.html @@ -0,0 +1,16 @@ + + + +CheckBox.checkBox - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / checkBox
+
+

checkBox

+ +fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit = null): CheckBox +

DSL builder extension function.

+

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

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/circled.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/circled.html new file mode 100644 index 00000000..a62c5c71 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/circled.html @@ -0,0 +1,21 @@ + + + +CheckBox.circled - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / circled
+
+

circled

+ +var circled: Boolean +

Determines if the checkbox is rendered as a circle.

+

Getter
+

Determines if the checkbox is rendered as a circle.

+

+

Setter
+

Determines if the checkbox is rendered as a circle.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/flabel.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/flabel.html new file mode 100644 index 00000000..75f0444f --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/flabel.html @@ -0,0 +1,16 @@ + + + +CheckBox.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/focus.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/focus.html new file mode 100644 index 00000000..13d5d003 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/focus.html @@ -0,0 +1,16 @@ + + + +CheckBox.focus - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / focus
+
+

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

+

Makes the input element focused.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html new file mode 100644 index 00000000..096322d7 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html @@ -0,0 +1,18 @@ + + + +CheckBox.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / 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/kvision/pl.treksoft.kvision.form.check/-check-box/index.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/index.html new file mode 100644 index 00000000..dbcc8daa --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/index.html @@ -0,0 +1,300 @@ + + + +CheckBox - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox
+
+

CheckBox

+open class CheckBox : SimplePanel, BoolFormControl +

The form field component rendered as HTML input type="checkbox".

+

Constructors

+ + + + + + + +
+

<init>

+		 +CheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)
+

Properties

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

circled

+		 +var circled: Boolean +

Determines if the checkbox is rendered as a circle.

+
+

flabel

+		 +val flabel: FieldLabel +

Form field label.

+
+

inline

+		 +var inline: Boolean +

Determines if the checkbox is rendered inline.

+
+

input

+		 +val input: CheckInput +

The actual input component.

+
+

label

+		 +var label: String? +

The label text bound to the input element.

+
+

rich

+		 +var rich: Boolean +

Determines if label can contain HTML code.

+
+

startValue

+		 +var startValue: Boolean +

The value attribute of the generated HTML input element.

+
+

style

+		 +var style: CheckBoxStyle? +

The style (one of Bootstrap standard colors) of the input.

+
+

validationInfo

+		 +val validationInfo: HelpBlock +

Validation info component.

+
+

value

+		 +open var value: Boolean +

The selection state of the checkbox.

+
+

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.

+
+

onClick

+		 +open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox +

A convenient helper for easy setting onClick event handler.

+
+

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.

+
+

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(): Boolean +

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

+ + + + + + + +
+

checkBox

+		 +fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit = null): CheckBox +

DSL builder extension function.

+
+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/inline.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/inline.html new file mode 100644 index 00000000..d47e2591 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/inline.html @@ -0,0 +1,21 @@ + + + +CheckBox.inline - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / inline
+
+

inline

+ +var inline: Boolean +

Determines if the checkbox is rendered inline.

+

Getter
+

Determines if the checkbox is rendered inline.

+

+

Setter
+

Determines if the checkbox is rendered inline.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/input.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/input.html new file mode 100644 index 00000000..95850692 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/input.html @@ -0,0 +1,16 @@ + + + +CheckBox.input - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / input
+
+

input

+ +val input: CheckInput +

Overrides FormControl.input

+

The actual input component.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/label.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/label.html new file mode 100644 index 00000000..7cda3b63 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/label.html @@ -0,0 +1,15 @@ + + + +CheckBox.label - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / label
+
+

label

+ +var label: String? +

The label text bound to the input element.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/on-click.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/on-click.html new file mode 100644 index 00000000..21a05b0a --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/on-click.html @@ -0,0 +1,15 @@ + + + +CheckBox.onClick - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / onClick
+
+

onClick

+ +open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox +

A convenient helper for easy setting onClick event handler.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html new file mode 100644 index 00000000..de175e54 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +CheckBox.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

+

Removes all event listeners from current widget.

+

Return
+current widget

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.check/-check-box/rich.html b/api/kvision/pl.treksoft.kvision.form.check/-check-box/rich.html new file mode 100644 index 00000000..e048f0d1 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.check/-check-box/rich.html @@ -0,0 +1,15 @@ + + + +CheckBox.rich - kvision + + + +kvision /