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 --- .../-check-box/-init-.html | 2 +- .../-check-box/blur.html | 3 +- .../-check-box/circled.html | 2 +- .../-check-box/flabel.html | 3 +- .../-check-box/focus.html | 3 +- .../-check-box/get-sn-class.html | 3 +- .../-check-box/index.html | 821 +++++++++------------ .../-check-box/inline.html | 2 +- .../-check-box/input.html | 3 +- .../-check-box/invalid-feedback.html | 3 +- .../-check-box/label.html | 2 +- .../-check-box/on-click.html | 2 +- .../-check-box/remove-event-listener.html | 3 +- .../-check-box/remove-event-listeners.html | 3 +- .../-check-box/rich.html | 2 +- .../-check-box/set-event-listener.html | 5 +- .../-check-box/start-value.html | 2 +- .../style-for-horizontal-form-panel.html | 3 +- .../-check-box/style-for-inline-form-panel.html | 3 +- .../-check-box/style-for-vertical-form-panel.html | 3 +- .../-check-box/style.html | 2 +- .../-check-box/value.html | 3 +- 22 files changed, 378 insertions(+), 500 deletions(-) (limited to 'api/pl.treksoft.kvision.form.check/-check-box') diff --git a/api/pl.treksoft.kvision.form.check/-check-box/-init-.html b/api/pl.treksoft.kvision.form.check/-check-box/-init-.html index 069d4b71..d61455c5 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/-init-.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / <init>

<init>

- +(js) CheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.check/-check-box/blur.html b/api/pl.treksoft.kvision.form.check/-check-box/blur.html index ac7ab781..4dd70c81 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/blur.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / blur

blur

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

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.check/-check-box/circled.html b/api/pl.treksoft.kvision.form.check/-check-box/circled.html index a62c5c71..04b6f46f 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/circled.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/circled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / circled

circled

- +(js) var circled: Boolean

Determines if the checkbox is rendered as a circle.

Getter
diff --git a/api/pl.treksoft.kvision.form.check/-check-box/flabel.html b/api/pl.treksoft.kvision.form.check/-check-box/flabel.html index 75f0444f..3fa7034c 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/flabel.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.check/-check-box/focus.html b/api/pl.treksoft.kvision.form.check/-check-box/focus.html index 13d5d003..6cf0eaa1 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/focus.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html b/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html index 096322d7..59d8e933 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.check / CheckBox / 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/-check-box/index.html b/api/pl.treksoft.kvision.form.check/-check-box/index.html index d132581a..e8fec3c1 100644 --- a/api/pl.treksoft.kvision.form.check/-check-box/index.html +++ b/api/pl.treksoft.kvision.form.check/-check-box/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.check / CheckBox

CheckBox

-open class CheckBox : SimplePanel, BoolFormControl +(js) open class CheckBox : SimplePanel, BoolFormControl

The form field component rendered as HTML input type="checkbox".

Constructors

@@ -27,105 +28,93 @@ +var circled: Boolean +val flabel: FieldLabel +var inline: Boolean +val input: CheckBoxInput +val invalidFeedback: InvalidFeedback +var label: String? +var rich: Boolean +var startValue: Boolean +var style: CheckBoxStyle? - - -
-

<init>

+(js) +

<init>

 CheckBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false)
-

circled

+(js) +

circled

 -var circled: Boolean

Determines if the checkbox is rendered as a circle.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

inline

+(js) +

inline

 -var inline: Boolean

Determines if the checkbox is rendered inline.

-
-

input

+(js) +

input

 -val input: CheckBoxInput

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

-
-

rich

+(js) +

rich

 -var rich: Boolean

Determines if label can contain HTML code.

-
-

startValue

+(js) +

startValue

 -var startValue: Boolean

The value attribute of the generated HTML input element.

-
-

style

+(js) +

style

 -var style: CheckBoxStyle?

The style (one of Bootstrap standard colors) of the input.

-
-

value

+(js) +

value

 -open var value: Boolean

The selection state of the checkbox.

-
-

Inherited Properties

- - - - - +open var value: Boolean
-

children

-		 -val children: MutableList<Component>
@@ -134,197 +123,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> -

onClick

+(js) +

onClick

-open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox

A convenient helper for easy setting onClick event handler.

- +open fun onClick(handler: CheckBox.(MouseEvent) -> Unit): CheckBox -

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 -

styleForHorizontalFormPanel

+(js) +

styleForHorizontalFormPanel

-open fun styleForHorizontalFormPanel(horizontalRatio: FormHorizontalRatio): Unit

Style form control element for horizontal form panel.

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

styleForInlineFormPanel

+(js) +

styleForInlineFormPanel

-open fun styleForInlineFormPanel(): Unit

Style form control element for inline form panel.

- +open fun styleForInlineFormPanel(): Unit -

styleForVerticalFormPanel

+(js) +

styleForVerticalFormPanel

-open fun styleForVerticalFormPanel(): Unit

Style form control element for vertical form panel.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun styleForVerticalFormPanel(): 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(): Boolean -

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.

-
@@ -333,24 +218,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> @@ -359,867 +247,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,