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/-init-.html | 2 +- .../-range-input/after-insert.html | 3 +- .../-range-input/autofocus.html | 2 +- .../-range-input/blur.html | 3 +- .../-range-input/disabled.html | 3 +- .../-range-input/focus.html | 3 +- .../-range-input/get-sn-attrs.html | 3 +- .../-range-input/get-sn-class.html | 3 +- .../-range-input/get-value-as-string.html | 2 +- .../-range-input/index.html | 686 ++++----------------- .../-range-input/max.html | 2 +- .../-range-input/min.html | 2 +- .../-range-input/name.html | 3 +- .../-range-input/readonly.html | 2 +- .../-range-input/render.html | 3 +- .../-range-input/size.html | 3 +- .../-range-input/start-value.html | 2 +- .../-range-input/step-down.html | 2 +- .../-range-input/step-up.html | 2 +- .../-range-input/step.html | 2 +- .../-range-input/validation-status.html | 3 +- .../-range-input/value.html | 2 +- 22 files changed, 128 insertions(+), 610 deletions(-) (limited to 'api/pl.treksoft.kvision.form.range/-range-input') diff --git a/api/pl.treksoft.kvision.form.range/-range-input/-init-.html b/api/pl.treksoft.kvision.form.range/-range-input/-init-.html index ba3f9885..38e15eb4 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/-init-.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / <init>

<init>

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

Parameters

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/after-insert.html b/api/pl.treksoft.kvision.form.range/-range-input/after-insert.html index 81e12440..59cedc07 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/after-insert.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / afterInsert

afterInsert

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

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/autofocus.html b/api/pl.treksoft.kvision.form.range/-range-input/autofocus.html index e2b3f969..cd9496a9 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/autofocus.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the range input is automatically focused.

Getter
diff --git a/api/pl.treksoft.kvision.form.range/-range-input/blur.html b/api/pl.treksoft.kvision.form.range/-range-input/blur.html index 161b5d56..7fc962bb 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/blur.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / blur

blur

- +(js) open fun blur(): Unit -

Overrides FormInput.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/disabled.html b/api/pl.treksoft.kvision.form.range/-range-input/disabled.html index 5e9cefdd..6aa332b3 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/disabled.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / disabled

disabled

- +(js) open var disabled: Boolean -

Overrides FormInput.disabled

Determines if the field is disabled.

Getter

Determines if the field is disabled.

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/focus.html b/api/pl.treksoft.kvision.form.range/-range-input/focus.html index bbf19665..72b63300 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/focus.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / focus

focus

- +(js) open fun focus(): Unit -

Overrides FormInput.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.range/-range-input/get-sn-attrs.html index c39bab95..e80f07f0 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/get-sn-attrs.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / getSnAttrs

getSnAttrs

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

Overrides Widget.getSnAttrs

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

Return
list of element attributes

diff --git a/api/pl.treksoft.kvision.form.range/-range-input/get-sn-class.html b/api/pl.treksoft.kvision.form.range/-range-input/get-sn-class.html index 3c2bf93a..b568d784 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / getSnClass

getSnClass

- +(js) 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-input/get-value-as-string.html b/api/pl.treksoft.kvision.form.range/-range-input/get-value-as-string.html index 71fbbe2a..518998a7 100644 --- a/api/pl.treksoft.kvision.form.range/-range-input/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.range/-range-input/get-value-as-string.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / RangeInput / getValueAsString

getValueAsString

- +(js) fun getValueAsString(): String?

Returns the value of the spinner as a String.

Return
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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -<
-

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.

-