From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- api/pl.treksoft.kvision.window/-window/index.html | 226 ++++++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 api/pl.treksoft.kvision.window/-window/index.html (limited to 'api/pl.treksoft.kvision.window/-window/index.html') diff --git a/api/pl.treksoft.kvision.window/-window/index.html b/api/pl.treksoft.kvision.window/-window/index.html new file mode 100644 index 00000000..f9c9c6a3 --- /dev/null +++ b/api/pl.treksoft.kvision.window/-window/index.html @@ -0,0 +1,226 @@ + + + +Window - kvision + + + +kvision / pl.treksoft.kvision.window / Window
+
+

Window

+open class Window : SimplePanel +

Floating window container.

Constructors

+ + + + + + + +

<init>

Window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null)

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ caption +	+`var caption: String?` + Window caption text. +
+ closeButton +	+`var closeButton: Boolean` + Determines if Close button is visible. +
+ contentHeight +	+`var contentHeight: CssSize?` + Window content height. +
+ contentOverflow +	+`var contentOverflow: Overflow?` + Window content height. +
+ contentWidth +	+`var contentWidth: CssSize?` + Window content width. +
+ isDraggable +	+`var isDraggable: Boolean` + Determines if the window is draggable. +
+ isResizable +	+`var isResizable: Boolean` + Determines if the window is resizable. +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ 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. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ focus +	+`open fun focus(): Unit` + Makes the current window focused. +
+ 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. +
+ toFront +	+`open fun toFront(): Unit` + Moves the current window to the front. +

Inherited Functions

+ + + + + + + + + + + + + + + +

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

Companion Object Functions

+ + + + + + + +

window

fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window

DSL builder extension function.

+ + -- cgit