From 9d35bb1e3d8186228cc409faa6d681624f20e9cd Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 26 Nov 2019 19:53:45 +0100 Subject: API documentation for KVision 2.4.0 --- api/pl.treksoft.kvision.modal/-alert/-init-.html | 6 ++- api/pl.treksoft.kvision.modal/-alert/index.html | 22 +++++++++-- api/pl.treksoft.kvision.modal/-alert/show.html | 8 ++-- .../-close-icon/index.html | 45 +++++++++++++++++++--- api/pl.treksoft.kvision.modal/-confirm/-init-.html | 6 ++- api/pl.treksoft.kvision.modal/-confirm/index.html | 22 +++++++++-- api/pl.treksoft.kvision.modal/-confirm/show.html | 8 ++-- api/pl.treksoft.kvision.modal/-dialog/-init-.html | 6 ++- api/pl.treksoft.kvision.modal/-dialog/index.html | 20 +++++++++- api/pl.treksoft.kvision.modal/-modal/-init-.html | 6 ++- api/pl.treksoft.kvision.modal/-modal/centered.html | 15 ++++++++ api/pl.treksoft.kvision.modal/-modal/index.html | 20 +++++++++- 12 files changed, 155 insertions(+), 29 deletions(-) create mode 100644 api/pl.treksoft.kvision.modal/-modal/centered.html (limited to 'api/pl.treksoft.kvision.modal') diff --git a/api/pl.treksoft.kvision.modal/-alert/-init-.html b/api/pl.treksoft.kvision.modal/-alert/-init-.html index feb24c49..896da509 100644 --- a/api/pl.treksoft.kvision.modal/-alert/-init-.html +++ b/api/pl.treksoft.kvision.modal/-alert/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Alert / <init>

<init>

- -Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: (() -> Unit)? = null) + +Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, callback: (() -> Unit)? = null)

Parameters

caption - window title

@@ -23,6 +23,8 @@ size - modal window size

animation - determines if animations are used

+

+centered - determines if modal dialog is vertically centered

callback - a function called after closing window with OK button

Constructor
diff --git a/api/pl.treksoft.kvision.modal/-alert/index.html b/api/pl.treksoft.kvision.modal/-alert/index.html index f7aaf4fc..1d5758f6 100644 --- a/api/pl.treksoft.kvision.modal/-alert/index.html +++ b/api/pl.treksoft.kvision.modal/-alert/index.html @@ -18,7 +18,7 @@

<init>

-Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: (() -> Unit)? = null) +Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, callback: (() -> Unit)? = null) @@ -77,6 +77,15 @@ +

centered

+ + +var centered: Boolean +

Determines if modal dialog is vertically centered.

+ + + +

closeButton

@@ -242,7 +251,7 @@

show

-fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: (() -> Unit)? = null): Unit +fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, callback: (() -> Unit)? = null): Unit

Helper function for opening Alert window.

@@ -596,6 +605,13 @@ +

onEvent

+ + +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget + + +

p

@@ -910,7 +926,7 @@

tabulatorRemote

-fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E> +fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: (() -> String)? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E>

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.modal/-alert/show.html b/api/pl.treksoft.kvision.modal/-alert/show.html index 71d10bc4..1c21cc29 100644 --- a/api/pl.treksoft.kvision.modal/-alert/show.html +++ b/api/pl.treksoft.kvision.modal/-alert/show.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Alert / show

show

- -fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: (() -> Unit)? = null): Unit + +fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, callback: (() -> Unit)? = null): Unit

Helper function for opening Alert window.

Parameters

@@ -17,13 +17,15 @@

text - window content text.

-rich - determines if text can contain HTML code

+rich - determines if text can contain HTML code

align - text align

size - modal window size

animation - determines if animations are used

+

+centered - determines if modal dialog is vertically centered

callback - a function called after closing window with OK button

diff --git a/api/pl.treksoft.kvision.modal/-close-icon/index.html b/api/pl.treksoft.kvision.modal/-close-icon/index.html index 2ddb2283..b5c79d5a 100644 --- a/api/pl.treksoft.kvision.modal/-close-icon/index.html +++ b/api/pl.treksoft.kvision.modal/-close-icon/index.html @@ -176,7 +176,14 @@ open fun addCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of current component.

-open fun addCssClass(css: Style): Widget + + + + +

addCssStyle

+ + +open fun addCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of current component.

@@ -187,7 +194,14 @@ open fun addSurroundingCssClass(css: String): Widget

Adds given value to the set of CSS classes generated in html code of parent component.

-open fun addSurroundingCssClass(css: Style): Widget + + + + +

addSurroundingCssStyle

+ + +open fun addSurroundingCssStyle(css: Style): Widget

Adds given style object to the set of CSS classes generated in html code of parent component.

@@ -375,7 +389,14 @@ open fun removeCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of current component.

-open fun removeCssClass(css: Style): Widget + + + + +

removeCssStyle

+ + +open fun removeCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of current component.

@@ -395,7 +416,14 @@ open fun removeSurroundingCssClass(css: String): Widget

Removes given value from the set of CSS classes generated in html code of parent component.

-open fun removeSurroundingCssClass(css: Style): Widget + + + + +

removeSurroundingCssStyle

+ + +open fun removeSurroundingCssStyle(css: Style): Widget

Removes given style object from the set of CSS classes generated in html code of parent component.

@@ -453,7 +481,7 @@ open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget

