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/-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 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/-init-.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/blur.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/check-box.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/circled.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/flabel.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/focus.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/index.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/inline.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/input.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/label.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/on-click.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/rich.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/start-value.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/style.html delete mode 100644 api/pl.treksoft.kvision.form.check/-check-box/validation-info.html delete 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 deleted file mode 100644 index 069d4b71..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/-init-.html +++ /dev/null @@ -1,25 +0,0 @@ - - - -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 deleted file mode 100644 index ac7ab781..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/blur.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index 31c07058..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/check-box.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index a62c5c71..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/circled.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index 75f0444f..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/flabel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index 13d5d003..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/focus.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index 096322d7..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index dbcc8daa..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - -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 deleted file mode 100644 index d47e2591..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/inline.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index 95850692..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index 7cda3b63..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/label.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 21a05b0a..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/on-click.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index de175e54..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/remove-event-listeners.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index e048f0d1..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/rich.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index a47d91c9..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/set-event-listener.html +++ /dev/null @@ -1,54 +0,0 @@ - - - -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 deleted file mode 100644 index 8b375beb..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/start-value.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -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 deleted file mode 100644 index aac0735f..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/style.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index 881e33ea..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/validation-info.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index 79ac64e8..00000000 --- a/api/pl.treksoft.kvision.form.check/-check-box/value.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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