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/index.html | 863 +++++++++------------ 1 file changed, 382 insertions(+), 481 deletions(-) (limited to 'api/pl.treksoft.kvision.form.spinner/-spinner/index.html') 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 CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -429,867 +327,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

bold

+(js) +

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.

- +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold -

button

+(js) +

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.

- +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON