From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../pl.treksoft.kvision.modal/-alert/-init-.html | 31 +++ .../pl.treksoft.kvision.modal/-alert/align.html | 15 ++ .../api/pl.treksoft.kvision.modal/-alert/hide.html | 18 ++ .../pl.treksoft.kvision.modal/-alert/index.html | 213 +++++++++++++++ .../api/pl.treksoft.kvision.modal/-alert/rich.html | 15 ++ .../api/pl.treksoft.kvision.modal/-alert/show.html | 30 +++ .../api/pl.treksoft.kvision.modal/-alert/text.html | 15 ++ .../-close-icon/-init-.html | 15 ++ .../-close-icon/get-sn-attrs.html | 18 ++ .../-close-icon/get-sn-class.html | 18 ++ .../-close-icon/index.html | 289 +++++++++++++++++++++ .../-close-icon/render.html | 18 ++ .../pl.treksoft.kvision.modal/-confirm/-init-.html | 35 +++ .../pl.treksoft.kvision.modal/-confirm/align.html | 15 ++ .../-confirm/cancel-visible.html | 15 ++ .../pl.treksoft.kvision.modal/-confirm/index.html | 217 ++++++++++++++++ .../pl.treksoft.kvision.modal/-confirm/rich.html | 15 ++ .../pl.treksoft.kvision.modal/-confirm/show.html | 34 +++ .../pl.treksoft.kvision.modal/-confirm/text.html | 15 ++ .../-m-o-d-a-l-s-i-z-e/-l-a-r-g-e.html | 26 ++ .../-m-o-d-a-l-s-i-z-e/-s-m-a-l-l.html | 26 ++ .../-m-o-d-a-l-s-i-z-e/class-name.html | 14 + .../-m-o-d-a-l-s-i-z-e/index.html | 45 ++++ .../pl.treksoft.kvision.modal/-modal/-init-.html | 29 +++ .../pl.treksoft.kvision.modal/-modal/add-all.html | 21 ++ .../-modal/add-button.html | 20 ++ docs/api/pl.treksoft.kvision.modal/-modal/add.html | 21 ++ .../-modal/after-insert.html | 16 ++ .../-modal/animation.html | 15 ++ .../pl.treksoft.kvision.modal/-modal/caption.html | 15 ++ .../-modal/close-button.html | 15 ++ .../-modal/get-sn-attrs.html | 18 ++ .../-modal/get-sn-class.html | 18 ++ .../api/pl.treksoft.kvision.modal/-modal/hide.html | 18 ++ .../pl.treksoft.kvision.modal/-modal/index.html | 244 +++++++++++++++++ .../-modal/remove-all-buttons.html | 17 ++ .../-modal/remove-button.html | 20 ++ .../api/pl.treksoft.kvision.modal/-modal/size.html | 15 ++ .../pl.treksoft.kvision.modal/-modal/toggle.html | 15 ++ docs/api/pl.treksoft.kvision.modal/index.html | 63 +++++ 40 files changed, 1732 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/align.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/hide.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/index.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/rich.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/show.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/text.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-close-icon/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-close-icon/index.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-close-icon/render.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/align.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/index.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/rich.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/show.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-confirm/text.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-l-a-r-g-e.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-s-m-a-l-l.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/class-name.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/index.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add-all.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add-button.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/animation.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/caption.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/close-button.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/hide.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/index.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/size.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/toggle.html create mode 100644 docs/api/pl.treksoft.kvision.modal/index.html (limited to 'docs/api/pl.treksoft.kvision.modal') diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/-init-.html b/docs/api/pl.treksoft.kvision.modal/-alert/-init-.html new file mode 100644 index 00000000..6843304e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/-init-.html @@ -0,0 +1,31 @@ + + + +Alert.<init> - kvision + + + +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) +

Parameters

+

+caption - window title

+

+text - window content text.

+

+rich - determines if text can contain HTML code

+

+align - text align

+

+size - modal window size

+

+animation - determines if animations are used

+

+callback - a function called after closing window with OK button

