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 --- api/pl.treksoft.kvision.modal/-modal/-init-.html | 2 +- api/pl.treksoft.kvision.modal/-modal/add-all.html | 3 +- .../-modal/add-button.html | 2 +- api/pl.treksoft.kvision.modal/-modal/add.html | 3 +- .../-modal/after-insert.html | 3 +- .../-modal/animation.html | 2 +- api/pl.treksoft.kvision.modal/-modal/caption.html | 2 +- api/pl.treksoft.kvision.modal/-modal/centered.html | 2 +- .../-modal/clear-parent.html | 2 +- .../-modal/close-button.html | 2 +- .../-modal/get-children.html | 3 +- api/pl.treksoft.kvision.modal/-modal/get-root.html | 2 +- .../-modal/get-sn-class.html | 3 +- api/pl.treksoft.kvision.modal/-modal/hide.html | 3 +- api/pl.treksoft.kvision.modal/-modal/index.html | 758 ++++++++++----------- api/pl.treksoft.kvision.modal/-modal/parent.html | 4 +- .../-modal/remove-all-buttons.html | 2 +- .../-modal/remove-all.html | 3 +- .../-modal/remove-button.html | 2 +- api/pl.treksoft.kvision.modal/-modal/remove.html | 3 +- api/pl.treksoft.kvision.modal/-modal/size.html | 2 +- api/pl.treksoft.kvision.modal/-modal/toggle.html | 2 +- 22 files changed, 383 insertions(+), 427 deletions(-) (limited to 'api/pl.treksoft.kvision.modal/-modal') diff --git a/api/pl.treksoft.kvision.modal/-modal/-init-.html b/api/pl.treksoft.kvision.modal/-modal/-init-.html index 3485a723..d3726b46 100644 --- a/api/pl.treksoft.kvision.modal/-modal/-init-.html +++ b/api/pl.treksoft.kvision.modal/-modal/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / <init>

<init>

- +(js) Modal(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, escape: Boolean = true, classes: Set<String> = setOf(), init: (Modal.() -> Unit)? = null)

Parameters

diff --git a/api/pl.treksoft.kvision.modal/-modal/add-all.html b/api/pl.treksoft.kvision.modal/-modal/add-all.html index 041fba75..e59b0980 100644 --- a/api/pl.treksoft.kvision.modal/-modal/add-all.html +++ b/api/pl.treksoft.kvision.modal/-modal/add-all.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / addAll

addAll

- +(js) open fun addAll(children: List<Component>): SimplePanel -

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.modal/-modal/add-button.html b/api/pl.treksoft.kvision.modal/-modal/add-button.html index e5390b90..2245678e 100644 --- a/api/pl.treksoft.kvision.modal/-modal/add-button.html +++ b/api/pl.treksoft.kvision.modal/-modal/add-button.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / addButton

addButton

- +(js) open fun addButton(button: Button): Modal

Adds given button to the bottom section of dialog window.

Parameters

diff --git a/api/pl.treksoft.kvision.modal/-modal/add.html b/api/pl.treksoft.kvision.modal/-modal/add.html index 0bc14a86..1ddebdfc 100644 --- a/api/pl.treksoft.kvision.modal/-modal/add.html +++ b/api/pl.treksoft.kvision.modal/-modal/add.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / add

add

- +(js) open fun add(child: Component): SimplePanel -

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

diff --git a/api/pl.treksoft.kvision.modal/-modal/after-insert.html b/api/pl.treksoft.kvision.modal/-modal/after-insert.html index b69374d3..9bd6fd94 100644 --- a/api/pl.treksoft.kvision.modal/-modal/after-insert.html +++ b/api/pl.treksoft.kvision.modal/-modal/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / afterInsert

afterInsert

- +(js) protected open fun afterInsert(node: VNode): Unit -

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

diff --git a/api/pl.treksoft.kvision.modal/-modal/animation.html b/api/pl.treksoft.kvision.modal/-modal/animation.html index d61b11b7..b33b90fa 100644 --- a/api/pl.treksoft.kvision.modal/-modal/animation.html +++ b/api/pl.treksoft.kvision.modal/-modal/animation.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / animation

animation

- +(js) var animation: Boolean

Determines if animations are used.

Getter
diff --git a/api/pl.treksoft.kvision.modal/-modal/caption.html b/api/pl.treksoft.kvision.modal/-modal/caption.html index cca2f4cc..260a3075 100644 --- a/api/pl.treksoft.kvision.modal/-modal/caption.html +++ b/api/pl.treksoft.kvision.modal/-modal/caption.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / caption

caption

- +(js) var caption: String?

Window caption text.

diff --git a/api/pl.treksoft.kvision.modal/-modal/centered.html b/api/pl.treksoft.kvision.modal/-modal/centered.html index 5eda65c7..a2ce121d 100644 --- a/api/pl.treksoft.kvision.modal/-modal/centered.html +++ b/api/pl.treksoft.kvision.modal/-modal/centered.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / centered

centered

- +(js) var centered: Boolean

Determines if modal dialog is vertically centered.

diff --git a/api/pl.treksoft.kvision.modal/-modal/clear-parent.html b/api/pl.treksoft.kvision.modal/-modal/clear-parent.html index 9c0873ae..53fb76c5 100644 --- a/api/pl.treksoft.kvision.modal/-modal/clear-parent.html +++ b/api/pl.treksoft.kvision.modal/-modal/clear-parent.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / clearParent

