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/-alert/-init-.html | 31 ++ api/pl.treksoft.kvision.modal/-alert/align.html | 15 + api/pl.treksoft.kvision.modal/-alert/hide.html | 18 + api/pl.treksoft.kvision.modal/-alert/index.html | 240 +++++++++++++ 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 | 379 +++++++++++++++++++++ .../-close-icon/render.html | 18 + api/pl.treksoft.kvision.modal/-confirm/-init-.html | 41 +++ api/pl.treksoft.kvision.modal/-confirm/align.html | 15 + .../-confirm/cancel-title.html | 15 + .../-confirm/cancel-visible.html | 21 ++ api/pl.treksoft.kvision.modal/-confirm/index.html | 271 +++++++++++++++ .../-confirm/no-title.html | 15 + api/pl.treksoft.kvision.modal/-confirm/rich.html | 15 + api/pl.treksoft.kvision.modal/-confirm/show.html | 34 ++ api/pl.treksoft.kvision.modal/-confirm/text.html | 15 + .../-confirm/yes-title.html | 15 + api/pl.treksoft.kvision.modal/-dialog/-init-.html | 31 ++ .../-dialog/get-result.html | 15 + api/pl.treksoft.kvision.modal/-dialog/hide.html | 18 + api/pl.treksoft.kvision.modal/-dialog/index.html | 212 ++++++++++++ .../-dialog/set-result.html | 15 + .../-modal-size/-l-a-r-g-e.html | 26 ++ .../-modal-size/-s-m-a-l-l.html | 26 ++ .../-modal-size/class-name.html | 14 + .../-modal-size/index.html | 45 +++ 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 + api/pl.treksoft.kvision.modal/index.html | 72 ++++ 51 files changed, 2334 insertions(+) create mode 100644 api/pl.treksoft.kvision.modal/-alert/-init-.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/align.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/hide.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/index.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/rich.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/show.html create mode 100644 api/pl.treksoft.kvision.modal/-alert/text.html create mode 100644 api/pl.treksoft.kvision.modal/-close-icon/-init-.html create mode 100644 api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.modal/-close-icon/index.html create mode 100644 api/pl.treksoft.kvision.modal/-close-icon/render.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/-init-.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/align.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/cancel-title.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/index.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/no-title.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/rich.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/show.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/text.html create mode 100644 api/pl.treksoft.kvision.modal/-confirm/yes-title.html create mode 100644 api/pl.treksoft.kvision.modal/-dialog/-init-.html create mode 100644 api/pl.treksoft.kvision.modal/-dialog/get-result.html create mode 100644 api/pl.treksoft.kvision.modal/-dialog/hide.html create mode 100644 api/pl.treksoft.kvision.modal/-dialog/index.html create mode 100644 api/pl.treksoft.kvision.modal/-dialog/set-result.html create mode 100644 api/pl.treksoft.kvision.modal/-modal-size/-l-a-r-g-e.html create mode 100644 api/pl.treksoft.kvision.modal/-modal-size/-s-m-a-l-l.html create mode 100644 api/pl.treksoft.kvision.modal/-modal-size/class-name.html create mode 100644 api/pl.treksoft.kvision.modal/-modal-size/index.html 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 create mode 100644 api/pl.treksoft.kvision.modal/index.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 new file mode 100644 index 00000000..ac6a287a --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-alert/align.html b/api/pl.treksoft.kvision.modal/-alert/align.html new file mode 100644 index 00000000..e3d0bf4d --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-alert/hide.html b/api/pl.treksoft.kvision.modal/-alert/hide.html new file mode 100644 index 00000000..f165c34f --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-alert/index.html b/api/pl.treksoft.kvision.modal/-alert/index.html new file mode 100644 index 00000000..4a5a7428 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-alert/index.html @@ -0,0 +1,240 @@ + + + +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 caption 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.

+
+

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.

+
+

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.

+
+

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/api/pl.treksoft.kvision.modal/-alert/rich.html b/api/pl.treksoft.kvision.modal/-alert/rich.html new file mode 100644 index 00000000..68f4b08a --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-alert/show.html b/api/pl.treksoft.kvision.modal/-alert/show.html new file mode 100644 index 00000000..80c160e4 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-alert/text.html b/api/pl.treksoft.kvision.modal/-alert/text.html new file mode 100644 index 00000000..9f6f4e31 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-close-icon/-init-.html b/api/pl.treksoft.kvision.modal/-close-icon/-init-.html new file mode 100644 index 00000000..eebb8ae3 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html b/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html new file mode 100644 index 00000000..353a57b1 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html b/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html new file mode 100644 index 00000000..154efc17 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-close-icon/index.html b/api/pl.treksoft.kvision.modal/-close-icon/index.html new file mode 100644 index 00000000..6f0d1ce1 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-close-icon/index.html @@ -0,0 +1,379 @@ + + + +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

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