+

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/align.html b/docs/api/pl.treksoft.kvision.modal/-alert/align.html new file mode 100644 index 00000000..50bfd562 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/align.html @@ -0,0 +1,15 @@ + + + +Alert.align - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / align
+
+

align

+ +var align: ALIGN? +

Text align.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/hide.html b/docs/api/pl.treksoft.kvision.modal/-alert/hide.html new file mode 100644 index 00000000..f165c34f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/hide.html @@ -0,0 +1,18 @@ + + + +Alert.hide - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / hide
+
+

hide

+ +open fun hide(): Widget +

Overrides Modal.hide

+

Makes current widget invisible.

+

Return
+current widget

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/index.html b/docs/api/pl.treksoft.kvision.modal/-alert/index.html new file mode 100644 index 00000000..80b5facf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/index.html @@ -0,0 +1,213 @@ + + + +Alert - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert
+
+

Alert

+open class Alert : Modal +

Alert window based on Bootstrap modal.

+

Constructors

+ + + + + + + +
+

<init>

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

Properties

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

align

+		 +var align: ALIGN? +

Text align.

+
+

rich

+		 +var rich: Boolean +

Determines if text can contain HTML code.

+
+

text

+		 +var text: String? +

Window content text.

+
+

Inherited Properties

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

animation

+		 +var animation: Boolean +

Determines if animations are used.

+
+

caption

+		 +var caption: String? +

Window content text.

+
+

closeButton

+		 +var closeButton: Boolean +

Determines if Close button is visible.

+
+

size

+		 +var size: MODALSIZE? +

Window size.

+
+

Functions

+ + + + + + + +
+

hide

+		 +open fun hide(): Widget +

Makes current widget invisible.

+
+

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

+
+

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.

+
+

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.

+
+

Companion Object Functions

+ + + + + + + +
+

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 +

Helper function for opening Alert window.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/rich.html b/docs/api/pl.treksoft.kvision.modal/-alert/rich.html new file mode 100644 index 00000000..68f4b08a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/rich.html @@ -0,0 +1,15 @@ + + + +Alert.rich - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / rich
+
+

rich

+ +var rich: Boolean +

Determines if text can contain HTML code.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/show.html b/docs/api/pl.treksoft.kvision.modal/-alert/show.html new file mode 100644 index 00000000..3109e8c5 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/show.html @@ -0,0 +1,30 @@ + + + +Alert.show - kvision + + + +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 +

Helper function for opening Alert window.

+

Parameters

+

+caption - window title

+

+text - window content text.

+

+rich - determines if text can contain HTML code

+

+align - text align

+

+size - modal window size

+

+animation - determines if animations are used

+

+callback - a function called after closing window with OK button

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/text.html b/docs/api/pl.treksoft.kvision.modal/-alert/text.html new file mode 100644 index 00000000..9f6f4e31 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/text.html @@ -0,0 +1,15 @@ + + + +Alert.text - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / text
+
+

text

+ +var text: String? +

Window content text.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-close-icon/-init-.html b/docs/api/pl.treksoft.kvision.modal/-close-icon/-init-.html new file mode 100644 index 00000000..eebb8ae3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-close-icon/-init-.html @@ -0,0 +1,15 @@ + + + +CloseIcon.<init> - kvision + + + +kvision / pl.treksoft.kvision.modal / CloseIcon / <init>
+
+

<init>

+ +CloseIcon() +

Helper class for close icon component.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html new file mode 100644 index 00000000..353a57b1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +CloseIcon.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.modal / CloseIcon / 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/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html b/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html new file mode 100644 index 00000000..154efc17 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html @@ -0,0 +1,18 @@ + + + +CloseIcon.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.modal / CloseIcon / 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/docs/api/pl.treksoft.kvision.modal/-close-icon/index.html b/docs/api/pl.treksoft.kvision.modal/-close-icon/index.html new file mode 100644 index 00000000..f94873df --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-close-icon/index.html @@ -0,0 +1,289 @@ + + + +CloseIcon - kvision + + + +kvision / pl.treksoft.kvision.modal / CloseIcon
+
+

CloseIcon

+open class CloseIcon : Widget +

Helper class for close icon component.

+

