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 --- .../-spinner-input/-init-.html | 2 +- .../-spinner-input/after-destroy.html | 3 +- .../-spinner-input/after-insert.html | 3 +- .../-spinner-input/autofocus.html | 2 +- .../-spinner-input/blur.html | 3 +- .../-spinner-input/button-style.html | 2 +- .../-spinner-input/buttons-type.html | 2 +- .../-spinner-input/change-value.html | 2 +- .../-spinner-input/decimals.html | 2 +- .../-spinner-input/disabled.html | 3 +- .../-spinner-input/focus.html | 3 +- .../-spinner-input/force-type.html | 2 +- .../-spinner-input/get-sn-attrs.html | 3 +- .../-spinner-input/get-sn-class.html | 3 +- .../-spinner-input/get-value-as-string.html | 2 +- .../-spinner-input/index.html | 716 ++++----------------- .../-spinner-input/max.html | 2 +- .../-spinner-input/min.html | 2 +- .../-spinner-input/name.html | 3 +- .../-spinner-input/placeholder.html | 2 +- .../-spinner-input/readonly.html | 2 +- .../-spinner-input/render.html | 3 +- .../-spinner-input/size.html | 3 +- .../-spinner-input/spin-down.html | 2 +- .../-spinner-input/spin-up.html | 2 +- .../-spinner-input/start-value.html | 2 +- .../-spinner-input/step.html | 2 +- .../-spinner-input/validation-status.html | 3 +- .../-spinner-input/value.html | 2 +- 29 files changed, 155 insertions(+), 628 deletions(-) (limited to 'api/pl.treksoft.kvision.form.spinner/-spinner-input') diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html index 55321e0c..c9efd68e 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / <init>

<init>

- +(js) SpinnerInput(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, classes: Set<String> = setOf())

Parameters

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html index c3eee4ed..99b5b15a 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-destroy.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / afterDestroy

afterDestroy

- +(js) protected open fun afterDestroy(): Unit -

Overrides Widget.afterDestroy

Method called after destroying Snabbdom vnode.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html index 433c0858..e9c33ee3 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/autofocus.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html index 4a8fb474..c3f27d42 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the spinner is automatically focused.

Getter
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html index 968da695..03ec06df 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / blur

blur

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

Overrides FormInput.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html index 60dcae96..57851b7c 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/button-style.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / buttonStyle

buttonStyle

- +(js) var buttonStyle: ButtonStyle?

The style of the up/down buttons.

Getter
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html index 237f5317..621eff82 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/buttons-type.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / buttonsType

buttonsType

- +(js) val buttonsType: ButtonsType

spinner buttons type

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html index 9c778406..20004edd 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/change-value.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / changeValue

changeValue

- +(js) protected open fun changeValue(): Unit diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html index 635e27b7..38a1810f 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/decimals.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / decimals

decimals

- +(js) var decimals: Int

Number of decimal digits value.

Getter
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html index e77813f8..4eaf0df4 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/focus.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html index 954eb486..f48e2840 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / focus

focus

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

Overrides FormInput.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html index 047f35cb..8de42179 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/force-type.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / forceType

forceType

- +(js) var forceType: ForceType

Spinner force rounding type.

Getter
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html index 7cc57aff..ecf93c8d 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-attrs.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/get-sn-class.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html index a16c4e8e..aec24033 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / 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.spinner/-spinner-input/get-value-as-string.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html index 7dbe23c7..e09e5206 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/get-value-as-string.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput / getValueAsString

getValueAsString

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

Returns the value of the spinner as a String.

Return
diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html index 454d1e7c..45faf8d3 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner-input/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.spinner / SpinnerInput

SpinnerInput

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

The basic component for spinner control.

Constructors

@@ -27,257 +28,147 @@ +var autofocus: Boolean? +var buttonStyle: ButtonStyle? +val buttonsType: ButtonsType +var decimals: Int +open var disabled: Boolean +var forceType: ForceType +var max: Number? +var min: Number? +open var name: String? +var placeholder: String? +var readonly: Boolean? +open var size: InputSize? +var startValue: Number? +var step: Number +open var validationStatus: ValidationStatus? - - -
-

<init>

+(js) +

<init>

 SpinnerInput(value: Number? = null, min: Number? = null, max: Number? = null, step: Number = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, classes: Set<String> = setOf())
-

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the spinner is automatically focused.

-
-

buttonStyle

+(js) +

buttonStyle

 -var buttonStyle: ButtonStyle?

The style of the up/down buttons.

-
-

buttonsType

+(js) +

buttonsType

 -val buttonsType: ButtonsType

spinner buttons type

-
-

decimals

+(js) +

decimals

 -var decimals: Int

Number of decimal digits value.

-
-

disabled

+(js) +

disabled

 -open var disabled: Boolean

Determines if the field is disabled.

-
-

forceType

+(js) +

forceType

 -var forceType: ForceType

Spinner force rounding type.

-
-

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.

-
-

placeholder

+(js) +

placeholder

 -var placeholder: String?

The placeholder for the spinner input.

-
-

readonly

+(js) +

readonly

 -var readonly: Boolean?

Determines if the spinner 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?

Spinner 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?
@@ -286,460 +177,101 @@ -

afterDestroy

+(js) +

afterDestroy

-open fun afterDestroy(): Unit

Method called after destroying Snabbdom vnode.

- +open fun afterDestroy(): Unit -

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 -

changeValue

+(js) +

changeValue

open fun changeValue(): 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 -

spinDown

+(js) +

spinDown

-fun spinDown(): SpinnerInput

Change value in minus.

- +fun spinDown(): SpinnerInput -

spinUp

+(js) +

spinUp

-fun spinUp(): SpinnerInput

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.

-
-

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():