Package io.jmix.ui.sys

Class NotificationsImpl

java.lang.Object

io.jmix.ui.sys.NotificationsImpl

All Implemented Interfaces:

Notifications

@UIScope
@Component("ui_Notifications")
public class NotificationsImpl
extends Object
implements Notifications

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NotificationsImpl.NotificationBuilderImpl

Nested classes/interfaces inherited from interface io.jmix.ui.Notifications

Notifications.CloseEvent, Notifications.NotificationBuilder, Notifications.NotificationType, Notifications.Position

Field Summary

Fields

Modifier and Type	Field	Description
protected BackgroundWorker	backgroundWorker
protected UiComponentProperties	componentProperties
protected HtmlSanitizer	htmlSanitizer
protected static final int	HUMANIZED_NOTIFICATION_DELAY_MSEC
protected AppUI	ui
protected static final int	WARNING_NOTIFICATION_DELAY_MSEC

Fields inherited from interface io.jmix.ui.Notifications

DELAY_DEFAULT, DELAY_FOREVER, DELAY_NONE

Constructor Summary

Constructors

Constructor	Description
NotificationsImpl()

Method Summary

Modifier and Type	Method	Description
Notifications.NotificationBuilder	create()	Creates a notification builder.
Notifications.NotificationBuilder	create(Notifications.NotificationType type)	Creates a notification builder with the passed notification type.
protected void	setBackgroundWorker(BackgroundWorker backgroundWorker)
void	setUi(AppUI ui)

Methods inherited from class java.lang.Object

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

Field Details

HUMANIZED_NOTIFICATION_DELAY_MSEC

protected static final int HUMANIZED_NOTIFICATION_DELAY_MSEC

See Also:

• Constant Field Values

WARNING_NOTIFICATION_DELAY_MSEC

protected static final int WARNING_NOTIFICATION_DELAY_MSEC

See Also:

• Constant Field Values

ui

protected AppUI ui

backgroundWorker

protected BackgroundWorker backgroundWorker

componentProperties

@Autowired
protected UiComponentProperties componentProperties

htmlSanitizer

@Autowired
protected HtmlSanitizer htmlSanitizer

Constructor Details

NotificationsImpl

public NotificationsImpl()

Method Details

setUi

@Autowired
public void setUi(AppUI ui)

setBackgroundWorker

@Autowired
protected void setBackgroundWorker(BackgroundWorker backgroundWorker)

create

public Notifications.NotificationBuilder create()

Description copied from interface: Notifications

Creates a notification builder.
Example of showing a notification:

 notifications.create()
         .withType(NotificationType.WARNING)
         .withCaption("Alert")
         .withPosition(Notifications.Position.BOTTOM_RIGHT)
         .show();
 

Specified by:

create in interface Notifications

Returns:

notification builder

create

public Notifications.NotificationBuilder create(Notifications.NotificationType type)

Description copied from interface: Notifications

Creates a notification builder with the passed notification type.
Example of showing a notification:

 notifications.create(NotificationType.WARNING)
         .withCaption("Alert")
         .withDescription("Please specify name")
         .withPosition(Notifications.Position.BOTTOM_RIGHT)
         .show();
 

Specified by:

create in interface Notifications

Parameters:

type - notification type

Returns:

notification builder