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.panel/-root/-init-.html | 6 +- .../-root/add-context-menu.html | 2 +- api/pl.treksoft.kvision.panel/-root/get-root.html | 2 +- .../-root/get-sn-class.html | 3 +- api/pl.treksoft.kvision.panel/-root/index.html | 688 +++++++++------------ .../-root/is-first-root.html | 2 +- api/pl.treksoft.kvision.panel/-root/render.html | 3 +- 7 files changed, 317 insertions(+), 389 deletions(-) (limited to 'api/pl.treksoft.kvision.panel/-root') diff --git a/api/pl.treksoft.kvision.panel/-root/-init-.html b/api/pl.treksoft.kvision.panel/-root/-init-.html index 4369a710..a5b9d61f 100644 --- a/api/pl.treksoft.kvision.panel/-root/-init-.html +++ b/api/pl.treksoft.kvision.panel/-root/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / Root / <init>

<init>

- +(js) Root(id: String, fixed: Boolean = false, init: (Root.() -> Unit)? = null)

Parameters

@@ -20,8 +20,8 @@ otherwise it's rendered with "container" class (default is false)

init - an initializer extension function

Constructor

- -Root(element: <ERROR CLASS>, fixed: Boolean = false, init: (Root.() -> Unit)? = null) +(js) +Root(element: HTMLElement, fixed: Boolean = false, init: (Root.() -> Unit)? = null)

Parameters

element - HTML element in the DOM tree

diff --git a/api/pl.treksoft.kvision.panel/-root/add-context-menu.html b/api/pl.treksoft.kvision.panel/-root/add-context-menu.html index 16ba6af6..9e2d0ac7 100644 --- a/api/pl.treksoft.kvision.panel/-root/add-context-menu.html +++ b/api/pl.treksoft.kvision.panel/-root/add-context-menu.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / Root / addContextMenu

addContextMenu

- +(js) fun addContextMenu(contextMenu: Widget): Unit diff --git a/api/pl.treksoft.kvision.panel/-root/get-root.html b/api/pl.treksoft.kvision.panel/-root/get-root.html index 9667c2dd..9c0be2c2 100644 --- a/api/pl.treksoft.kvision.panel/-root/get-root.html +++ b/api/pl.treksoft.kvision.panel/-root/get-root.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / Root / getRoot

getRoot

- +(js) fun getRoot(): Root? diff --git a/api/pl.treksoft.kvision.panel/-root/get-sn-class.html b/api/pl.treksoft.kvision.panel/-root/get-sn-class.html index ba9cf8eb..f3731336 100644 --- a/api/pl.treksoft.kvision.panel/-root/get-sn-class.html +++ b/api/pl.treksoft.kvision.panel/-root/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.panel / Root / getSnClass

getSnClass

- +(js) protected 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.panel/-root/index.html b/api/pl.treksoft.kvision.panel/-root/index.html index 0e9497b2..d2043be3 100644 --- a/api/pl.treksoft.kvision.panel/-root/index.html +++ b/api/pl.treksoft.kvision.panel/-root/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.panel / Root

Root

-class Root : SimplePanel +(js) class Root : SimplePanel

Root container.

This container is bound to the specific element in the main HTML file of the project. It is always the root of components tree and it is responsible for rendering and updating @@ -18,11 +18,12 @@ Snabbdom virtual DOM.

-

<init>

+(js) +

<init>

Root(id: String, fixed: Boolean = false, init: (Root.() -> Unit)? = null)
-Root(element: <ERROR CLASS>, fixed: Boolean = false, init: (Root.() -> Unit)? = null) +Root(element: HTMLElement, fixed: Boolean = false, init: (Root.() -> Unit)? = null) @@ -31,127 +32,50 @@ Snabbdom virtual DOM.

-

isFirstRoot

+(js) +

isFirstRoot

val isFirstRoot: Boolean -

Inherited Properties

- - - - - - - -
-

children

-		 -val children: MutableList<Component>

Functions

+fun getSnClass(): List<StringBoolPair> - - -
-

addContextMenu

+(js) +

addContextMenu

 fun addContextMenu(contextMenu: Widget): Unit
-

getRoot

+(js) +

getRoot

 fun getRoot(): Root?
-

getSnClass

+(js) +

getSnClass

 -fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

-
-

render

+(js) +

render

 -fun render(): VNode

Renders current component as a Snabbdom vnode.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - +fun render(): VNode
-

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.

-
-

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.

-
@@ -160,24 +84,27 @@ Snabbdom virtual DOM.

-

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> @@ -186,867 +113,870 @@ Snabbdom virtual DOM.

-

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(), init: (Button.() -> Unit)? = null): Button -

buttonGroup

+(js) +

buttonGroup

-fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup

DSL builder extension function.

- +fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup -

canvas

+(js) +

canvas

-fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas

DSL builder extension function.

- +fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas -

chart

+(js) +

chart

-fun Container.chart(configuration: