Package io.jmix.flowui

Class Notifications

java.lang.Object

io.jmix.flowui.Notifications

@Component("flowui_Notifications")
public class Notifications
extends Object

Configures and displays popup notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Notifications.NotificationBuilder	A builder that configures and displays notifications.
static enum	Notifications.Type	Notification type.

Field Summary

Fields

Modifier and Type	Field	Description
protected UiComponentProperties	uiComponentProperties

Constructor Summary

Constructors

Constructor	Description
Notifications(UiComponentProperties uiComponentProperties)

Method Summary

Modifier and Type	Method	Description
Notifications.NotificationBuilder	create(com.vaadin.flow.component.Component component)	Returns a builder for configuring and displaying the notification.
Notifications.NotificationBuilder	create(String text)	Returns a builder for configuring and displaying the notification.
Notifications.NotificationBuilder	create(String title, String message)	Returns a builder for configuring and displaying the notification.
void	show(com.vaadin.flow.component.Component component)	Shows a component in the notification popup.
void	show(String text)	Shows a simple text notification.
void	show(String title, String message)	Shows a notification with a title and message.

Methods inherited from class java.lang.Object

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

Field Details

uiComponentProperties

protected UiComponentProperties uiComponentProperties

Constructor Details

Notifications

@Autowired
public Notifications(UiComponentProperties uiComponentProperties)

Method Details

show

public void show(String text)

Shows a simple text notification.

Parameters:

text - notification text

show

public void show(String title,
 String message)

Shows a notification with a title and message.

Parameters:

title - notification title

message - notification message

show

public void show(com.vaadin.flow.component.Component component)

Shows a component in the notification popup.

Parameters:

component - component to show in notification

create

public Notifications.NotificationBuilder create(String text)

Returns a builder for configuring and displaying the notification.

Parameters:

text - notification text

create

public Notifications.NotificationBuilder create(String title,
 String message)

Returns a builder for configuring and displaying the notification.

Parameters:

title - notification title

message - notification message

create

public Notifications.NotificationBuilder create(com.vaadin.flow.component.Component component)

Returns a builder for configuring and displaying the notification.

Parameters:

component - component to show in notification