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/-init-.html | 2 +- .../-range/autofocus.html | 2 +- .../-range/blur.html | 3 +- .../-range/flabel.html | 3 +- .../-range/focus.html | 3 +- .../-range/get-sn-class.html | 3 +- .../-range/get-value-as-string.html | 3 +- api/pl.treksoft.kvision.form.range/-range/idc.html | 2 +- .../-range/index.html | 833 +++++++++------------ .../-range/input.html | 3 +- .../-range/invalid-feedback.html | 3 +- .../-range/label.html | 2 +- api/pl.treksoft.kvision.form.range/-range/max.html | 2 +- api/pl.treksoft.kvision.form.range/-range/min.html | 2 +- .../-range/readonly.html | 2 +- .../-range/remove-event-listener.html | 3 +- .../-range/remove-event-listeners.html | 3 +- .../-range/rich.html | 2 +- .../-range/set-event-listener.html | 5 +- .../-range/start-value.html | 2 +- .../-range/step-down.html | 2 +- .../-range/step-up.html | 2 +- .../-range/step.html | 2 +- .../-range/style-for-horizontal-form-panel.html | 3 +- .../-range/validator-error.html | 3 +- .../-range/value.html | 3 +- 26 files changed, 393 insertions(+), 505 deletions(-) (limited to 'api/pl.treksoft.kvision.form.range/-range') diff --git a/api/pl.treksoft.kvision.form.range/-range/-init-.html b/api/pl.treksoft.kvision.form.range/-range/-init-.html index 6a050b70..8738e064 100644 --- a/api/pl.treksoft.kvision.form.range/-range/-init-.html +++ b/api/pl.treksoft.kvision.form.range/-range/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / Range / <init>

<init>

- +(js) Range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.range/-range/autofocus.html b/api/pl.treksoft.kvision.form.range/-range/autofocus.html index 0ae50ac0..2e92126d 100644 --- a/api/pl.treksoft.kvision.form.range/-range/autofocus.html +++ b/api/pl.treksoft.kvision.form.range/-range/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / Range / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the text input is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.range/-range/blur.html b/api/pl.treksoft.kvision.form.range/-range/blur.html index 0ef45ca5..0931fedb 100644 --- a/api/pl.treksoft.kvision.form.range/-range/blur.html +++ b/api/pl.treksoft.kvision.form.range/-range/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / Range / blur

blur

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

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.range/-range/flabel.html b/api/pl.treksoft.kvision.form.range/-range/flabel.html index a5a20b3b..64e0df60 100644 --- a/api/pl.treksoft.kvision.form.range/-range/flabel.html +++ b/api/pl.treksoft.kvision.form.range/-range/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / Range / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.range/-range/focus.html b/api/pl.treksoft.kvision.form.range/-range/focus.html index 53ac1757..c333e6e6 100644 --- a/api/pl.treksoft.kvision.form.range/-range/focus.html +++ b/api/pl.treksoft.kvision.form.range/-range/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / Range / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html b/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html index b259af93..cc00ed67 100644 --- a/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.range/-range/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / Range / 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/get-value-as-string.html b/api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html index dfd83f25..0c75bd1b 100644 --- a/api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.range/-range/get-value-as-string.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.range / Range / 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.range/-range/idc.html b/api/pl.treksoft.kvision.form.range/-range/idc.html index 1b83c3c2..33bdb7e9 100644 --- a/api/pl.treksoft.kvision.form.range/-range/idc.html +++ b/api/pl.treksoft.kvision.form.range/-range/idc.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.range / Range / idc

idc

- +(js) protected val idc: String diff --git a/api/pl.treksoft.kvision.form.range/-range/index.html b/api/pl.treksoft.kvision.form.range/-range/index.html index 79375b40..c8673328 100644 --- a/api/pl.treksoft.kvision.form.range/-range/index.html +++ b/api/pl.treksoft.kvision.form.range/-range/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.range / Range

Range

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

The form field component for range input control.

Constructors

@@ -27,139 +28,128 @@ +var autofocus: Boolean? +val flabel: FieldLabel +val input: RangeInput +val invalidFeedback: InvalidFeedback +var label: String? +var max: Number +var min: Number +var readonly: Boolean? +var rich: Boolean +var startValue: Number? +var step: Number +open var validatorError: String? - - -
-

<init>

+(js) +

<init>

 Range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = DEFAULT_STEP, label: String? = null, rich: Boolean = false)
-

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the text input is automatically focused.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

idc

+(js) +

idc

 val idc: String
-

input

+(js) +

input

 -val input: RangeInput

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 range input element.

-
-

max

+(js) +

max

 -var max: Number

Maximal value.

-
-

min

+(js) +

min

 -var min: Number

Minimal value.

-
-

readonly

+(js) +

readonly

 -var readonly: Boolean?

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

Range input value.

-
-

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -168,188 +158,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 -

stepDown

+(js) +

stepDown

-open fun stepDown(): Range

Change value in minus.

- +open fun stepDown(): Range -

stepUp

+(js) +

stepUp

-open fun stepUp(): Range

Change value in plus.

- +open fun stepUp(): Range -

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.

-
@@ -358,24 +253,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> @@ -384,867 +282,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: