From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-range-input/index.html | 686 ++++----------------- 1 file changed, 107 insertions(+), 579 deletions(-) (limited to 'api/pl.treksoft.kvision.form.range/-range-input/index.html') diff --git a/api/pl.treksoft.kvision.form.range/-range-input/index.html b/api/pl.treksoft.kvision.form.range/-range-input/index.html index 23415648..e642b39e 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/index.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.range / RangeInput

RangeInput

-open class RangeInput : Widget, FormInput +(js) open class RangeInput : Widget, FormInput

Range input component.

Constructors

@@ -27,212 +28,102 @@ +var autofocus: Boolean? +open var disabled: Boolean +var max: Number +var min: Number +open var name: String? +var readonly: Boolean? +open var size: InputSize? +var startValue: Number? +var step: Number +open var validationStatus: ValidationStatus? - - -
-

<init>

+(js) +

<init>

 RangeInput(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, classes: Set<String> = setOf())
-

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the range input is automatically focused.

-
-

disabled

+(js) +

disabled

 -open var disabled: Boolean

Determines if the field is disabled.

-
-

max

+(js) +

max

 -var max: Number

Maximal value.

-
-

min

+(js) +

min

 -var min: Number

Minimal value.

-
-

name

+(js) +

name

 -open var name: String?

The name attribute of the generated HTML input element.

-
-

readonly

+(js) +

readonly

 -var readonly: Boolean?

Determines if the range input is read-only.

-
-

size

+(js) +

size

 -open var size: InputSize?

The size of the input.

-
-

startValue

+(js) +

startValue

 -var startValue: Number?

The value attribute of the generated HTML input element.

-
-

step

+(js) +

step

 -var step: Number

Step value.

-
-

validationStatus

+(js) +

validationStatus

 -open var validationStatus: ValidationStatus?

The validation status of the input.

-
-

value

+(js) +

value

 -var value: Number?

Range input value.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var value: Number?
-

draggable

-		 -var draggable: Boolean? -

Determines if the current widget is draggable.

-
-

eventTarget

-		 -var eventTarget: Widget?
-

id

-		 -var id: String? -

An ID attribute of generated HTML element.

-
-

lastLanguage

-		 -var lastLanguage: String?
-

parent

-		 -open var parent: Container? -

Parent of the current component.

-
-

popoverOptions

-		 -var popoverOptions: PopoverOptions?
-

role

-		 -var role: String? -

A role attribute of generated HTML element.

-
-

surroundingSpan

-		 -var surroundingSpan: Boolean
-

tabindex

-		 -var tabindex: Int? -

A tabindex attribute of generated HTML element.

-
-

title

-		 -var title: String? -

A title attribute of generated HTML element.

-
-

tooltipOptions

-		 -var tooltipOptions: TooltipOptions?
-

visible

-		 -open var visible: Boolean -

Visibility state of the current component.

-
-

vnode

-		 -var vnode: VNode?
@@ -241,453 +132,84 @@ -

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

- +open fun afterInsert(node: VNode): Unit -

blur

+(js) +

blur

-open fun blur(): Unit

Makes the input element blur.

