Package org.teamapps.ux.component.notification

Class Notification

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.notification.Notification

All Implemented Interfaces:

Component

public class Notification
extends AbstractComponent

Field Summary

Fields

Modifier and Type	Field	Description
Event<java.lang.Boolean>	onClosed
Event<java.lang.Void>	onOpened

Fields inherited from class org.teamapps.ux.component.AbstractComponent

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
Notification()
Notification(Component content)

Method Summary

Modifier and Type	Method	Description
void	close()
org.teamapps.dto.UiNotification	createUiComponent()
static Notification	createWithIconAndCaption(org.teamapps.icons.api.Icon icon, java.lang.String text)
static Notification	createWithIconAndTextAndDescription(org.teamapps.icons.api.Icon icon, java.lang.String text, java.lang.String description)
org.teamapps.common.format.Color	getBackgroundColor()
Component	getContent()
int	getDisplayTimeInMillis()
Spacing	getPadding()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isDismissible()
boolean	isShowing()
boolean	isShowProgressBar()
Notification	setBackgroundColor(org.teamapps.common.format.Color backgroundColor)
Notification	setContent(Component content)
Notification	setDismissible(boolean dismissible)
Notification	setDisplayTimeInMillis(int displayTimeInMillis)
Notification	setPadding(Spacing padding)
Notification	setShowProgressBar(boolean showProgressBar)

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiComponentReference, destroy, doDestroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, onDestroyed, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.Component

setCssStyle

Field Detail

onOpened

public final Event<java.lang.Void> onOpened

onClosed

public final Event<java.lang.Boolean> onClosed

Constructor Detail

Notification

public Notification()

Notification

public Notification(Component content)

Method Detail

createWithIconAndCaption

public static Notification createWithIconAndCaption(org.teamapps.icons.api.Icon icon,
                                                    java.lang.String text)

createWithIconAndTextAndDescription

public static Notification createWithIconAndTextAndDescription(org.teamapps.icons.api.Icon icon,
                                                               java.lang.String text,
                                                               java.lang.String description)

createUiComponent

public org.teamapps.dto.UiNotification createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

close

public void close()

getBackgroundColor

public org.teamapps.common.format.Color getBackgroundColor()

setBackgroundColor

public Notification setBackgroundColor(org.teamapps.common.format.Color backgroundColor)

getPadding

public Spacing getPadding()

setPadding

public Notification setPadding(Spacing padding)

getDisplayTimeInMillis

public int getDisplayTimeInMillis()

setDisplayTimeInMillis

public Notification setDisplayTimeInMillis(int displayTimeInMillis)

isDismissible

public boolean isDismissible()

setDismissible

public Notification setDismissible(boolean dismissible)

isShowProgressBar

public boolean isShowProgressBar()

setShowProgressBar

public Notification setShowProgressBar(boolean showProgressBar)

getContent

public Component getContent()

setContent

public Notification setContent(Component content)

isShowing

public boolean isShowing()