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/index.html | 1203 ++++++++++++++++++++ 1 file changed, 1203 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.range/-range/index.html (limited to 'api/pl.treksoft.kvision.form.range/-range/index.html') 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? = null, label: String? = null, rich: Boolean = false, init: (CheckBox.() -> Unit)? = null): CheckBox` + DSL builder extension function. +
+ checkBoxInput +	+`fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput` + DSL builder extension function. +
+ contextMenu +	+`fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu` + DSL builder extension function. +
+ createInstance +	+`fun <T> Any?.createInstance(vararg args: dynamic): T` + Helper function for creating JavaScript objects from dynamic constructors. +
+ dataContainer +	+`fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: Container.(M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null,`