From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../pl.treksoft.kvision.modal/-modal/index.html | 253 +++++++++++++++++++++ 1 file changed, 253 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.modal/-modal/index.html (limited to 'api/kvision/pl.treksoft.kvision.modal/-modal/index.html') diff --git a/api/kvision/pl.treksoft.kvision.modal/-modal/index.html b/api/kvision/pl.treksoft.kvision.modal/-modal/index.html new file mode 100644 index 00000000..ece4c8fb --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-modal/index.html @@ -0,0 +1,253 @@ + + + +Modal - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal
+
+

Modal

+open class Modal : SimplePanel +

Configurable modal window based on Bootstrap modal.

Constructors

+ + + + + + + +

<init>

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

Properties

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

+ animation +	+`var animation: Boolean` + Determines if animations are used. +
+ caption +	+`var caption: String?` + Window caption text. +
+ closeButton +	+`var closeButton: Boolean` + Determines if Close button is visible. +
+ size +	+`var size: ModalSize?` + Window size. +

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. +
+ addButton +	+`open fun addButton(button: Button): Modal` + Adds given button to the bottom section of dialog window. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ 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. +
+ removeAllButtons +	+`open fun removeAllButtons(): Modal` + Removes all buttons from the bottom section of dialog window. +
+ removeButton +	+`open fun removeButton(button: Button): Modal` + Removes given button from the bottom section of dialog window. +
+ toggle +	+`open fun toggle(): Unit` + Toggle modal window visibility. +

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

Inheritors

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

+ Alert +	+`open class Alert : Modal` + Alert window based on Bootstrap modal. +
+ Confirm +	+`open class Confirm : Modal` + Confirm window based on Bootstrap modal. +
+ Dialog +	+`open class Dialog<R> : Modal` + Modal window with a result. +

+ + -- cgit