Package org.teamapps.ux.component.notification

Class Notification<RECORD>

java.lang.Object

org.teamapps.ux.component.notification.Notification<RECORD>

public class Notification<RECORD>
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Notification(Template template, RECORD record)
Notification(RECORD message)	Used to display a simple message (text only).

Method Summary

Modifier and Type	Method	Description
org.teamapps.dto.UiNotification	createUiNotification()
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()
int	getDisplayTimeInMillis()
EntranceAnimation	getEntranceAnimation()
ExitAnimation	getExitAnimation()
NotificationPosition	getPosition()
RECORD	getRecord()
Template	getTemplate()
boolean	isDismissable()
boolean	isShowProgressBar()
Notification	setBackgroundColor(org.teamapps.common.format.Color backgroundColor)
Notification	setDismissable(boolean dismissable)
Notification	setDisplayTimeInMillis(int displayTimeInMillis)
Notification	setEntranceAnimation(EntranceAnimation entranceAnimation)
Notification	setExitAnimation(ExitAnimation exitAnimation)
Notification	setPosition(NotificationPosition position)
Notification	setRecord(RECORD record)
Notification	setShowProgressBar(boolean showProgressBar)
Notification	setTemplate(Template template)

Methods inherited from class java.lang.Object

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

Constructor Detail

Notification

public Notification(RECORD message)

Used to display a simple message (text only).

Parameters:

message - Normally a String, but may be any object (using toString()).

Notification

public Notification(Template template,
                    RECORD record)

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)

createUiNotification

public org.teamapps.dto.UiNotification createUiNotification()

getPosition

public NotificationPosition getPosition()

setPosition

public Notification setPosition(NotificationPosition position)

getTemplate

public Template getTemplate()

setTemplate

public Notification setTemplate(Template template)

getRecord

public RECORD getRecord()

setRecord

public Notification setRecord(RECORD record)

getBackgroundColor

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

setBackgroundColor

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

getDisplayTimeInMillis

public int getDisplayTimeInMillis()

setDisplayTimeInMillis

public Notification setDisplayTimeInMillis(int displayTimeInMillis)

isDismissable

public boolean isDismissable()

setDismissable

public Notification setDismissable(boolean dismissable)

isShowProgressBar

public boolean isShowProgressBar()

setShowProgressBar

public Notification setShowProgressBar(boolean showProgressBar)

getEntranceAnimation

public EntranceAnimation getEntranceAnimation()

setEntranceAnimation

public Notification setEntranceAnimation(EntranceAnimation entranceAnimation)

getExitAnimation

public ExitAnimation getExitAnimation()

setExitAnimation

public Notification setExitAnimation(ExitAnimation exitAnimation)