Sets an event listener for current widget, keeping the actual type of component.

-open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget

Sets an event listener for current widget.

@@ -567,6 +595,13 @@ +

onEvent

+ + +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget + + +

removeBsBgColor

diff --git a/api/pl.treksoft.kvision.modal/-confirm/-init-.html b/api/pl.treksoft.kvision.modal/-confirm/-init-.html index 49837a02..53febe44 100644 --- a/api/pl.treksoft.kvision.modal/-confirm/-init-.html +++ b/api/pl.treksoft.kvision.modal/-confirm/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Confirm / <init>

<init>

- -Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null) + +Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null)

Parameters

caption - window title

@@ -23,6 +23,8 @@ size - modal window size

animation - determines if animations are used

+

+centered - determines if modal dialog is vertically centered

cancelVisible - determines if Cancel button is visible

diff --git a/api/pl.treksoft.kvision.modal/-confirm/index.html b/api/pl.treksoft.kvision.modal/-confirm/index.html index 4e95190f..0fd7b89a 100644 --- a/api/pl.treksoft.kvision.modal/-confirm/index.html +++ b/api/pl.treksoft.kvision.modal/-confirm/index.html @@ -18,7 +18,7 @@

<init>

-Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null) +Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null) @@ -113,6 +113,15 @@ +

centered

+ + +var centered: Boolean +

Determines if modal dialog is vertically centered.

+ + + +

closeButton

@@ -273,7 +282,7 @@

show

-fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null): Unit +fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null): Unit

Helper function for opening Confirm window.

@@ -627,6 +636,13 @@ +

onEvent

+ + +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget + + +

p

@@ -941,7 +957,7 @@

tabulatorRemote

-fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E> +fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: (() -> String)? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E>

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.modal/-confirm/show.html b/api/pl.treksoft.kvision.modal/-confirm/show.html index 06d6398a..bffbfd24 100644 --- a/api/pl.treksoft.kvision.modal/-confirm/show.html +++ b/api/pl.treksoft.kvision.modal/-confirm/show.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Confirm / show

show

- -fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null): Unit + +fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: (() -> Unit)? = null, yesCallback: (() -> Unit)? = null): Unit

Helper function for opening Confirm window.

Parameters

@@ -17,13 +17,15 @@

text - window content text.

-rich - determines if text can contain HTML code

+rich - determines if text can contain HTML code

align - text align

size - modal window size

animation - determines if animations are used

+

+centered - determines if modal dialog is vertically centered

cancelVisible - determines if Cancel button is visible

diff --git a/api/pl.treksoft.kvision.modal/-dialog/-init-.html b/api/pl.treksoft.kvision.modal/-dialog/-init-.html index 102868ea..15d17565 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/-init-.html +++ b/api/pl.treksoft.kvision.modal/-dialog/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Dialog / <init>

<init>

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

Parameters

caption - window title

@@ -21,6 +21,8 @@ animation - determines if animations are used

escape - determines if dialog can be closed with Esc key

+

+centered - determines if modal dialog is vertically centered

classes - a set of CSS class names

diff --git a/api/pl.treksoft.kvision.modal/-dialog/index.html b/api/pl.treksoft.kvision.modal/-dialog/index.html index 8da96d12..fdd60110 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/index.html +++ b/api/pl.treksoft.kvision.modal/-dialog/index.html @@ -18,7 +18,7 @@

<init>

-Dialog(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: (Dialog<R>.() -> Unit)? = null) +Dialog(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, escape: Boolean = true, classes: Set<String> = setOf(), init: (Dialog<R>.() -> Unit)? = null) @@ -45,6 +45,15 @@ +

centered

+ + +var centered: Boolean +

Determines if modal dialog is vertically centered.

+ + + +

closeButton

@@ -568,6 +577,13 @@ +

onEvent

+ + +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget + + +

p

@@ -882,7 +898,7 @@

tabulatorRemote

-fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E> +fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: (() -> String)? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E>

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.modal/-modal/-init-.html b/api/pl.treksoft.kvision.modal/-modal/-init-.html index cf58d374..3485a723 100644 --- a/api/pl.treksoft.kvision.modal/-modal/-init-.html +++ b/api/pl.treksoft.kvision.modal/-modal/-init-.html @@ -8,8 +8,8 @@ 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) + +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

caption - window title

@@ -19,6 +19,8 @@ size - modal window size

animation - determines if animations are used

+

+centered - determines if modal dialog is vertically centered

escape - determines if dialog can be closed with Esc key

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

centered

+ +var centered: Boolean +

Determines if modal dialog is vertically centered.

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal/index.html b/api/pl.treksoft.kvision.modal/-modal/index.html index f2dec82e..477778ed 100644 --- a/api/pl.treksoft.kvision.modal/-modal/index.html +++ b/api/pl.treksoft.kvision.modal/-modal/index.html @@ -18,7 +18,7 @@

<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) +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) @@ -45,6 +45,15 @@ +

centered

+ + +var centered: Boolean +

Determines if modal dialog is vertically centered.

+ + + +

closeButton

@@ -589,6 +598,13 @@ +

onEvent

+ + +fun <T : Widget> T.onEvent(block: SnOn<T>.() -> Unit): Widget + + +

p

@@ -903,7 +919,7 @@

tabulatorRemote

-fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E> +fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?, String?) -> <ERROR CLASS><T>, stateFunction: (() -> String)? = null, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E>

DSL builder extension function.

-- cgit