clearParent

- +(js) open fun clearParent(): Widget diff --git a/api/pl.treksoft.kvision.modal/-modal/close-button.html b/api/pl.treksoft.kvision.modal/-modal/close-button.html index 4810bdbb..ff263b83 100644 --- a/api/pl.treksoft.kvision.modal/-modal/close-button.html +++ b/api/pl.treksoft.kvision.modal/-modal/close-button.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / closeButton

closeButton

- +(js) var closeButton: Boolean

Determines if Close button is visible.

diff --git a/api/pl.treksoft.kvision.modal/-modal/get-children.html b/api/pl.treksoft.kvision.modal/-modal/get-children.html index 52431771..3f4ff63b 100644 --- a/api/pl.treksoft.kvision.modal/-modal/get-children.html +++ b/api/pl.treksoft.kvision.modal/-modal/get-children.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / getChildren

getChildren

- +(js) open fun getChildren(): List<Component> -

Overrides SimplePanel.getChildren

Returns a list of children of the current container.

Return
list of children

diff --git a/api/pl.treksoft.kvision.modal/-modal/get-root.html b/api/pl.treksoft.kvision.modal/-modal/get-root.html index d87baefc..b4d3140b 100644 --- a/api/pl.treksoft.kvision.modal/-modal/get-root.html +++ b/api/pl.treksoft.kvision.modal/-modal/get-root.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.modal / Modal / getRoot

getRoot

- +(js) open fun getRoot(): Root? diff --git a/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html b/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html index 150af720..5a17ba89 100644 --- a/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html +++ b/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/hide.html b/api/pl.treksoft.kvision.modal/-modal/hide.html index 28a61d3f..2f1700c7 100644 --- a/api/pl.treksoft.kvision.modal/-modal/hide.html +++ b/api/pl.treksoft.kvision.modal/-modal/hide.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / hide

hide

- +(js) open fun hide(): Widget -

Overrides Widget.hide

Makes current widget invisible.

Return
current widget

diff --git a/api/pl.treksoft.kvision.modal/-modal/index.html b/api/pl.treksoft.kvision.modal/-modal/index.html index 2dc7a02f..c8069ed4 100644 --- a/api/pl.treksoft.kvision.modal/-modal/index.html +++ b/api/pl.treksoft.kvision.modal/-modal/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.modal / Modal

Modal

-open class Modal : SimplePanel +(js) open class Modal : SimplePanel

Configurable modal window based on Bootstrap modal.

Constructors

@@ -27,67 +28,56 @@ +var animation: Boolean +var caption: String? +var centered: Boolean +var closeButton: Boolean - - -
-

<init>

+(js) +

<init>

 Modal(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, escape: Boolean = true, classes: Set<String> = setOf(), init: (Modal.() -> Unit)? = null)
-

animation

+(js) +

animation

 -var animation: Boolean

Determines if animations are used.

-
-

caption

+(js) +

caption

 -var caption: String?

Window caption text.

-
-

centered

+(js) +

centered

 -var centered: Boolean

Determines if modal dialog is vertically centered.

-
-

closeButton

+(js) +

closeButton

 -var closeButton: Boolean

Determines if Close button is visible.

-
-

parent

+(js) +

parent

 open var parent: Container?
-

size

+(js) +

size

 -var size: ModalSize?

Window size.

-
-

Inherited Properties

- - - - - +var size: ModalSize?
-

children

-		 -val children: MutableList<Component>
@@ -96,157 +86,127 @@ -

add

+(js) +

add

-open fun add(child: Component): SimplePanel

Adds given component to the current container.

- +open fun add(child: Component): SimplePanel -

addAll

+(js) +

addAll

-open fun addAll(children: List<Component>): SimplePanel

Adds a list of components to the current container.

- +open fun addAll(children: List<Component>): SimplePanel -

addButton

+(js) +

addButton

-open fun addButton(button: Button): Modal

Adds given button to the bottom section of dialog window.

- +open fun addButton(button: Button): Modal -

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

- +open fun afterInsert(node: VNode): Unit -

clearParent

+(js) +

clearParent

open fun clearParent(): Widget -

getChildren

+(js) +

getChildren

-open fun getChildren(): List<Component>

Returns a list of children of the current container.

- +open fun getChildren(): List<Component> -

getRoot

+(js) +

getRoot

open fun getRoot(): Root? -

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

hide

+(js) +

hide

-open fun hide(): Widget

Makes current widget invisible.

- +open fun hide(): Widget -

remove

+(js) +

remove

-open fun remove(child: Component): SimplePanel

Removes given component from the current container.

- +open fun remove(child: Component): SimplePanel -

removeAll

+(js) +

removeAll

-open fun removeAll(): SimplePanel

Removes all children from the current container.

- +open fun removeAll(): SimplePanel -

removeAllButtons

+(js) +

removeAllButtons

-open fun removeAllButtons(): Modal

Removes all buttons from the bottom section of dialog window.

- +open fun removeAllButtons(): Modal -

removeButton

+(js) +

removeButton

-open fun removeButton(button: Button): Modal

Removes given button from the bottom section of dialog window.

- +open fun removeButton(button: Button): Modal -

toggle

+(js) +

toggle

-open fun toggle(): Unit

Toggle modal window visibility.

- - - - -

Inherited Functions

- - - - - - - - - - - - - +open fun toggle(): Unit
-

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.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
@@ -255,24 +215,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> @@ -281,867 +244,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