draggable

+		 +var draggable: Boolean? +

Determines if the current widget is draggable.

+
+

eventTarget

+		 +var eventTarget: Widget?
+

id

+		 +var id: String? +

An ID attribute of generated HTML element.

+
+

lastLanguage

+		 +var lastLanguage: String?
+

parent

+		 +open var parent: Container? +

Parent of the current component.

+
+

role

+		 +var role: String? +

A role attribute of generated HTML element.

+
+

surroundingSpan

+		 +var surroundingSpan: Boolean
+

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.

+
+

clearDragDropData

+		 +open fun clearDragDropData(): Unit +

Clears D&D data for the current widget. It also makes it not draggable.

+
+

dispatchEvent

+		 +open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
+

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.

+
+

setContextMenu

+		 +open fun setContextMenu(contextMenu: ContextMenu): Widget +

Sets context menu for the current widget.

+
+

setDragDropData

+		 +open fun setDragDropData(format: String, data: String): Unit +

Sets D&D data for the current widget. It also makes it draggable.

+
+

setDropTarget

+		 +open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
+open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit +

Sets the current widget as a D&D drop target.

+
+

setDropTargetData

+		 +open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit +

Sets the current widget as a D&D drop target with helper callback accepting String data.

+
+

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.

+
+

translate

+		 +fun translate(text: String?): String?
+ + diff --git a/api/pl.treksoft.kvision.modal/-close-icon/render.html b/api/pl.treksoft.kvision.modal/-close-icon/render.html new file mode 100644 index 00000000..4e0accce --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-confirm/-init-.html b/api/pl.treksoft.kvision.modal/-confirm/-init-.html new file mode 100644 index 00000000..7bf6f68f --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-confirm/-init-.html @@ -0,0 +1,41 @@ + + + +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, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", 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

+

+yesTitle - yes button text

+

+noTitle - no button text

+

+cancelTitle - cancel button text

+

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

+

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

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.modal/-confirm/align.html b/api/pl.treksoft.kvision.modal/-confirm/align.html new file mode 100644 index 00000000..e74ba605 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-confirm/cancel-title.html b/api/pl.treksoft.kvision.modal/-confirm/cancel-title.html new file mode 100644 index 00000000..b010823b --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-confirm/cancel-title.html @@ -0,0 +1,15 @@ + + + +Confirm.cancelTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / cancelTitle
+
+

cancelTitle

+ +var cancelTitle: String +

Cancel button text.

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

cancelVisible

+ +var cancelVisible: Boolean +

Determines if Cancel button is visible.

+

Getter
+

Determines if Cancel button is visible.

+

+

Setter
+

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 new file mode 100644 index 00000000..2d4ecbbb --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-confirm/index.html @@ -0,0 +1,271 @@ + + + +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, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> Unit = null)
+

Properties

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

align

+		 +var align: Align? +

Text align.

+
+

cancelTitle

+		 +var cancelTitle: String +

Cancel button text.

+
+

cancelVisible

+		 +var cancelVisible: Boolean +

Determines if Cancel button is visible.

+
+

noTitle

+		 +var noTitle: String +

No button text.

+
+

rich

+		 +var rich: Boolean +

Determines if text can contain HTML code.

+
+

text

+		 +var text: String? +

Window content text.

+
+

yesTitle

+		 +var yesTitle: String +

Yes button text.

+
+

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

+
+

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.

+
+

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.

+
+

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, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> Unit = null): Unit +

Helper function for opening Confirm window.

+
+ + diff --git a/api/pl.treksoft.kvision.modal/-confirm/no-title.html b/api/pl.treksoft.kvision.modal/-confirm/no-title.html new file mode 100644 index 00000000..93a01de5 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-confirm/no-title.html @@ -0,0 +1,15 @@ + + + +Confirm.noTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / noTitle
+
+

noTitle

+ +var noTitle: String +

No button text.

