From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- 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 deletions(-) delete mode 100644 api/pl.treksoft.kvision.modal/-alert/-init-.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/align.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/hide.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/rich.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/show.html delete mode 100644 api/pl.treksoft.kvision.modal/-alert/text.html delete mode 100644 api/pl.treksoft.kvision.modal/-close-icon/-init-.html delete mode 100644 api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html delete mode 100644 api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.modal/-close-icon/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-close-icon/render.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/-init-.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/align.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/cancel-title.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/no-title.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/rich.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/show.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/text.html delete mode 100644 api/pl.treksoft.kvision.modal/-confirm/yes-title.html delete mode 100644 api/pl.treksoft.kvision.modal/-dialog/-init-.html delete mode 100644 api/pl.treksoft.kvision.modal/-dialog/get-result.html delete mode 100644 api/pl.treksoft.kvision.modal/-dialog/hide.html delete mode 100644 api/pl.treksoft.kvision.modal/-dialog/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-dialog/set-result.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal-size/-l-a-r-g-e.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal-size/-s-m-a-l-l.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal-size/class-name.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal-size/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/-init-.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/add-all.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/add-button.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/add.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/after-insert.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/animation.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/caption.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/close-button.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/get-children.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/hide.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/index.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-all.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/remove-button.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/remove.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/size.html delete mode 100644 api/pl.treksoft.kvision.modal/-modal/toggle.html delete 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 deleted file mode 100644 index ac6a287a..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -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 deleted file mode 100644 index e3d0bf4d..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/align.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index f165c34f..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/hide.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 4a5a7428..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/index.html +++ /dev/null @@ -1,240 +0,0 @@ - - - -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 deleted file mode 100644 index 68f4b08a..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/rich.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 80c160e4..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/show.html +++ /dev/null @@ -1,30 +0,0 @@ - - - -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 deleted file mode 100644 index 9f6f4e31..00000000 --- a/api/pl.treksoft.kvision.modal/-alert/text.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index eebb8ae3..00000000 --- a/api/pl.treksoft.kvision.modal/-close-icon/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 353a57b1..00000000 --- a/api/pl.treksoft.kvision.modal/-close-icon/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 154efc17..00000000 --- a/api/pl.treksoft.kvision.modal/-close-icon/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 6f0d1ce1..00000000 --- a/api/pl.treksoft.kvision.modal/-close-icon/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - -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 deleted file mode 100644 index 4e0accce..00000000 --- a/api/pl.treksoft.kvision.modal/-close-icon/render.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 7bf6f68f..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/-init-.html +++ /dev/null @@ -1,41 +0,0 @@ - - - -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 deleted file mode 100644 index e74ba605..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/align.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index b010823b..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/cancel-title.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 9260eafa..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/cancel-visible.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index 2d4ecbbb..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - -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 deleted file mode 100644 index 93a01de5..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/no-title.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index bec66a34..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/rich.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index be7a4c93..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/show.html +++ /dev/null @@ -1,34 +0,0 @@ - - - -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 deleted file mode 100644 index 0ed63215..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/text.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 05a653f7..00000000 --- a/api/pl.treksoft.kvision.modal/-confirm/yes-title.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index e7ae6cae..00000000 --- a/api/pl.treksoft.kvision.modal/-dialog/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -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 deleted file mode 100644 index 0c28a36f..00000000 --- a/api/pl.treksoft.kvision.modal/-dialog/get-result.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 1fe643eb..00000000 --- a/api/pl.treksoft.kvision.modal/-dialog/hide.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 0799f65e..00000000 --- a/api/pl.treksoft.kvision.modal/-dialog/index.html +++ /dev/null @@ -1,212 +0,0 @@ - - - -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 deleted file mode 100644 index d7d7f9b4..00000000 --- a/api/pl.treksoft.kvision.modal/-dialog/set-result.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 9884a5ab..00000000 --- a/api/pl.treksoft.kvision.modal/-modal-size/-l-a-r-g-e.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -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 deleted file mode 100644 index 57bee013..00000000 --- a/api/pl.treksoft.kvision.modal/-modal-size/-s-m-a-l-l.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -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 deleted file mode 100644 index 6b78f796..00000000 --- a/api/pl.treksoft.kvision.modal/-modal-size/class-name.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -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 deleted file mode 100644 index 4b88ad07..00000000 --- a/api/pl.treksoft.kvision.modal/-modal-size/index.html +++ /dev/null @@ -1,45 +0,0 @@ - - - -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 deleted file mode 100644 index 0d729ed8..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -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 deleted file mode 100644 index 041fba75..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index e5390b90..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/add-button.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -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 deleted file mode 100644 index 0bc14a86..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index b69374d3..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/after-insert.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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 deleted file mode 100644 index d61b11b7..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/animation.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index cca2f4cc..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/caption.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 4810bdbb..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/close-button.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 52431771..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index e10a5b85..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 150af720..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index 28a61d3f..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/hide.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index ece4c8fb..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/index.html +++ /dev/null @@ -1,253 +0,0 @@ - - - -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 deleted file mode 100644 index f9e101b3..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -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 deleted file mode 100644 index 456f46c8..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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 deleted file mode 100644 index e9264cc4..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/remove-button.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -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 deleted file mode 100644 index d3023386..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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 deleted file mode 100644 index 6b129cb5..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/size.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index a4c26897..00000000 --- a/api/pl.treksoft.kvision.modal/-modal/toggle.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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 deleted file mode 100644 index 1c66e42d..00000000 --- a/api/pl.treksoft.kvision.modal/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - - -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