From 6ce402754e01940fc641f8814eae03599a622b1c Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 9 Feb 2020 14:23:52 +0100 Subject: API documentation for KVision 2.10.0 --- .../-range/-init-.html | 31 + .../-range/autofocus.html | 15 + .../-range/blur.html | 16 + .../-range/flabel.html | 16 + .../-range/focus.html | 16 + .../-range/get-sn-class.html | 18 + .../-range/get-value-as-string.html | 16 + api/pl.treksoft.kvision.form.range/-range/idc.html | 14 + .../-range/index.html | 1203 ++++++++++++++++++++ .../-range/input.html | 16 + .../-range/invalid-feedback.html | 16 + .../-range/label.html | 15 + api/pl.treksoft.kvision.form.range/-range/max.html | 15 + api/pl.treksoft.kvision.form.range/-range/min.html | 15 + .../-range/readonly.html | 15 + .../-range/remove-event-listeners.html | 18 + .../-range/rich.html | 15 + .../-range/set-event-listener.html | 57 + .../-range/start-value.html | 17 + .../-range/step-down.html | 15 + .../-range/step-up.html | 15 + .../-range/step.html | 15 + .../-range/style-for-horizontal-form-panel.html | 16 + .../-range/validator-error.html | 16 + .../-range/value.html | 16 + 25 files changed, 1637 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.range/-range/-init-.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/autofocus.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/blur.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/flabel.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/focus.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/idc.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/index.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/input.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/invalid-feedback.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/label.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/max.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/min.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/readonly.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/rich.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/start-value.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/step-down.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/step-up.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/step.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/style-for-horizontal-form-panel.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/validator-error.html create mode 100644 api/pl.treksoft.kvision.form.range/-range/value.html (limited to 'api/pl.treksoft.kvision.form.range/-range') diff --git a/api/pl.treksoft.kvision.form.range/-range/-init-.html b/api/pl.treksoft.kvision.form.range/-range/-init-.html new file mode 100644 index 00000000..6a050b70 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/-init-.html @@ -0,0 +1,31 @@ + + + +Range.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / <init>
+
+

<init>

+ +

Range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, label: String? = null, rich: Boolean = false)

Parameters

+value - range input value

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

+min - minimal value (default 0)

+max - maximal value (default 100)

+step - step value (default 1)

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

autofocus

+ +var autofocus: Boolean? +

Determines if the text input is automatically focused.

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

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.range/-range/flabel.html b/api/pl.treksoft.kvision.form.range/-range/flabel.html new file mode 100644 index 00000000..a5a20b3b --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/flabel.html @@ -0,0 +1,16 @@ + + + +Range.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

Form field label.

+ + diff --git a/api/pl.treksoft.kvision.form.range/-range/focus.html b/api/pl.treksoft.kvision.form.range/-range/focus.html new file mode 100644 index 00000000..53ac1757 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/focus.html @@ -0,0 +1,16 @@ + + + +Range.focus - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / focus
+
+

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html b/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html new file mode 100644 index 00000000..b259af93 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Range.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / 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.range/-range/get-value-as-string.html b/api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html new file mode 100644 index 00000000..dfd83f25 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +Range.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides NumberFormControl.getValueAsString

Returns the value of the control as a String.

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

idc

+ +protected val idc: String + + diff --git a/api/pl.treksoft.kvision.form.range/-range/index.html b/api/pl.treksoft.kvision.form.range/-range/index.html new file mode 100644 index 00000000..885767a6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.range/-range/index.html @@ -0,0 +1,1203 @@ + + + +Range - kvision + + + +kvision / pl.treksoft.kvision.form.range / Range
+
+

Range

+open class Range : SimplePanel, NumberFormControl +

The form field component for range input control.

Constructors

+ + + + + + + +

<init>

Range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, label: String? = null, rich: Boolean = false)

Properties

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

+ autofocus +	+`var autofocus: Boolean?` + Determines if the text input is automatically focused. +
+ flabel +	+`val flabel: FieldLabel` + Form field label. +
+ idc +	+`val idc: String`
+ input +	+`val input: RangeInput` + The actual input component. +
+ invalidFeedback +	+`val invalidFeedback: InvalidFeedback` + Invalid feedback component. +
+ label +	+`var label: String?` + The label text bound to the range input element. +
+ max +	+`var max: Number` + Maximal value. +
+ min +	+`var min: Number` + Minimal value. +
+ readonly +	+`var readonly: Boolean?` + Determines if the range input is read-only. +
+ rich +	+`var rich: Boolean` + Determines if label can contain HTML code. +
+ startValue +	+`var startValue: Number?` + The value attribute of the generated HTML input element. +
+ step +	+`var step: Number` + Step value. +
+ validatorError +	+`open var validatorError: String?` + Validator error message. +
+ value +	+`open var value: Number?` + Range input value. +

Inherited Properties

+ + + + + + + +

children

+val children: MutableList<Component>

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. +
+ 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. +
+ stepDown +	+`open fun stepDown(): Range` + Change value in minus. +
+ stepUp +	+`open fun stepUp(): Range` + Change value in plus. +
+ styleForHorizontalFormPanel +	+`open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio): Unit` + Style form control element for horizontal form panel. +

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. +

Extension Functions

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

+ addBsBgColor +	+`fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit`
+ addBsBorder +	+`fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit`
+ addBsClearfix +	+`fun Component.addBsClearfix(): Unit`
+ addBsColor +	+`fun Component.addBsColor(bsColor: BsColor): Unit`
+ addBsRounded +	+`fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit`
+ bold +	+`fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold` + DSL builder extension function. +
+ button +	+`fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button` + DSL builder extension function. +
+ buttonGroup +	+`fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup` + DSL builder extension function. +
+ canvas +	+`fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas` + DSL builder extension function. +
+ chart +	+`fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart` + DSL builder extension function. +
+ checkBox +	+`fun Container.checkBox(value: Boolean = false, name: String`