Package io.jmix.ui

Interface Notifications

All Known Implementing Classes:

NotificationsImpl

public interface Notifications

Notifications API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Notifications.CloseEvent	An event that is fired when notification is closed.
static interface	Notifications.NotificationBuilder	Notification builder object.
static enum	Notifications.NotificationType	Popup notification type.
static enum	Notifications.Position	Popup notification position.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DELAY_DEFAULT
static final int	DELAY_FOREVER
static final int	DELAY_NONE

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.

Field Details

DELAY_FOREVER

static final int DELAY_FOREVER

See Also:

• Constant Field Values

DELAY_NONE

static final int DELAY_NONE

See Also:

• Constant Field Values

DELAY_DEFAULT

static final int DELAY_DEFAULT

See Also:

• Constant Field Values

Method Details

create

Notifications.NotificationBuilder create()

Creates a notification builder.
Example of showing a notification:

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

Returns:

notification builder

create

Notifications.NotificationBuilder create(Notifications.NotificationType type)

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();
 

Parameters:

type - notification type

Returns:

notification builder