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.modal/-modal/-init-.html | 31 +++ api/pl.treksoft.kvision.modal/-modal/add-all.html | 21 ++ .../-modal/add-button.html | 20 ++ api/pl.treksoft.kvision.modal/-modal/add.html | 21 ++ .../-modal/after-insert.html | 16 ++ .../-modal/animation.html | 21 ++ api/pl.treksoft.kvision.modal/-modal/caption.html | 15 ++ .../-modal/close-button.html | 15 ++ .../-modal/get-children.html | 18 ++ .../-modal/get-sn-attrs.html | 18 ++ .../-modal/get-sn-class.html | 18 ++ api/pl.treksoft.kvision.modal/-modal/hide.html | 18 ++ api/pl.treksoft.kvision.modal/-modal/index.html | 253 +++++++++++++++++++++ .../-modal/remove-all-buttons.html | 17 ++ .../-modal/remove-all.html | 18 ++ .../-modal/remove-button.html | 20 ++ api/pl.treksoft.kvision.modal/-modal/remove.html | 21 ++ api/pl.treksoft.kvision.modal/-modal/size.html | 15 ++ api/pl.treksoft.kvision.modal/-modal/toggle.html | 15 ++ 19 files changed, 591 insertions(+) create mode 100644 api/pl.treksoft.kvision.modal/-modal/-init-.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/add-all.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/add-button.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/add.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/after-insert.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/animation.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/caption.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/close-button.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/get-children.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/hide.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/index.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-all.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-button.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/remove.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/size.html create mode 100644 api/pl.treksoft.kvision.modal/-modal/toggle.html (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 new file mode 100644 index 00000000..0d729ed8 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/-init-.html @@ -0,0 +1,31 @@ + + + +Modal.<init> - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / <init>
+
+

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

Parameters

+caption - window title

+closeButton - determines if Close button is visible

+size - modal window size

+animation - determines if animations are used

+escape - determines if dialog can be closed with Esc key

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/add-all.html b/api/pl.treksoft.kvision.modal/-modal/add-all.html new file mode 100644 index 00000000..041fba75 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/add-all.html @@ -0,0 +1,21 @@ + + + +Modal.addAll - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / addAll
+
+

addAll

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

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/add-button.html b/api/pl.treksoft.kvision.modal/-modal/add-button.html new file mode 100644 index 00000000..e5390b90 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/add-button.html @@ -0,0 +1,20 @@ + + + +Modal.addButton - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / addButton
+
+

addButton

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

Adds given button to the bottom section of dialog window.

Parameters

+button - a Button component

Return
+this modal

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/add.html b/api/pl.treksoft.kvision.modal/-modal/add.html new file mode 100644 index 00000000..0bc14a86 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/add.html @@ -0,0 +1,21 @@ + + + +Modal.add - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / add
+
+

add

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

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/after-insert.html b/api/pl.treksoft.kvision.modal/-modal/after-insert.html new file mode 100644 index 00000000..b69374d3 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/after-insert.html @@ -0,0 +1,16 @@ + + + +Modal.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / afterInsert
+
+

afterInsert

+ +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 new file mode 100644 index 00000000..d61b11b7 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/animation.html @@ -0,0 +1,21 @@ + + + +Modal.animation - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / animation
+
+

animation

+ +var animation: Boolean +

Determines if animations are used.

Getter
+

Determines if animations are used.

Setter
+

Determines if animations are used.

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/caption.html b/api/pl.treksoft.kvision.modal/-modal/caption.html new file mode 100644 index 00000000..cca2f4cc --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/caption.html @@ -0,0 +1,15 @@ + + + +Modal.caption - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / caption
+
+

caption

+ +var caption: String? +

Window caption text.

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/close-button.html b/api/pl.treksoft.kvision.modal/-modal/close-button.html new file mode 100644 index 00000000..4810bdbb --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/close-button.html @@ -0,0 +1,15 @@ + + + +Modal.closeButton - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / closeButton
+
+

closeButton

+ +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 new file mode 100644 index 00000000..52431771 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/get-children.html @@ -0,0 +1,18 @@ + + + +Modal.getChildren - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / getChildren
+
+

getChildren

+ +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-sn-attrs.html b/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html new file mode 100644 index 00000000..e10a5b85 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +Modal.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
+list of element attributes

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html b/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html new file mode 100644 index 00000000..150af720 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Modal.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / getSnClass
+
+

getSnClass

+ +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 new file mode 100644 index 00000000..28a61d3f --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/hide.html @@ -0,0 +1,18 @@ + + + +Modal.hide - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / hide
+
+

hide

+ +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 new file mode 100644 index 00000000..ece4c8fb --- /dev/null +++ b/api/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. +

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html b/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html new file mode 100644 index 00000000..f9e101b3 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html @@ -0,0 +1,17 @@ + + + +Modal.removeAllButtons - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / removeAllButtons
+
+

removeAllButtons

+ +open fun removeAllButtons(): Modal +

Removes all buttons from the bottom section of dialog window.

Return
+this modal

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/remove-all.html b/api/pl.treksoft.kvision.modal/-modal/remove-all.html new file mode 100644 index 00000000..456f46c8 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/remove-all.html @@ -0,0 +1,18 @@ + + + +Modal.removeAll - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/remove-button.html b/api/pl.treksoft.kvision.modal/-modal/remove-button.html new file mode 100644 index 00000000..e9264cc4 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/remove-button.html @@ -0,0 +1,20 @@ + + + +Modal.removeButton - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / removeButton
+
+

removeButton

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

Removes given button from the bottom section of dialog window.

Parameters

+button - a Button component

Return
+this modal

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/remove.html b/api/pl.treksoft.kvision.modal/-modal/remove.html new file mode 100644 index 00000000..d3023386 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/remove.html @@ -0,0 +1,21 @@ + + + +Modal.remove - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / remove
+
+

remove

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

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/size.html b/api/pl.treksoft.kvision.modal/-modal/size.html new file mode 100644 index 00000000..6b129cb5 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/size.html @@ -0,0 +1,15 @@ + + + +Modal.size - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / size
+
+

size

+ +var size: ModalSize? +

Window size.

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/toggle.html b/api/pl.treksoft.kvision.modal/-modal/toggle.html new file mode 100644 index 00000000..a4c26897 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal/toggle.html @@ -0,0 +1,15 @@ + + + +Modal.toggle - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / toggle
+
+

toggle

+ +open fun toggle(): Unit +

Toggle modal window visibility.

+ + -- cgit