org.dominokit.domino.ui.alerts

Class Alert

java.lang.Object

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

org.dominokit.domino.ui.alerts.Alert

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Alert,Alert>, HasBackground<Alert>, HasChildren<Alert>, HasWavesElement, IsCollapsible<Alert>, IsReadOnly<Alert>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Alert
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Alert>
implements HasBackground<Alert>

Displays messages on the screen.

This component provides four basic types of severity:

• Success
• Info
• Warning
• Error

Customize the component can be done by overwriting classes provided by AlertStyles

For example:

     Alert.success()
          .appendChild("Well done! ")
          .appendChild("You successfully read this important alert message.")
 

See Also:

BaseDominoElement, HasBackground, Color

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Alert.AlertType Alert severity levels

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

Constructor Summary

Constructors

Constructor and Description
Alert()

Method Summary

Modifier and Type	Method and Description
Alert	appendChild(AlertLink alertLink) Adds AlertLink as a child
Alert	appendChild(elemental2.dom.HTMLAnchorElement anchorElement) Adds anchor element as a child, this method adds Styles.alert_link style to anchor element by default
Alert	appendChild(String text) Adds text as a child, the text will be added in TextNode
Alert	appendChild(Strong strong) Adds Strong as a child
static Alert	create() Creates alert with default style
static Alert	create(Color background) Creates alert with background color
Alert	dismissible() Sets the alert to closable and a close button will be added to the element to hide it
elemental2.dom.HTMLDivElement	element()
static Alert	error() Creates alert with error severity
elemental2.dom.HTMLButtonElement	getCloseButton() Returns the close button for customization
static Alert	info() Creates alert with info severity
boolean	isDismissible()
Alert	setBackground(Color background)
Alert	setDismissible(boolean dismissible) Passing true means that the alert will be closable and a close button will be added to the element to hide it
Alert	setDissmissible(boolean dismissible) Deprecated.
static Alert	success() Creates alert with success severity
Alert	unDismissible() Sets the alert to not closable and the close button will be removed if exist, the alert can be hidden programmatically using BaseDominoElement.remove()
static Alert	warning() Creates alert with warning severity

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, 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

Alert

public Alert()

Method Detail

create

public static Alert create(Color background)

Creates alert with background color

Parameters:

background - the background color

Returns:

new alert instance

create

public static Alert create()

Creates alert with default style

Returns:

new alert instance

success

public static Alert success()

Creates alert with success severity

Returns:

new alert instance

info

public static Alert info()

Creates alert with info severity

Returns:

new alert instance

warning

public static Alert warning()

Creates alert with warning severity

Returns:

new alert instance

error

public static Alert error()

Creates alert with error severity

Returns:

new alert instance

setBackground

public Alert setBackground(Color background)

Specified by:

setBackground in interface HasBackground<Alert>

Parameters:

background - Color

Returns:

same implementing component

appendChild

public Alert appendChild(Strong strong)

Adds Strong as a child

Parameters:

strong - the element to add

Returns:

same instance

appendChild

public Alert appendChild(String text)

Adds text as a child, the text will be added in TextNode

Parameters:

text - the content

Returns:

same instance

appendChild

public Alert appendChild(elemental2.dom.HTMLAnchorElement anchorElement)

Adds anchor element as a child, this method adds Styles.alert_link style to anchor element by default

Parameters:

anchorElement - the element

Returns:

same instance

appendChild

public Alert appendChild(AlertLink alertLink)

Adds AlertLink as a child

Parameters:

alertLink - the element

Returns:

same instance

See Also:

AlertLink

setDissmissible

@Deprecated
public Alert setDissmissible(boolean dismissible)

Deprecated.

use setDismissible(boolean) instead

setDismissible

public Alert setDismissible(boolean dismissible)

Passing true means that the alert will be closable and a close button will be added to the element to hide it

Parameters:

dismissible - true to set it as closable, false otherwise

Returns:

same instance

dismissible

public Alert dismissible()

Sets the alert to closable and a close button will be added to the element to hide it

Returns:

same instance

unDismissible

public Alert unDismissible()

Sets the alert to not closable and the close button will be removed if exist, the alert can be hidden programmatically using BaseDominoElement.remove()

Returns:

same instance

isDismissible

public boolean isDismissible()

Returns:

true if the alert is closable, false otherwise

getCloseButton

public elemental2.dom.HTMLButtonElement getCloseButton()

Returns the close button for customization

Returns:

the close button element

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Alert>

Returns:

the HTML element of type E which is the root element of the component