- +open fun blur(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the input element focused.

- +open fun focus(): Unit -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

Returns list of element attributes in the form of a List.

- +open fun getSnAttrs(): List<StringPair> -

getSnClass

+(js) +

getSnClass

-open fun getSnClass(): List<StringBoolPair>

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

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

getValueAsString

+(js) +

getValueAsString

-fun getValueAsString(): String?

Returns the value of the spinner as a String.

- +fun getValueAsString(): String? -

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- +open fun render(): VNode -

stepDown

+(js) +

stepDown

-open fun stepDown(): RangeInput

Change value in minus.

- +open fun stepDown(): RangeInput -

stepUp

+(js) +

stepUp

-open fun stepUp(): RangeInput

Change value in plus.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun stepUp(): RangeInput
-

addCssClass

-		 -open fun addCssClass(css: String): Widget -

Adds given value to the set of CSS classes generated in html code of current component.

-
-

addCssStyle

-		 -open fun addCssStyle(css: Style): Widget -

Adds given style object to the set of CSS classes generated in html code of current component.

-
-

addSurroundingCssClass

-		 -open fun addSurroundingCssClass(css: String): Widget -

Adds given value to the set of CSS classes generated in html code of parent component.

-
-

addSurroundingCssStyle

-		 -open fun addSurroundingCssStyle(css: Style): Widget -

Adds given style object to the set of CSS classes generated in html code of parent component.

-
-

afterCreate

-		 -open fun afterCreate(node: VNode): Unit -

Method called after creating Snabbdom vnode.

-
-

afterDestroy

-		 -open fun afterDestroy(): Unit -

Method called after destroying Snabbdom vnode.

-
-

clearDragDropData

-		 -open fun clearDragDropData(): Unit -

Clears D&D data for the current widget. It also makes it not draggable.

-
-

disablePopover

-		 -open fun disablePopover(): Widget -

Disables popover for the current widget.

-
-

disableTooltip

-		 -open fun disableTooltip(): Widget -

Disables tooltip for the current widget.

-
-

dispatchEvent

-		 -open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
-

enablePopover

-		 -open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget -

Enables popover for the current widget.

-
-

enableTooltip

-		 -open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget -

Enables tooltip for the current widget.

-
-

getAttribute

-		 -open fun getAttribute(name: String): String? -

Returns the value of an additional attribute.

-
-

getElement

-		 -open fun getElement(): Node? -

Returns DOM element bound to the current component.

-
-

getElementJQuery

-		 -open fun getElementJQuery(): JQuery? -

Returns JQuery element bound to the current component.

-
-

getElementJQueryD

-		 -open fun getElementJQueryD(): dynamic -

Returns JQuery element bound to the current component as a dynamic type.

-
-

getSnHooks

-		 -open fun getSnHooks(): Hooks? -

Returns list of hooks in the form of a Snabbdom Hooks object.

-
-

getSnOn

-		 -open fun getSnOn(): On? -

Returns list of event handlers in the form of a Snabbdom On object.

-
-

hide

-		 -open fun hide(): Widget -

Makes current widget invisible.

-
-

hidePopover

-		 -open fun hidePopover(): Widget -

Hides popover for the current widget.

-
-

hideTooltip

-		 -open fun hideTooltip(): Widget -

Hides tooltip for the current widget.

-
-

refreshOnUpdate

-		 -fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-

removeAttribute

-		 -open fun removeAttribute(name: String): Widget -

Removes the value of additional attribute.

-
-

removeCssClass

-		 -open fun removeCssClass(css: String): Widget -

Removes given value from the set of CSS classes generated in html code of current component.

-
-

removeCssStyle

-		 -open fun removeCssStyle(css: Style): Widget -

Removes given style object from the set of CSS classes generated in html code of current component.

-
-

removeEventListener

-		 -open fun removeEventListener(id: Int): Widget -

Removes event listener from current widget.

-
-

removeEventListeners

-		 -open fun removeEventListeners(): Widget -

Removes all event listeners from current widget.

-
-

removeSurroundingCssClass

-		 -open fun removeSurroundingCssClass(css: String): Widget -

Removes given value from the set of CSS classes generated in html code of parent component.

-
-

removeSurroundingCssStyle

-		 -open fun removeSurroundingCssStyle(css: Style): Widget -

Removes given style object from the set of CSS classes generated in html code of parent component.

-
-

render

-		 -open fun render(elementName: String): VNode
-open fun render(elementName: String, children: Array<dynamic>): VNode -

Renders current component as a Snabbdom vnode.

-
-

setAttribute

-		 -open fun setAttribute(name: String, value: String): Widget -

Sets the value of additional attribute.

-
-

setDragDropData

-		 -open fun setDragDropData(format: String, data: String): Unit -

Sets D&D data for the current widget. It also makes it draggable.

-
-

setDropTarget

-		 -open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
-open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit -

Sets the current widget as a D&D drop target.

-
-

setDropTargetData

-		 -open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit -

Sets the current widget as a D&D drop target with helper callback accepting String data.

-
-

setEventListener

-		 -open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int -

Sets an event listener for current widget, keeping the actual type of component.

-
-

show

-		 -open fun show(): Widget -

Makes current widget visible.

-
-

showPopover

-		 -open fun showPopover(): Widget -

Shows popover for the current widget.

-
-

showTooltip

-		 -open fun showTooltip(): Widget -

Shows tooltip for the current widget.

-
-

singleRender

-		 -fun <T> singleRender(block: () -> T): T
-

toggleVisible

-		 -open fun toggleVisible(): Widget -

Toggles visibility of current widget.

-
-

translate

-		 -fun translate(text: String?): String?
@@ -696,24 +218,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T>