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 --- .../-radio-group/-init-.html | 2 +- .../-radio-group/blur.html | 3 +- .../-radio-group/disabled.html | 3 +- .../-radio-group/flabel.html | 3 +- .../-radio-group/focus.html | 3 +- .../-radio-group/get-sn-class.html | 3 +- .../-radio-group/index.html | 803 +++++++++------------ .../-radio-group/inline.html | 2 +- .../-radio-group/input.html | 3 +- .../-radio-group/invalid-feedback.html | 3 +- .../-radio-group/label.html | 2 +- .../-radio-group/name.html | 3 +- .../-radio-group/options.html | 2 +- .../-radio-group/rich.html | 2 +- .../-radio-group/size.html | 3 +- .../style-for-horizontal-form-panel.html | 3 +- .../-radio-group/validation-status.html | 3 +- .../-radio-group/validator-error.html | 3 +- .../-radio-group/value.html | 3 +- 19 files changed, 365 insertions(+), 487 deletions(-) (limited to 'api/pl.treksoft.kvision.form.check/-radio-group') diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html b/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html index ab46a0c9..38ba9fe5 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / <init>

<init>

- +(js) RadioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/blur.html b/api/pl.treksoft.kvision.form.check/-radio-group/blur.html index 82a46729..e6f4dbaf 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/blur.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / blur

blur

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

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html b/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html index 67fd5054..732149ea 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / disabled

disabled

- +(js) open var disabled: Boolean -

Overrides FormControl.disabled

Determines if the field is disabled.

diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/flabel.html b/api/pl.treksoft.kvision.form.check/-radio-group/flabel.html index de73bfaa..80e0ede5 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/flabel.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/focus.html b/api/pl.treksoft.kvision.form.check/-radio-group/focus.html index aa54efb1..021e9c11 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/focus.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html index 45f2e97a..7482481c 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup / 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.check/-radio-group/index.html b/api/pl.treksoft.kvision.form.check/-radio-group/index.html index aaff40c7..e6b3f1c3 100644 --- a/api/pl.treksoft.kvision.form.check/-radio-group/index.html +++ b/api/pl.treksoft.kvision.form.check/-radio-group/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.check / RadioGroup

RadioGroup

-open class RadioGroup : SimplePanel, StringFormControl +(js) open class RadioGroup : SimplePanel, StringFormControl

The form field component rendered as a group of HTML input type="radio" elements with the same name attribute.

The radio group can be populated directly from options parameter or manually by adding Radio components to the container.

@@ -17,7 +17,8 @@ -

<init>

+(js) +

<init>

RadioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false) @@ -29,132 +30,120 @@ -

disabled

+(js) +

disabled

-open var disabled: Boolean

Determines if the field is disabled.

- +open var disabled: Boolean -

flabel

+(js) +

flabel

-val flabel: FieldLabel

Form field label.

- +val flabel: FieldLabel -

inline

+(js) +

inline

-var inline: Boolean

Determines if the options are rendered inline.

- +var inline: Boolean -

input

+(js) +

input

-val input: RadioInput

The actual input component.

- +val input: RadioInput -

invalidFeedback

+(js) +

invalidFeedback

-val invalidFeedback: InvalidFeedback

Invalid feedback component.

- +val invalidFeedback: InvalidFeedback -

label

+(js) +

label

-var label: String?

The label text of the options group.

- +var label: String? -

name

+(js) +

name

-open var name: String?

The name attribute of the generated HTML input element.

- +open var name: String? -

options

+(js) +

options

-var options: List<StringPair>?

A list of options (label to value pairs) for the group.

- +var options: List<StringPair>? -

rich

+(js) +

rich

-var rich: Boolean

Determines if label can contain HTML code.

- +var rich: Boolean -

size

+(js) +

size

-open var size: InputSize?

Input control field size.

- +open var size: InputSize? -

validationStatus

+(js) +

validationStatus

-open var validationStatus: ValidationStatus?

Input control validation status.

- +open var validationStatus: ValidationStatus? -

validatorError

+(js) +

validatorError

-open var validatorError: String?

Validator error message.

- +open var validatorError: String? -

value

+(js) +

value

-open var value: String?

A value of the selected option.

- - - - -

Inherited Properties

- - - - - +open var value: String?
-

children

-		 -val children: MutableList<Component>
@@ -163,143 +152,39 @@ -

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> -

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

Returns the value of the control.

-
-

getValueAsString

-		 -open fun getValueAsString(): String? -

Returns the value of the control as a String.

-
-

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.

-
@@ -308,24 +193,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> @@ -334,867 +222,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, disabled: Boolean = false, classes: Set<String> = setOf(),