+ + diff --git a/api/pl.treksoft.kvision.modal/-confirm/rich.html b/api/pl.treksoft.kvision.modal/-confirm/rich.html new file mode 100644 index 00000000..bec66a34 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-confirm/show.html b/api/pl.treksoft.kvision.modal/-confirm/show.html new file mode 100644 index 00000000..be7a4c93 --- /dev/null +++ b/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, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", 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/api/pl.treksoft.kvision.modal/-confirm/text.html b/api/pl.treksoft.kvision.modal/-confirm/text.html new file mode 100644 index 00000000..0ed63215 --- /dev/null +++ b/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/api/pl.treksoft.kvision.modal/-confirm/yes-title.html b/api/pl.treksoft.kvision.modal/-confirm/yes-title.html new file mode 100644 index 00000000..05a653f7 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-confirm/yes-title.html @@ -0,0 +1,15 @@ + + + +Confirm.yesTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / yesTitle
+
+

yesTitle

+ +var yesTitle: String +

Yes button text.

+ + diff --git a/api/pl.treksoft.kvision.modal/-dialog/-init-.html b/api/pl.treksoft.kvision.modal/-dialog/-init-.html new file mode 100644 index 00000000..e7ae6cae --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-dialog/-init-.html @@ -0,0 +1,31 @@ + + + +Dialog.<init> - kvision + + + +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) +

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/-dialog/get-result.html b/api/pl.treksoft.kvision.modal/-dialog/get-result.html new file mode 100644 index 00000000..0c28a36f --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-dialog/get-result.html @@ -0,0 +1,15 @@ + + + +Dialog.getResult - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / getResult
+
+

getResult

+ +suspend fun getResult(): R? +

A suspending function returning result value.

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

hide

+ +open fun hide(): Widget +

Overrides Modal.hide

+

Makes current widget invisible.

+

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.modal/-dialog/index.html b/api/pl.treksoft.kvision.modal/-dialog/index.html new file mode 100644 index 00000000..0799f65e --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-dialog/index.html @@ -0,0 +1,212 @@ + + + +Dialog - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog
+
+

Dialog

+open class Dialog<R> : Modal +

Modal window with a result.

+

Constructors

+ + + + + + + +
+

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

Inherited 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

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

getResult

+		 +suspend fun getResult(): R? +

A suspending function returning result value.

+
+

hide

+		 +open fun hide(): Widget +

Makes current widget invisible.

+
+

setResult

+		 +open fun setResult(result: R?): Unit +

A function to be called with a result value.

+
+

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.

+
+

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.

+
+

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.

+
+ + diff --git a/api/pl.treksoft.kvision.modal/-dialog/set-result.html b/api/pl.treksoft.kvision.modal/-dialog/set-result.html new file mode 100644 index 00000000..d7d7f9b4 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-dialog/set-result.html @@ -0,0 +1,15 @@ + + + +Dialog.setResult - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / setResult
+
+

setResult

+ +open fun setResult(result: R?): Unit +

A function to be called with a result value.

+ + diff --git a/api/pl.treksoft.kvision.modal/-modal-size/-l-a-r-g-e.html b/api/pl.treksoft.kvision.modal/-modal-size/-l-a-r-g-e.html new file mode 100644 index 00000000..9884a5ab --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal-size/-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/api/pl.treksoft.kvision.modal/-modal-size/-s-m-a-l-l.html b/api/pl.treksoft.kvision.modal/-modal-size/-s-m-a-l-l.html new file mode 100644 index 00000000..57bee013 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal-size/-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/api/pl.treksoft.kvision.modal/-modal-size/class-name.html b/api/pl.treksoft.kvision.modal/-modal-size/class-name.html new file mode 100644 index 00000000..6b78f796 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal-size/class-name.html @@ -0,0 +1,14 @@ + + + +ModalSize.className - kvision + + + +kvision / pl.treksoft.kvision.modal / ModalSize / className
+
+

className

+ +val className: String + + diff --git a/api/pl.treksoft.kvision.modal/-modal-size/index.html b/api/pl.treksoft.kvision.modal/-modal-size/index.html new file mode 100644 index 00000000..4b88ad07 --- /dev/null +++ b/api/pl.treksoft.kvision.modal/-modal-size/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/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.

+ + diff --git a/api/pl.treksoft.kvision.modal/index.html b/api/pl.treksoft.kvision.modal/index.html new file mode 100644 index 00000000..1c66e42d --- /dev/null +++ b/api/pl.treksoft.kvision.modal/index.html @@ -0,0 +1,72 @@ + + + +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.

+
+

Dialog

+		 +open class Dialog<R> : Modal +

Modal window with a result.

+
+

Modal

+		 +open class Modal : SimplePanel +

Configurable modal window based on Bootstrap modal.

+
+

ModalSize

+		 +enum class ModalSize +

Modal window sizes.

+
+ + -- cgit