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 --- .../-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 ++ 19 files changed, 652 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/-init-.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/blur.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/check-box.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/circled.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/flabel.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/focus.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/index.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/inline.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/input.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/label.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/on-click.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/rich.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/start-value.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/style.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.check/-check-box/value.html (limited to 'api/pl.treksoft.kvision.form.check/-check-box') diff --git a/api/pl.treksoft.kvision.form.check/-check-box/-init-.html b/api/pl.treksoft.kvision.form.check/-check-box/-init-.html new file mode 100644 index 00000000..069d4b71 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/blur.html b/api/pl.treksoft.kvision.form.check/-check-box/blur.html new file mode 100644 index 00000000..ac7ab781 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/check-box.html b/api/pl.treksoft.kvision.form.check/-check-box/check-box.html new file mode 100644 index 00000000..31c07058 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/circled.html b/api/pl.treksoft.kvision.form.check/-check-box/circled.html new file mode 100644 index 00000000..a62c5c71 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/flabel.html b/api/pl.treksoft.kvision.form.check/-check-box/flabel.html new file mode 100644 index 00000000..75f0444f --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/focus.html b/api/pl.treksoft.kvision.form.check/-check-box/focus.html new file mode 100644 index 00000000..13d5d003 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html new file mode 100644 index 00000000..096322d7 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/index.html b/api/pl.treksoft.kvision.form.check/-check-box/index.html new file mode 100644 index 00000000..dbcc8daa --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/inline.html b/api/pl.treksoft.kvision.form.check/-check-box/inline.html new file mode 100644 index 00000000..d47e2591 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/input.html b/api/pl.treksoft.kvision.form.check/-check-box/input.html new file mode 100644 index 00000000..95850692 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/label.html b/api/pl.treksoft.kvision.form.check/-check-box/label.html new file mode 100644 index 00000000..7cda3b63 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/on-click.html b/api/pl.treksoft.kvision.form.check/-check-box/on-click.html new file mode 100644 index 00000000..21a05b0a --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html b/api/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html new file mode 100644 index 00000000..de175e54 --- /dev/null +++ b/api/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/pl.treksoft.kvision.form.check/-check-box/rich.html b/api/pl.treksoft.kvision.form.check/-check-box/rich.html new file mode 100644 index 00000000..e048f0d1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-box/rich.html @@ -0,0 +1,15 @@ + + + +CheckBox.rich - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html b/api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html new file mode 100644 index 00000000..a47d91c9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html @@ -0,0 +1,54 @@ + + + +CheckBox.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / setEventListener
+
+

setEventListener

+ +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Overrides Widget.setEventListener

Sets an event listener for current widget, keeping the actual type of component.

Parameters

+T - widget type

+block - event handler

Return
+

current widget

+ + +

Example:

+ + +

    button.setEventListener<Button> {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Button here
+        }
+    }

+ +open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Overrides Widget.setEventListener

Sets an event listener for current widget.

Parameters

+block - event handler

Return
+

current widget

+ + +

Example:

+ + +

    button.setEventListener {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Widget here
+        }
+    }

+ + diff --git a/api/pl.treksoft.kvision.form.check/-check-box/start-value.html b/api/pl.treksoft.kvision.form.check/-check-box/start-value.html new file mode 100644 index 00000000..8b375beb --- /dev/null +++ b/api/pl.treksoft.kvision.form.check/-check-box/start-value.html @@ -0,0 +1,17 @@ + + + +CheckBox.startValue - kvision + + + +kvision / pl.treksoft.kvision.form.check / CheckBox / startValue
+
+

startValue

+ +var startValue: Boolean +

The value attribute of the generated HTML input element.

This value is placed directly in generated HTML code, while the value property is dynamically +bound to the input selection state.

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

style

+ +var style: CheckBoxStyle? +

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

Getter
+

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

Setter
+

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

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

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

Validation info component.

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

value

+ +open var value: Boolean +

Overrides BoolFormControl.value

The selection state of the checkbox.

+ + -- cgit