Constructors

+ + + + + + + +
+

<init>

+		 +CloseIcon() +

Helper class for close icon component.

+
+

Inherited Properties

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

id

+		 +var id: String? +

An ID attribute of generated HTML element.

+
+

parent

+		 +open var parent: Component? +

Parent of the current component.

+
+

role

+		 +var role: String? +

A role attribute of generated HTML element.

+
+

title

+		 +var title: String? +

A title attribute of generated HTML element.

+
+

visible

+		 +open var visible: Boolean +

Visibility state of the current component.

+
+

Functions

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

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.

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

Inherited Functions

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

addCssClass

+		 +open fun addCssClass(css: String): Widget +

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

+
+

addSurroundingCssClass

+		 +open fun addSurroundingCssClass(css: String): Widget +

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

+
+

afterCreate

+		 +open fun afterCreate(node: VNode): Unit +

Method called after creating Snabbdom vnode.

+
+

afterDestroy

+		 +open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+
+

afterInsert

+		 +open fun afterInsert(node: VNode): Unit +

Method called after inserting Snabbdom vnode into the DOM.

+
+

afterPostpatch

+		 +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+
+

getElement

+		 +open fun getElement(): Node? +

Returns DOM element bound to the current component.

+
+

getElementJQuery

+		 +open fun getElementJQuery(): JQuery? +

Returns JQuery element bound to the current component.

+
+

getElementJQueryD

+		 +open fun getElementJQueryD(): dynamic +

Returns JQuery element bound to the current component as a dynamic type.

+
+

getSnHooks

+		 +open fun getSnHooks(): Hooks? +

Returns list of hooks in the form of a Snabbdom Hooks object.

+
+

getSnOn

+		 +open fun getSnOn(): On? +

Returns list of event handlers in the form of a Snabbdom On object.

+
+

hide

+		 +open fun hide(): Widget +

Makes current widget invisible.

+
+

removeCssClass

+		 +open fun removeCssClass(css: String): Widget +

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

+
+

removeEventListeners

+		 +open fun removeEventListeners(): Widget +

Removes all event listeners from current widget.

+
+

removeSurroundingCssClass

+		 +open fun removeSurroundingCssClass(css: String): Widget +

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

+
+

render

+		 +open fun render(elementName: String): VNode
+open fun render(elementName: String, children: Array<dynamic>): VNode +

Renders current component as a Snabbdom vnode.

+
+

setEventListener

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

Sets an event listener for current widget.

+
+

show

+		 +open fun show(): Widget +

Makes current widget visible.

+
+

toggleVisible

+		 +open fun toggleVisible(): Widget +

Toggles visibility of current widget.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-close-icon/render.html b/docs/api/pl.treksoft.kvision.modal/-close-icon/render.html new file mode 100644 index 00000000..4e0accce --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-close-icon/render.html @@ -0,0 +1,18 @@ + + + +CloseIcon.render - kvision + + + +kvision / pl.treksoft.kvision.modal / CloseIcon / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

+

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/-init-.html b/docs/api/pl.treksoft.kvision.modal/-confirm/-init-.html new file mode 100644 index 00000000..2fd377d0 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/-init-.html @@ -0,0 +1,35 @@ + + + +Confirm.<init> - kvision + + + +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, noCallback: () -> Unit = null, yesCallback: () -> Unit = null) +

Parameters

+

+caption - window title

+

+text - window content text.

+

+rich - determines if text can contain HTML code

+

+align - text align

+

+size - modal window size

+

+animation - determines if animations are used

+

+cancelVisible - determines if Cancel button is visible

+

+noCallback - a function called after closing window with No button

+

+yesCallback - a function called after closing window with Yes button

+

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/align.html b/docs/api/pl.treksoft.kvision.modal/-confirm/align.html new file mode 100644 index 00000000..7e8f2ed7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/align.html @@ -0,0 +1,15 @@ + + + +Confirm.align - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / align
+
+

align

+ +var align: ALIGN? +

Text align.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html b/docs/api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html new file mode 100644 index 00000000..ca0f9469 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html @@ -0,0 +1,15 @@ + + + +Confirm.cancelVisible - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / cancelVisible
+
+

