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 --- .../-spinner/-init-.html | 35 ++ .../-spinner/autofocus.html | 15 + .../-spinner/buttons-type.html | 15 + .../-spinner/decimals.html | 15 + .../-spinner/disabled.html | 22 ++ .../-spinner/flabel.html | 16 + .../-spinner/force-type.html | 15 + .../-spinner/get-sn-class.html | 18 + .../-spinner/get-value-as-string.html | 16 + .../-spinner/idc.html | 14 + .../-spinner/index.html | 365 +++++++++++++++++++++ .../-spinner/input.html | 16 + .../-spinner/label.html | 15 + .../-spinner/max.html | 15 + .../-spinner/min.html | 15 + .../-spinner/name.html | 15 + .../-spinner/placeholder.html | 15 + .../-spinner/readonly.html | 15 + .../-spinner/remove-event-listeners.html | 18 + .../-spinner/rich.html | 15 + .../-spinner/set-event-listener.html | 54 +++ .../-spinner/size.html | 22 ++ .../-spinner/spin-down.html | 15 + .../-spinner/spin-up.html | 15 + .../-spinner/start-value.html | 17 + .../-spinner/step.html | 15 + .../-spinner/validation-info.html | 16 + .../-spinner/value.html | 22 ++ 28 files changed, 861 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/input.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/label.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/max.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/min.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/name.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/placeholder.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/readonly.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/remove-event-listeners.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/rich.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/set-event-listener.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/size.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-down.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-up.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/start-value.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/step.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/validation-info.html create mode 100644 docs/api/pl.treksoft.kvision.form.spinner/-spinner/value.html (limited to 'docs/api/pl.treksoft.kvision.form.spinner/-spinner') diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html new file mode 100644 index 00000000..d3167048 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html @@ -0,0 +1,35 @@ + + + +Spinner.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / <init>
+
+

<init>

+ +Spinner(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: BUTTONSTYPE = BUTTONSTYPE.VERTICAL, forceType: FORCETYPE = FORCETYPE.NONE, label: String? = null, rich: Boolean = false) +

Parameters

+

+value - spinner value

+

+min - minimal value (default 0)

+

+max - maximal value (default 100)

+

+step - step value (default 1)

+

+decimals - number of decimal digits (default 0)

+

+buttonsType - spinner buttons type

+

+forceType - spinner force rounding type

+

+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.spinner/-spinner/autofocus.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html new file mode 100644 index 00000000..1aeba366 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html @@ -0,0 +1,15 @@ + + + +Spinner.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the spinner is automatically focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html new file mode 100644 index 00000000..24b812a0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html @@ -0,0 +1,15 @@ + + + +Spinner.buttonsType - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / buttonsType
+
+

buttonsType

+ +var buttonsType: BUTTONSTYPE +

Spinner buttons type.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html new file mode 100644 index 00000000..7a5a1514 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html @@ -0,0 +1,15 @@ + + + +Spinner.decimals - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / decimals
+
+

decimals

+ +var decimals: Int +

Number of decimal digits value.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/disabled.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/disabled.html new file mode 100644 index 00000000..7207261e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/disabled.html @@ -0,0 +1,22 @@ + + + +Spinner.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / 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.spinner/-spinner/flabel.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html new file mode 100644 index 00000000..737a1580 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html @@ -0,0 +1,16 @@ + + + +Spinner.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html new file mode 100644 index 00000000..bcf84a58 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html @@ -0,0 +1,15 @@ + + + +Spinner.forceType - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / forceType
+
+

forceType

+ +var forceType: FORCETYPE +

Spinner force rounding type.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html new file mode 100644 index 00000000..08e1ee5d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Spinner.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / 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.spinner/-spinner/get-value-as-string.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html new file mode 100644 index 00000000..15884cd9 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +Spinner.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides NumberFormControl.getValueAsString

+

Returns the value of the control as a String.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html new file mode 100644 index 00000000..db68cb2d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html @@ -0,0 +1,14 @@ + + + +Spinner.idc - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / idc
+
+

idc

+ +protected val idc: String + + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/index.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/index.html new file mode 100644 index 00000000..4907a880 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/index.html @@ -0,0 +1,365 @@ + + + +Spinner - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner
+
+

Spinner

+open class Spinner : SimplePanel, NumberFormControl +

The form field component for spinner control.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Spinner(value: Number? = null, min: Int = 0, max: Int = DEFAULT_MAX, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: BUTTONSTYPE = BUTTONSTYPE.VERTICAL, forceType: FORCETYPE = FORCETYPE.NONE, label: String? = null, rich: Boolean = false)
+

Properties

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

autofocus

+		 +var autofocus: Boolean? +

Determines if the spinner is automatically focused.

+
+

buttonsType

+		 +var buttonsType: BUTTONSTYPE +

