kvision-bootstrap/io.kvision.modal/Dialog

Dialog

open class Dialog<R>(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, scrollable: Boolean = false, escape: Boolean = true, className: String? = null, init: Dialog<R>.() -> Unit? = null) : Modal

Modal window with a result.

Parameters

caption

window title

closeButton

determines if Close button is visible

size

modal window size

animation

determines if animations are used

centered

determines if modal dialog is vertically centered

scrollable

determines if modal dialog content is scrollable

escape

determines if dialog can be closed with Esc key

className

CSS class names

init

an initializer extension function

Constructors

constructor(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, centered: Boolean = false, scrollable: Boolean = false, escape: Boolean = true, className: String? = null, init: Dialog<R>.() -> Unit? = null)

Properties

var animation: <Error class: unknown class>

Determines if animations are used.

var caption: <Error class: unknown class>

Window caption text.

var centered: <Error class: unknown class>

Determines if modal dialog is vertically centered.

var closeButton: <Error class: unknown class>

Determines if Close button is visible.

val footer: <Error class: unknown class>

The modal dialog footer component.

val header: <Error class: unknown class>

The modal dialog header component.

open var parent: <Error class: unknown class>?

var scrollable: <Error class: unknown class>

Determines if modal body is scrollable.

var size: <Error class: unknown class>

Window size.

Functions

open fun add(child: <Error class: unknown class>)

open fun add(position: Int, child: <Error class: unknown class>)

open fun addAll(children: List<<Error class: unknown class>>)

open fun addButton(button: <Error class: unknown class>)

Adds given button to the bottom section of dialog window.

open fun afterInsert(node: <Error class: unknown class>)

open fun buildClassSet(classSetBuilder: <Error class: unknown class>)

open fun clearParent()

open fun dispose()

open fun disposeAll()

open fun getChildren(): List<<Error class: unknown class>>

suspend fun getResult(): R?

A suspending function returning result value.

open fun getRoot(): <Error class: unknown class>?

open override fun hide()

fun hideBootstrap()

Hide modal window with Bootstrap function.

open fun remove(child: <Error class: unknown class>)

open fun removeAll()

removeAllButtons

open fun removeAllButtons()

Removes all buttons from the bottom section of dialog window.

open fun removeAt(position: Int)

open fun removeButton(button: <Error class: unknown class>)

Removes given button from the bottom section of dialog window.

open fun setResult(result: R?)

A function to be called with a result value.

fun showBootstrap()

Show modal window with Bootstrap function.

open fun toggle()

Toggle modal window visibility.