cancelVisible

+ +var cancelVisible: Boolean +

Determines if Cancel button is visible.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/index.html b/docs/api/pl.treksoft.kvision.modal/-confirm/index.html new file mode 100644 index 00000000..125a76b4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/index.html @@ -0,0 +1,217 @@ + + + +Confirm - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm
+
+

Confirm

+open class Confirm : Modal +

Confirm window based on Bootstrap modal.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: ALIGN? = null, size: MODALSIZE? = null, animation: Boolean = true, cancelVisible: Boolean = false, noCallback: () -> Unit = null, yesCallback: () -> Unit = null)
+

Properties

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

align

+		 +var align: ALIGN? +

Text align.

+
+

cancelVisible

+		 +var cancelVisible: Boolean +

Determines if Cancel button is visible.

+
+

rich

+		 +var rich: Boolean +

Determines if text can contain HTML code.

+
+

text

+		 +var text: String? +

Window content text.

+
+

Inherited Properties

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

animation

+		 +var animation: Boolean +

Determines if animations are used.

+
+

caption

+		 +var caption: String? +

Window content text.

+
+

closeButton

+		 +var closeButton: Boolean +

Determines if Close button is visible.

+
+

size

+		 +var size: MODALSIZE? +

Window size.

+
+

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

+
+

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.

+
+

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.

+
+

Companion Object Functions

+ + + + + + + +
+

show

+		 +fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: ALIGN? = null, size: MODALSIZE? = null, animation: Boolean = true, cancelVisible: Boolean = false, noCallback: () -> Unit = null, yesCallback: () -> Unit = null): Unit +

Helper function for opening Confirm window.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/rich.html b/docs/api/pl.treksoft.kvision.modal/-confirm/rich.html new file mode 100644 index 00000000..bec66a34 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/rich.html @@ -0,0 +1,15 @@ + + + +Confirm.rich - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / rich
+
+

rich

+ +var rich: Boolean +

Determines if text can contain HTML code.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/show.html b/docs/api/pl.treksoft.kvision.modal/-confirm/show.html new file mode 100644 index 00000000..ff284a12 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/show.html @@ -0,0 +1,34 @@ + + + +Confirm.show - kvision + + + +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, noCallback: () -> Unit = null, yesCallback: () -> Unit = null): Unit +

Helper function for opening Confirm window.

+

Parameters

+

+caption - window title

+

+text - window content text.

+

+rich - determines if text can contain HTML code

+

+align - text align

+

+size - modal window size

+

+animation - determines if animations are used

+

+cancelVisible - determines if Cancel button is visible

+

+noCallback - a function called after closing window with No button

+

+yesCallback - a function called after closing window with Yes button

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-confirm/text.html b/docs/api/pl.treksoft.kvision.modal/-confirm/text.html new file mode 100644 index 00000000..0ed63215 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-confirm/text.html @@ -0,0 +1,15 @@ + + + +Confirm.text - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / text
+
+

text

+ +var text: String? +

Window content text.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-l-a-r-g-e.html b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-l-a-r-g-e.html new file mode 100644 index 00000000..84104d85 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-l-a-r-g-e.html @@ -0,0 +1,26 @@ + + + +MODALSIZE.LARGE - kvision + + + +kvision / pl.treksoft.kvision.modal / MODALSIZE / LARGE
+
+

LARGE

+ +LARGE +

Inherited Properties

+ + + + + + + +
+

className

+		 +val className: String
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-s-m-a-l-l.html b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-s-m-a-l-l.html new file mode 100644 index 00000000..80df8222 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/-s-m-a-l-l.html @@ -0,0 +1,26 @@ + + + +MODALSIZE.SMALL - kvision + + + +kvision / pl.treksoft.kvision.modal / MODALSIZE / SMALL
+
+

SMALL

+ +SMALL +

Inherited Properties

+ + + + + + + +
+

className

+		 +val className: String
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/class-name.html b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/class-name.html new file mode 100644 index 00000000..e9cd91e3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/class-name.html @@ -0,0 +1,14 @@ + + + +MODALSIZE.className - kvision + + + +kvision / pl.treksoft.kvision.modal / MODALSIZE / className
+
+

