Notification (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,Notification>
- - org.dominokit.domino.ui.notifications.Notification

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Notification,Notification>, HasChildren<Notification>, HasWavesElement, IsCollapsible<Notification>, IsReadOnly<Notification>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>
```
public class Notification
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Notification>
implements org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>
```
A component for showing notifications on different position with custom content
Customize the component can be done by overwriting classes provided by NotificationStyles
For example:
```
     Notification.createSuccess("Everything is okay");
 
```
See Also:

BaseDominoElement

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Notification.CloseHandler` functional interface to handle close event
`static interface`	`Notification.Position` An interface for the required API to implement new position classes for notifications

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

Field Summary

Fields
Modifier and Type	Field and Description
`static Notification.Position`	`BOTTOM_CENTER` Bottom center position
`static Notification.Position`	`BOTTOM_LEFT` Bottom left position
`static Notification.Position`	`BOTTOM_RIGHT` Bottom right position
`static Notification.Position`	`TOP_CENTER` Top center position
`static Notification.Position`	`TOP_LEFT` Top left position
`static Notification.Position`	`TOP_RIGHT` Top right position

Constructor Summary

Constructors
Constructor and Description

Notification()

Constructors
Constructor and Description
`Notification()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Notification`	`addCloseHandler(Notification.CloseHandler closeHandler)` Add a handler to be called when a notification is closed
`Notification`	`appendContent(elemental2.dom.Node content)` Appends any kind of content to the notification body.
`void`	`close()` Closes the notification based on the applied notification position and apply the close animation.
`void`	`close(int after)` Closes the notification based on the applied notification position and apply the close animation after the specified duration.
`static Notification`	`create(String message)` Creates a notification for the message with no specific type and default black bacjground.
`static Notification`	`create(String message, String type)` Creates a notification for the message with the specified type/style
`static Notification`	`createDanger(String message)` Creates a notification with danger style (red background) indicating a failed operation.
`static Notification`	`createInfo(String message)` Creates a notification with success style (green background) to informative message.
`static Notification`	`createSuccess(String message)` Creates a notification with success style (green background) indicating a success operation.
`static Notification`	`createWarning(String message)` Creates a notification with success style (green background) to show warnings.
`Notification`	`duration(int duration)` for none infinite notifications, the duration defined how long the notification will remain visible after the show transition is completed before it is automatically closed.
`elemental2.dom.HTMLDivElement`	`element()`
`DominoElement<elemental2.dom.HTMLButtonElement>`	`getCloseButton()`
`List<Notification.CloseHandler>`	`getCloseHandlers()`
`Notification`	`inTransition(Transition inTransition)` Defines the animation transition to be applied to show up the notification when `show()` is called.
`boolean`	`isClosable()`
`boolean`	`isInfinite()`
`Notification`	`outTransition(Transition outTransition)` Defines the animation transition to be applied to close up the notification when `close()` is called, or the duration ends.
`Notification`	`removeCloseHandler(Notification.CloseHandler closeHandler)` Removes a `Notification.CloseHandler` from the currently existing close handlers.
`Notification`	`setBackground(Color background)` Apply a custom background color to the notification.
`Notification`	`setClosable(boolean closable)` Use to show or hide the close button.
`Notification`	`setInfinite(boolean infinite)` When true, duration will be ignored, and the notification will only close if the `close()` is called or close button is clicked.
`Notification`	`setMessage(String message)` The text content of the notification
`Notification`	`setPosition(Notification.Position position)` Defines the location in which the notification will show up when `show()` is called.
`Notification`	`setType(String type)` Sets specified type/style
`Notification`	`show()` Show up the notification and apply the IN transtion animation.

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, 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

- Field Detail
  - TOP_LEFT
```
public static final Notification.Position TOP_LEFT
```
    Top left position
  - TOP_CENTER
```
public static final Notification.Position TOP_CENTER
```
    Top center position
  - TOP_RIGHT
```
public static final Notification.Position TOP_RIGHT
```
    Top right position
  - BOTTOM_LEFT
```
public static final Notification.Position BOTTOM_LEFT
```
    Bottom left position
  - BOTTOM_CENTER
```
public static final Notification.Position BOTTOM_CENTER
```
    Bottom center position
  - BOTTOM_RIGHT
```
public static final Notification.Position BOTTOM_RIGHT
```
    Bottom right position
- Constructor Detail
  - Notification
```
public Notification()
```
- Method Detail
  - createDanger
```
public static Notification createDanger(String message)
```
    Creates a notification with danger style (red background) indicating a failed operation.
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - createSuccess
```
public static Notification createSuccess(String message)
```
    Creates a notification with success style (green background) indicating a success operation.
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - createWarning
```
public static Notification createWarning(String message)
```
    Creates a notification with success style (green background) to show warnings.
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - createInfo
```
public static Notification createInfo(String message)
```
    Creates a notification with success style (green background) to informative message.
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - create
```
public static Notification create(String message,
                                  String type)
```
    Creates a notification for the message with the specified type/style
    
    Parameters:
    
    message - the content message
    
    type - the style to be applied on the notification, predefined types ,,,
    
    Returns:
    
    Notification
  - create
```
public static Notification create(String message)
```
    Creates a notification for the message with no specific type and default black bacjground.
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - getCloseButton
```
public DominoElement<elemental2.dom.HTMLButtonElement> getCloseButton()
```
    Returns:
    
    DominoElement the close button of the notification.
  - setClosable
```
public Notification setClosable(boolean closable)
```
    Use to show or hide the close button.
    
    Returns:
    
    Notification
  - isClosable
```
public boolean isClosable()
```
    Returns:
    
    boolean, true if the close button is visible, else false.
  - duration
```
public Notification duration(int duration)
```
    for none infinite notifications, the duration defined how long the notification will remain visible after the show transition is completed before it is automatically closed.
    
    Parameters:
    
    duration - in millisecond
    
    Returns:
    
    Notification
  - inTransition
```
public Notification inTransition(Transition inTransition)
```
    Defines the animation transition to be applied to show up the notification when show() is called.
    
    Parameters:
    
    inTransition - Transition
    
    Returns:
    
    Notification
  - outTransition
```
public Notification outTransition(Transition outTransition)
```
    Defines the animation transition to be applied to close up the notification when close() is called, or the duration ends.
    
    Parameters:
    
    outTransition - Transition
    
    Returns:
    
    Notification
  - setMessage
```
public Notification setMessage(String message)
```
    The text content of the notification
    
    Parameters:
    
    message - the content message
    
    Returns:
    
    Notification
  - setType
```
public Notification setType(String type)
```
    Sets specified type/style
    
    Parameters:
    
    type - the style to be applied on the notification, predefined types ,,,
    
    Returns:
    
    Notification
  - appendContent
```
public Notification appendContent(elemental2.dom.Node content)
```
    Appends any kind of content to the notification body.
    
    Parameters:
    
    content - Node
    
    Returns:
    
    Notification
  - setPosition
```
public Notification setPosition(Notification.Position position)
```
    Defines the location in which the notification will show up when show() is called.
    
    Parameters:
    
    position - Notification.Position
    
    Returns:
    
    Notification
  - setBackground
```
public Notification setBackground(Color background)
```
    Apply a custom background color to the notification. this will override styles applied from the notification types.
    
    Parameters:
    
    background - Color
    
    Returns:
    
    Notification
  - setInfinite
```
public Notification setInfinite(boolean infinite)
```
    When true, duration will be ignored, and the notification will only close if the close() is called or close button is clicked.
    
    Parameters:
    
    infinite - true to close manually only, false otherwise
    
    Returns:
    
    Notification
  - isInfinite
```
public boolean isInfinite()
```
    Returns:
    
    boolean, true if notification is finite
  - show
```
public Notification show()
```
    Show up the notification and apply the IN transtion animation.
    
    Specified by:
    
    show in interface IsCollapsible<Notification>
    
    Overrides:
    
    show in class BaseDominoElement<elemental2.dom.HTMLDivElement,Notification>
    
    Returns:
    
    Notification
    
    See Also:
    
    Collapsible.show()
  - close
```
public final void close()
```
    Closes the notification based on the applied notification position and apply the close animation.
  - close
```
public final void close(int after)
```
    Closes the notification based on the applied notification position and apply the close animation after the specified duration.
    
    Parameters:
    
    after - time to wait before starting the close animation in milliseconds
  - getCloseHandlers
```
public List<Notification.CloseHandler> getCloseHandlers()
```
    Returns:
    
    List of Notification.CloseHandler to be called when a notification is closed.
  - addCloseHandler
```
public Notification addCloseHandler(Notification.CloseHandler closeHandler)
```
    Add a handler to be called when a notification is closed
    
    Parameters:
    
    closeHandler - Notification.CloseHandler
    
    Returns:
    
    Notification
  - removeCloseHandler
```
public Notification removeCloseHandler(Notification.CloseHandler closeHandler)
```
    Removes a Notification.CloseHandler from the currently existing close handlers.
    
    Parameters:
    
    closeHandler - A Notification.CloseHandler
    
    Returns:
    
    Notification
  - 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,Notification>
    
    Returns:
    
    HTMLDivElement the root element that represent this notification instance.

Class Notification

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Field Detail

TOP_LEFT

TOP_CENTER

TOP_RIGHT

BOTTOM_LEFT

BOTTOM_CENTER

BOTTOM_RIGHT

Constructor Detail

Notification

Method Detail

createDanger

createSuccess

createWarning

createInfo

create

create

getCloseButton

setClosable

isClosable

duration

inTransition

outTransition

setMessage

setType

appendContent

setPosition

setBackground

setInfinite

isInfinite

show

close

close

getCloseHandlers

addCloseHandler

removeCloseHandler

element