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/-init-.html | 2 +- .../-spinner/autofocus.html | 2 +- .../-spinner/blur.html | 3 +- .../-spinner/button-style.html | 2 +- .../-spinner/buttons-type.html | 2 +- .../-spinner/decimals.html | 2 +- .../-spinner/flabel.html | 3 +- .../-spinner/focus.html | 3 +- .../-spinner/force-type.html | 2 +- .../-spinner/get-sn-class.html | 3 +- .../-spinner/get-value-as-string.html | 3 +- .../-spinner/idc.html | 2 +- .../-spinner/index.html | 863 +++++++++------------ .../-spinner/input.html | 3 +- .../-spinner/invalid-feedback.html | 3 +- .../-spinner/label.html | 2 +- .../-spinner/max.html | 2 +- .../-spinner/min.html | 2 +- .../-spinner/placeholder.html | 2 +- .../-spinner/readonly.html | 2 +- .../-spinner/remove-event-listener.html | 3 +- .../-spinner/remove-event-listeners.html | 3 +- .../-spinner/rich.html | 2 +- .../-spinner/set-event-listener.html | 5 +- .../-spinner/spin-down.html | 2 +- .../-spinner/spin-up.html | 2 +- .../-spinner/start-value.html | 2 +- .../-spinner/step.html | 2 +- .../-spinner/style-for-horizontal-form-panel.html | 3 +- .../-spinner/validator-error.html | 3 +- .../-spinner/value.html | 3 +- 31 files changed, 413 insertions(+), 525 deletions(-) (limited to 'api/pl.treksoft.kvision.form.spinner/-spinner') diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html b/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html index 03687ffd..c6791042 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / <init>

<init>

- +(js) Spinner(value: Number? = null, name: String? = 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, label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html b/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html index 1aeba366..d6ac6146 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the spinner is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/blur.html b/api/pl.treksoft.kvision.form.spinner/-spinner/blur.html index 845c6b2d..1532e03e 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/blur.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / blur

blur

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

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/button-style.html b/api/pl.treksoft.kvision.form.spinner/-spinner/button-style.html index 238b671a..9957a298 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/button-style.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/button-style.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / buttonStyle

buttonStyle

- +(js) var buttonStyle: ButtonStyle?

The style of the up/down buttons.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html index 23095f85..431e9233 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/buttons-type.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / buttonsType

buttonsType

- +(js) val buttonsType: ButtonsType

spinner buttons type

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html b/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html index 7a5a1514..969bc123 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/decimals.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / decimals

decimals

- +(js) var decimals: Int

Number of decimal digits value.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html b/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html index 737a1580..7619e7f5 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/focus.html b/api/pl.treksoft.kvision.form.spinner/-spinner/focus.html index 1dd56794..eede59ea 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/focus.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html b/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html index a0e5f702..6dc1d3b1 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/force-type.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / forceType

forceType

- +(js) var forceType: ForceType

Spinner force rounding type.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html b/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html index 08e1ee5d..82b3609b 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / 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/get-value-as-string.html b/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html index 15884cd9..b71350b3 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/get-value-as-string.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / getValueAsString

getValueAsString

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

Overrides NumberFormControl.getValueAsString

Returns the value of the control as a String.

diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html b/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html index db68cb2d..842a60d3 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/idc.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner / idc

idc

- +(js) protected val idc: String diff --git a/api/pl.treksoft.kvision.form.spinner/-spinner/index.html b/api/pl.treksoft.kvision.form.spinner/-spinner/index.html index 044029bb..f9f7c5ca 100644 --- a/api/pl.treksoft.kvision.form.spinner/-spinner/index.html +++ b/api/pl.treksoft.kvision.form.spinner/-spinner/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.spinner / Spinner

Spinner

-open class Spinner : SimplePanel, NumberFormControl +(js) open class Spinner : SimplePanel, NumberFormControl

The form field component for spinner control.

Constructors

@@ -27,184 +28,173 @@ +var autofocus: Boolean? +var buttonStyle: ButtonStyle? +val buttonsType: ButtonsType +var decimals: Int +val flabel: FieldLabel +var forceType: ForceType +val input: SpinnerInput +val invalidFeedback: InvalidFeedback +var label: String? +var max: Number? +var min: Number? +var placeholder: String? +var readonly: Boolean? +var rich: Boolean +var startValue: Number? +var step: Number +open var validatorError: String? - - -
-

<init>

+(js) +

<init>

 Spinner(value: Number? = null, name: String? = 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, label: String? = null, rich: Boolean = false)
-

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.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

forceType

+(js) +

forceType

 -var forceType: ForceType

Spinner force rounding type.

-
-

idc

+(js) +

idc

 val idc: String
-

input

+(js) +

input

 -val input: SpinnerInput

The actual input component.

-
-

invalidFeedback

+(js) +

invalidFeedback

 -val invalidFeedback: InvalidFeedback

Invalid feedback component.

-
-

label

+(js) +

label

 -var label: String?

The label text bound to the spinner input element.

-
-

max

+(js) +

max

 -var max: Number?

Maximal value.

-
-

min

+(js) +

min

 -var min: Number?

Minimal value.

-
-

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.

-
-

rich

+(js) +

rich

 -var rich: Boolean

Determines if label can contain HTML code.

-
-

startValue

+(js) +

startValue

 -var startValue: Number?

The value attribute of the generated HTML input element.

-
-

step

+(js) +

step

 -var step: Number

Step value.

-
-

validatorError

+(js) +

validatorError

 -open var validatorError: String?

Validator error message.

-
-

value

+(js) +

value

 -open var value: Number?

Spinner value.

-
-

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -213,188 +203,93 @@ -

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 -

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

-open fun getValueAsString(): String?

Returns the value of the control as a String.

- +open fun getValueAsString(): String? -

removeEventListener

+(js) +

removeEventListener

-open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

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

removeEventListeners

+(js) +

removeEventListeners

-open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

- +open fun removeEventListeners(): Widget -

setEventListener

+(js) +

setEventListener

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

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

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

spinDown

+(js) +

spinDown

-open fun spinDown(): Spinner

Change value in minus.

- +open fun spinDown(): Spinner -

spinUp

+(js) +

spinUp

-open fun spinUp(): Spinner

Change value in plus.

- +open fun spinUp(): Spinner -

styleForHorizontalFormPanel

+(js) +

styleForHorizontalFormPanel

-open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio): Unit

Style form control element for horizontal form panel.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio): Unit
-

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.

-
@@ -403,24 +298,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 CL