className

+ +val className: String + + diff --git a/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/index.html b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/index.html new file mode 100644 index 00000000..0cc5703d --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-m-o-d-a-l-s-i-z-e/index.html @@ -0,0 +1,45 @@ + + + +MODALSIZE - kvision + + + +kvision / pl.treksoft.kvision.modal / MODALSIZE
+
+

MODALSIZE

+enum class MODALSIZE +

Modal window sizes.

+

Enum Values

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

LARGE

+		 +
+

SMALL

+		 +
+

Properties

+ + + + + + + +
+

className

+		 +val className: String
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html b/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html new file mode 100644 index 00000000..f94051b7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html @@ -0,0 +1,29 @@ + + + +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()) +

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

+

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/add-all.html b/docs/api/pl.treksoft.kvision.modal/-modal/add-all.html new file mode 100644 index 00000000..041fba75 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/add-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/add-button.html new file mode 100644 index 00000000..e5390b90 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/add.html b/docs/api/pl.treksoft.kvision.modal/-modal/add.html new file mode 100644 index 00000000..0bc14a86 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html b/docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html new file mode 100644 index 00000000..b69374d3 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/animation.html b/docs/api/pl.treksoft.kvision.modal/-modal/animation.html new file mode 100644 index 00000000..adb207fc --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/animation.html @@ -0,0 +1,15 @@ + + + +Modal.animation - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / animation
+
+

animation

+ +var animation: Boolean +

Determines if animations are used.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/caption.html b/docs/api/pl.treksoft.kvision.modal/-modal/caption.html new file mode 100644 index 00000000..33afaf3d --- /dev/null +++ b/docs/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 content text.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/close-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/close-button.html new file mode 100644 index 00000000..4810bdbb --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html new file mode 100644 index 00000000..e10a5b85 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html new file mode 100644 index 00000000..150af720 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/hide.html b/docs/api/pl.treksoft.kvision.modal/-modal/hide.html new file mode 100644 index 00000000..28a61d3f --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/index.html b/docs/api/pl.treksoft.kvision.modal/-modal/index.html new file mode 100644 index 00000000..0d7d0798 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/index.html @@ -0,0 +1,244 @@ + + + +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())
+

Properties

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

animation

+		 +var animation: Boolean +

Determines if animations are used.

+
+

caption

+		 +var caption: String? +

Window content 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.

+
+

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.

+
+

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.

+
+

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.

+
+

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.

+
+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html new file mode 100644 index 00000000..f9e101b3 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html new file mode 100644 index 00000000..e9264cc4 --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/size.html b/docs/api/pl.treksoft.kvision.modal/-modal/size.html new file mode 100644 index 00000000..d357c3dc --- /dev/null +++ b/docs/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/docs/api/pl.treksoft.kvision.modal/-modal/toggle.html b/docs/api/pl.treksoft.kvision.modal/-modal/toggle.html new file mode 100644 index 00000000..a4c26897 --- /dev/null +++ b/docs/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.

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/index.html b/docs/api/pl.treksoft.kvision.modal/index.html new file mode 100644 index 00000000..ba17ced7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/index.html @@ -0,0 +1,63 @@ + + + +pl.treksoft.kvision.modal - kvision + + + +kvision / pl.treksoft.kvision.modal
+
+

Package pl.treksoft.kvision.modal

+

Classes supporting general purpose Bootstrap modals with convenient helpers for alert and confirm popup dialogs.

+

Types

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

Alert

+		 +open class Alert : Modal +

Alert window based on Bootstrap modal.

+
+

CloseIcon

+		 +open class CloseIcon : Widget +

Helper class for close icon component.

+
+

Confirm

+		 +open class Confirm : Modal +

Confirm window based on Bootstrap modal.

+
+

MODALSIZE

+		 +enum class MODALSIZE +

Modal window sizes.

+
+

Modal

+		 +open class Modal : SimplePanel +

Configurable modal window based on Bootstrap modal.

+
+ + -- cgit