Spinner buttons type.

+
+

decimals

+		 +var decimals: Int +

Number of decimal digits value.

+
+

disabled

+		 +open var disabled: Boolean +

Determines if the field is disabled.

+
+

flabel

+		 +val flabel: FieldLabel +

Form field label.

+
+

forceType

+		 +var forceType: FORCETYPE +

Spinner force rounding type.

+
+

idc

+		 +val idc: String
+

input

+		 +val input: SpinnerInput +

The actual input component.

+
+

label

+		 +var label: String? +

The label text bound to the spinner input element.

+
+

max

+		 +var max: Int +

Maximal value.

+
+

min

+		 +var min: Int +

Minimal value.

+
+

name

+		 +var name: String? +

The name attribute of the generated HTML input element.

+
+

placeholder

+		 +var placeholder: String? +

The placeholder for the spinner input.

+
+

readonly

+		 +var readonly: Boolean? +

Determines if the spinner is read-only.

+
+

rich

+		 +var rich: Boolean +

Determines if label can contain HTML code.

+
+

size

+		 +open var size: INPUTSIZE? +

Input control size.

+
+

startValue

+		 +var startValue: Number? +

The value attribute of the generated HTML input element.

+
+

step

+		 +var step: Double +

Step value.

+
+

validationInfo

+		 +val validationInfo: HelpBlock +

Validation info component.

+
+

value

+		 +open var value: Number? +

Spinner value.

+
+

Functions

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

getSnClass

+		 +open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+
+

getValueAsString

+		 +open fun getValueAsString(): String? +

Returns the value of the control as a String.

+
+

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.

+
+

spinDown

+		 +open fun spinDown(): Spinner +

Change value in minus.

+
+

spinUp

+		 +open fun spinUp(): Spinner +

Change value in plus.

+
+

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

Returns the value of the control.

+
+

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.spinner/-spinner/input.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/input.html new file mode 100644 index 00000000..d2a84521 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/input.html @@ -0,0 +1,16 @@ + + + +Spinner.input - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / input
+
+

input

+ +val input: SpinnerInput +

Overrides FormControl.input

+

The actual input component.

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

label

+ +var label: String? +

The label text bound to the spinner input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/max.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/max.html new file mode 100644 index 00000000..713b977d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/max.html @@ -0,0 +1,15 @@ + + + +Spinner.max - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / max
+
+

max

+ +var max: Int +

Maximal value.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/min.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/min.html new file mode 100644 index 00000000..9cbca796 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/min.html @@ -0,0 +1,15 @@ + + + +Spinner.min - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / min
+
+

min

+ +var min: Int +

Minimal value.

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

name

+ +var name: String? +

The name attribute of the generated HTML input element.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/placeholder.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/placeholder.html new file mode 100644 index 00000000..a3637a80 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/placeholder.html @@ -0,0 +1,15 @@ + + + +Spinner.placeholder - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / placeholder
+
+

placeholder

+ +var placeholder: String? +

The placeholder for the spinner input.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/readonly.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/readonly.html new file mode 100644 index 00000000..9ac92238 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/readonly.html @@ -0,0 +1,15 @@ + + + +Spinner.readonly - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / readonly
+
+

readonly

+ +var readonly: Boolean? +

Determines if the spinner is read-only.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/remove-event-listeners.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/remove-event-listeners.html new file mode 100644 index 00000000..2747fbdf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +Spinner.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / 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.spinner/-spinner/rich.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/rich.html new file mode 100644 index 00000000..1db89286 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/rich.html @@ -0,0 +1,15 @@ + + + +Spinner.rich - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/set-event-listener.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/set-event-listener.html new file mode 100644 index 00000000..73f9bae5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/set-event-listener.html @@ -0,0 +1,54 @@ + + + +Spinner.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / 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.spinner/-spinner/size.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/size.html new file mode 100644 index 00000000..bf59764f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/size.html @@ -0,0 +1,22 @@ + + + +Spinner.size - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / size
+
+

size

+ +open var size: INPUTSIZE? +

Overrides FormControl.size

+

Input control size.

+

Getter
+

Input control size.

+

+

Setter
+

Input control size.

+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-down.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-down.html new file mode 100644 index 00000000..426cfb31 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-down.html @@ -0,0 +1,15 @@ + + + +Spinner.spinDown - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / spinDown
+
+

spinDown

+ +open fun spinDown(): Spinner +

Change value in minus.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-up.html b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-up.html new file mode 100644 index 00000000..59c21418 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.spinner/-spinner/spin-up.html @@ -0,0 +1,15 @@ + + + +Spinner.spinUp - kvision + + + +kvision / pl.treksoft.kvision.form.spinner / Spinner / spinUp
+
+

spinUp

+ +open fun spinUp(