org.dominokit.domino.ui.dialogs

Class MessageDialog

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,T>

org.dominokit.domino.ui.modals.BaseModal<MessageDialog>

org.dominokit.domino.ui.dialogs.MessageDialog

All Implemented Interfaces:

IsModalDialog<MessageDialog>, DominoStyle<elemental2.dom.HTMLDivElement,MessageDialog,MessageDialog>, HasChildren<MessageDialog>, HasWavesElement, IsCollapsible<MessageDialog>, IsReadOnly<MessageDialog>, Switchable<MessageDialog>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class MessageDialog
extends BaseModal<MessageDialog>

A component to show message dialogs to the user with ability to make him take actions from those dialogs

     MessageDialog.createMessage(
         "Here\'s a message!", () -> Notification.create("Dialog closed").show();
 

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.modals.BaseModal

BaseModal.Modal

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.modals.IsModalDialog

IsModalDialog.CloseHandler, IsModalDialog.ModalSize, IsModalDialog.ModalType, IsModalDialog.OpenHandler

Field Summary

Fields inherited from class org.dominokit.domino.ui.modals.BaseModal

modalElement

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
MessageDialog() Creates a new instance

Method Summary

Modifier and Type	Method and Description
MessageDialog	appendHeaderChild(org.jboss.elemento.IsElement<?> content)
MessageDialog	appendHeaderChild(elemental2.dom.Node content)
static MessageDialog	createMessage(elemental2.dom.Node content) Creates an instance and initialize it with custom content
static MessageDialog	createMessage(elemental2.dom.Node content, IsModalDialog.CloseHandler closeHandler) Creates an instance and initialize it with custom content a close handler
static MessageDialog	createMessage(elemental2.dom.Node content, IsModalDialog.CloseHandler closeHandler, Supplier<Button> okButtonProvider) Creates an instance and initialize it with custom content a close handler and an ok action button
static MessageDialog	createMessage(elemental2.dom.Node content, Supplier<Button> okButtonProvider) Creates an instance and initialize it with custom content and an Ok action button
static MessageDialog	createMessage(String message) Creates an instance and initialize it with a text message
static MessageDialog	createMessage(String message, IsModalDialog.CloseHandler closeHandler) Creates an instance and initialize it with a text message and a close handler
static MessageDialog	createMessage(String message, IsModalDialog.CloseHandler closeHandler, Supplier<Button> okButtonProvider) Creates an instance and initialize it with a text message and a close handler and an ok action button
static MessageDialog	createMessage(String title, elemental2.dom.Node content) Creates an instance and initialize it with a title and custom content
static MessageDialog	createMessage(String title, elemental2.dom.Node content, IsModalDialog.CloseHandler closeHandler) Creates an instance and initialize it with a title and custom content and a close handler
static MessageDialog	createMessage(String title, elemental2.dom.Node content, IsModalDialog.CloseHandler closeHandler, Supplier<Button> okButtonProvider) Creates an instance and initialize it with a title and custom content a close handler and an ok action button
static MessageDialog	createMessage(String title, elemental2.dom.Node content, Supplier<Button> okButtonProvider) Creates an instance and initialize it with a title and custom content and an ok action button
static MessageDialog	createMessage(String title, String message) Creates an instance and initialize it with a title and a text message
static MessageDialog	createMessage(String title, String message, IsModalDialog.CloseHandler closeHandler) Creates an instance and initialize it with a title and a text message and a close handler
MessageDialog	error() Set a default Icons#ALL#error() icon as the dialog content with an animation transition to indicate a failed operation
MessageDialog	error(BaseIcon<?> icon) Set the icon as the dialog content with an animation transition to indicate a failed operation
Button	getOkButton()
MessageDialog	setIconColor(Color iconColorStart, Color iconColorEnd) Change the dialog icon colors transitions
MessageDialog	setOkButtonText(String text) Change the ok button text
MessageDialog	success() Set a default Icons#ALL#done() icon as the dialog content with an animation transition to indicate a success operation
MessageDialog	success(BaseIcon<?> icon) Set the icon as the dialog content with an animation transition to indicate a success operation
MessageDialog	warning() Set a default Icons#ALL#clear() icon as the dialog content with an animation transition to indicate a warning operation
MessageDialog	warning(BaseIcon<?> icon) Set the icon as the dialog content with an animation transition to indicate a warning operation

Methods inherited from class org.dominokit.domino.ui.modals.BaseModal

addCloseListener, addOpenListener, appendChild, appendChild, appendFooterChild, appendFooterChild, centerVertically, close, deCenterVertically, disable, element, enable, getAutoAppendAndRemove, getBodyElement, getContentElement, getDialogElement, getFooterElement, getHeaderContainerElement, getHeaderElement, hideFooter, hideHeader, hideTitle, isAutoClose, isAutoFocus, isEnabled, isModal, isOpen, large, open, removeCloseHandler, removeOpenHandler, setAutoAppendAndRemove, setAutoClose, setAutoFocus, setModal, setModalColor, setSize, setTitle, setType, showFooter, showHeader, showTitle, small

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

MessageDialog

public MessageDialog()

Creates a new instance

Method Detail

createMessage

public static MessageDialog createMessage(elemental2.dom.Node content)

Creates an instance and initialize it with custom content

Parameters:

content - Node

Returns:

new instance

createMessage

public static MessageDialog createMessage(elemental2.dom.Node content,
                                          Supplier<Button> okButtonProvider)

Creates an instance and initialize it with custom content and an Ok action button

Parameters:

content - Node

okButtonProvider - Supplier of Button for the ok action

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          elemental2.dom.Node content)

