From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-radio/-init-.html | 27 ++ .../-radio/disabled.html | 22 ++ .../-radio/extra-value.html | 15 + .../-radio/flabel.html | 16 ++ .../-radio/get-sn-class.html | 18 ++ .../-radio/index.html | 304 +++++++++++++++++++++ .../-radio/inline.html | 15 + .../-radio/input.html | 16 ++ .../-radio/label.html | 15 + .../-radio/name.html | 15 + .../-radio/on-click.html | 15 + .../-radio/remove-event-listeners.html | 18 ++ .../-radio/rich.html | 15 + .../-radio/set-event-listener.html | 54 ++++ .../-radio/size.html | 22 ++ .../-radio/squared.html | 15 + .../-radio/start-value.html | 17 ++ .../-radio/style.html | 15 + .../-radio/validation-info.html | 16 ++ .../-radio/value.html | 22 ++ 20 files changed, 672 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/extra-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/flabel.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/inline.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/input.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/label.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/on-click.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/remove-event-listeners.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/rich.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/set-event-listener.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/squared.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/start-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/style.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/validation-info.html create mode 100644 docs/api/pl.treksoft.kvision.form.check/-radio/value.html (limited to 'docs/api/pl.treksoft.kvision.form.check/-radio') diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/-init-.html b/docs/api/pl.treksoft.kvision.form.check/-radio/-init-.html new file mode 100644 index 00000000..1294864f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/-init-.html @@ -0,0 +1,27 @@ + + + +Radio.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / <init>
+
+

<init>

+ +

Radio(value: Boolean = false, extraValue: String? = null, name: String? = null, label: String? = null, rich: Boolean = false)

Parameters

+value - selection state

+extraValue - the additional String value used for the radio button group

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

+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.check/-radio/disabled.html b/docs/api/pl.treksoft.kvision.form.check/-radio/disabled.html new file mode 100644 index 00000000..14b36325 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/disabled.html @@ -0,0 +1,22 @@ + + + +Radio.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / 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.check/-radio/extra-value.html b/docs/api/pl.treksoft.kvision.form.check/-radio/extra-value.html new file mode 100644 index 00000000..65bfd84c --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/extra-value.html @@ -0,0 +1,15 @@ + + + +Radio.extraValue - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / extraValue
+
+

extraValue

+ +var extraValue: String? +

The additional String value used for the radio button group.

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

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

Form field label.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.check/-radio/get-sn-class.html new file mode 100644 index 00000000..4e585f76 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Radio.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / 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.check/-radio/index.html b/docs/api/pl.treksoft.kvision.form.check/-radio/index.html new file mode 100644 index 00000000..914d5277 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/index.html @@ -0,0 +1,304 @@ + + + +Radio - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio
+
+

Radio

+open class Radio : SimplePanel, BoolFormControl +

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

Constructors

+ + + + + + + +

<init>

Radio(value: Boolean = false, extraValue: String? = null, name: String? = null, label: String? = null, rich: Boolean = false)

Properties

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

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ extraValue +	+`var extraValue: String?` + The additional String value used for the radio button group. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ inline +	+`var inline: Boolean` + Determines if the radio button is rendered inline. +
+ input +	+`val input: CheckInput` + The actual input component. +
+ label +	+`var label: String?` + The label text bound to the input element. +
+ name +	+`var name: String?` + The name attribute of the generated HTML input element. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ size +	+`open var size: INPUTSIZE?` + The size of the input. +
+ squared +	+`var squared: Boolean` + Determines if the radio button is rendered as a square. +
+ startValue +	+`var startValue: Boolean` + The value attribute of the generated HTML input element. +
+ style +	+`var style: RADIOSTYLE?` + 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 radio button. +

Functions

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

+ 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: Radio.(MouseEvent) -> Unit): Radio` + 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. +

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/inline.html b/docs/api/pl.treksoft.kvision.form.check/-radio/inline.html new file mode 100644 index 00000000..975ea883 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/inline.html @@ -0,0 +1,15 @@ + + + +Radio.inline - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / inline
+
+

inline

+ +var inline: Boolean +

Determines if the radio button is rendered inline.

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

input

+ +val input: CheckInput +

Overrides FormControl.input

The actual input component.

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

label

+ +var label: String? +

The label text bound to the input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/name.html b/docs/api/pl.treksoft.kvision.form.check/-radio/name.html new file mode 100644 index 00000000..06afc43d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/name.html @@ -0,0 +1,15 @@ + + + +Radio.name - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / name
+
+

name

+ +var name: String? +

The name attribute of the generated HTML input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/on-click.html b/docs/api/pl.treksoft.kvision.form.check/-radio/on-click.html new file mode 100644 index 00000000..7ea9c764 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/on-click.html @@ -0,0 +1,15 @@ + + + +Radio.onClick - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / onClick
+
+

onClick

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

A convenient helper for easy setting onClick event handler.

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

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

Removes all event listeners from current widget.

Return
+current widget

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

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/set-event-listener.html b/docs/api/pl.treksoft.kvision.form.check/-radio/set-event-listener.html new file mode 100644 index 00000000..db72a974 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/set-event-listener.html @@ -0,0 +1,54 @@ + + + +Radio.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / 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/docs/api/pl.treksoft.kvision.form.check/-radio/size.html b/docs/api/pl.treksoft.kvision.form.check/-radio/size.html new file mode 100644 index 00000000..173c0b83 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/size.html @@ -0,0 +1,22 @@ + + + +Radio.size - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / size
+
+

size

+ +open var size: INPUTSIZE? +

Overrides FormControl.size

The size of the input.

Getter
+

Input control size.

Setter
+

Input control size.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/squared.html b/docs/api/pl.treksoft.kvision.form.check/-radio/squared.html new file mode 100644 index 00000000..dcdcc379 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/squared.html @@ -0,0 +1,15 @@ + + + +Radio.squared - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / squared
+
+

squared

+ +var squared: Boolean +

Determines if the radio button is rendered as a square.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.check/-radio/start-value.html b/docs/api/pl.treksoft.kvision.form.check/-radio/start-value.html new file mode 100644 index 00000000..d9e8e9a6 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/start-value.html @@ -0,0 +1,17 @@ + + + +Radio.startValue - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / 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/docs/api/pl.treksoft.kvision.form.check/-radio/style.html b/docs/api/pl.treksoft.kvision.form.check/-radio/style.html new file mode 100644 index 00000000..309ff5de --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.check/-radio/style.html @@ -0,0 +1,15 @@ + + + +Radio.style - kvision + + + +kvision / pl.treksoft.kvision.form.check / Radio / style
+
+

style

+ +var style: RADIOSTYLE? +

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

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

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

Validation info component.

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

value

+ +open var value: Boolean +

Overrides BoolFormControl.value

The selection state of the radio button.

Getter
+

Boolean value.

Setter
+

Boolean value.

+ + -- cgit