Creates an instance and initialize it with a title and custom content

Parameters:

title - String

content - Node

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          elemental2.dom.Node content,
                                          Supplier<Button> okButtonProvider)

Creates an instance and initialize it with a title and custom content and an ok action button

Parameters:

title - String

content - Node

okButtonProvider - Supplier of Button for the ok action

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          elemental2.dom.Node content,
                                          IsModalDialog.CloseHandler closeHandler)

Creates an instance and initialize it with a title and custom content and a close handler

Parameters:

title - String

content - Node

closeHandler - CloseHandler

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          elemental2.dom.Node content,
                                          IsModalDialog.CloseHandler closeHandler,
                                          Supplier<Button> okButtonProvider)

Creates an instance and initialize it with a title and custom content a close handler and an ok action button

Parameters:

title - String

content - Node

closeHandler - CloseHandler

okButtonProvider - Supplier of Button

Returns:

new instance

createMessage

public static MessageDialog createMessage(elemental2.dom.Node content,
                                          IsModalDialog.CloseHandler closeHandler)

Creates an instance and initialize it with custom content a close handler

Parameters:

content - Node

closeHandler - CloseHandler

Returns:

new instance

createMessage

public static MessageDialog createMessage(elemental2.dom.Node content,
                                          IsModalDialog.CloseHandler closeHandler,
                                          Supplier<Button> okButtonProvider)

Creates an instance and initialize it with custom content a close handler and an ok action button

Parameters:

content - Node

closeHandler - CloseHandler

okButtonProvider - Supplier of Button

Returns:

new instance

setOkButtonText

public MessageDialog setOkButtonText(String text)

Change the ok button text

Parameters:

text - String button text

Returns:

same MessageDialog instance

createMessage

public static MessageDialog createMessage(String message)

Creates an instance and initialize it with a text message

Parameters:

message - String

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          String message)

Creates an instance and initialize it with a title and a text message

Parameters:

title - String

message - String

Returns:

new instance

createMessage

public static MessageDialog createMessage(String title,
                                          String message,
                                          IsModalDialog.CloseHandler closeHandler)

Creates an instance and initialize it with a title and a text message and a close handler

Parameters:

title - String

message - String

closeHandler - CloseHandler

Returns:

new instance

createMessage

public static MessageDialog createMessage(String message,
                                          IsModalDialog.CloseHandler closeHandler)

Creates an instance and initialize it with a text message and a close handler

Parameters:

message - String

closeHandler - CloseHandler

Returns:

new instance

createMessage

public static MessageDialog createMessage(String message,
                                          IsModalDialog.CloseHandler closeHandler,
                                          Supplier<Button> okButtonProvider)

Creates an instance and initialize it with a text message and a close handler and an ok action button

Parameters:

message - String

closeHandler - CloseHandler

okButtonProvider - Supplier of Button

Returns:

new instance

success

public MessageDialog success(BaseIcon<?> icon)

Set the icon as the dialog content with an animation transition to indicate a success operation

Parameters:

icon - BaseIcon

Returns:

same MessageDialog instance

success

public MessageDialog success()

Set a default Icons#ALL#done() icon as the dialog content with an animation transition to indicate a success operation

Returns:

same MessageDialog instance

error

public MessageDialog error(BaseIcon<?> icon)

Set the icon as the dialog content with an animation transition to indicate a failed operation

Parameters:

icon - BaseIcon

Returns:

same MessageDialog instance

error

public MessageDialog error()

Set a default Icons#ALL#error() icon as the dialog content with an animation transition to indicate a failed operation

Returns:

same MessageDialog instance

warning

public MessageDialog warning(BaseIcon<?> icon)

Set the icon as the dialog content with an animation transition to indicate a warning operation

Parameters:

icon - BaseIcon

Returns:

same MessageDialog instance

warning

public MessageDialog warning()

Set a default Icons#ALL#clear() icon as the dialog content with an animation transition to indicate a warning operation

Returns:

same MessageDialog instance

setIconColor

public MessageDialog setIconColor(Color iconColorStart,
                                  Color iconColorEnd)

Change the dialog icon colors transitions

Parameters:

iconColorStart - Color at the start of the animation transition

iconColorEnd - Color at the end of the animation transition

Returns:

same MessageDialog instance

appendHeaderChild

public MessageDialog appendHeaderChild(elemental2.dom.Node content)

Parameters:

content - Node to be appended to the dialog body

Returns:

same MessageDialog instance

getOkButton

public Button getOkButton()

Returns:

the ok Button if exists or null

appendHeaderChild

public MessageDialog appendHeaderChild(org.jboss.elemento.IsElement<?> content)

Parameters:

content - IsElement to be appended to the dialog header

Returns:

same MessageDialog instance