Package io.jmix.ui.sys

Class NotificationsImpl.NotificationBuilderImpl

java.lang.Object

io.jmix.ui.sys.NotificationsImpl.NotificationBuilderImpl

All Implemented Interfaces:

Notifications.NotificationBuilder

Enclosing class:

NotificationsImpl

public class NotificationsImpl.NotificationBuilderImpl
extends Object
implements Notifications.NotificationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	caption
protected ContentMode	contentMode
protected String	description
protected EventHub	eventHub
protected int	hideDelayMs
protected boolean	htmlSanitizerEnabled
protected Notifications.NotificationType	notificationType
protected Notifications.Position	position
protected String	styleName
static final String	SYSTEM_STYLENAME

Constructor Summary

Constructors

Constructor	Description
NotificationBuilderImpl()

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.ui.Notification.Type	convertType(Notifications.NotificationType notificationType)
protected com.vaadin.ui.Notification	createNotification()
String	getCaption()
ContentMode	getContentMode()
String	getDescription()
int	getHideDelayMs()
Notifications.Position	getPosition()
String	getStyleName()
Notifications.NotificationType	getType()
boolean	isHtmlSanitizerEnabled()
protected void	setNotificationDelayMsec(com.vaadin.ui.Notification notification, Notifications.NotificationType type)
void	show()	Shows notification.
Notifications.NotificationBuilder	withCaption(String caption)	Sets notification caption.
Notifications.NotificationBuilder	withCloseListener(Consumer<Notifications.CloseEvent> closeListener)	Sets the listener that will be fired when notification will be closed.
Notifications.NotificationBuilder	withContentMode(ContentMode contentMode)	Sets content mode for caption and description of notification.
Notifications.NotificationBuilder	withDescription(String description)	Sets notification description.
Notifications.NotificationBuilder	withHideDelayMs(int hideDelayMs)	Sets the delay before the notification disappears.
Notifications.NotificationBuilder	withHtmlSanitizer(boolean htmlSanitizerEnabled)	Sets whether html sanitizer is enabled or not for notification content.
Notifications.NotificationBuilder	withPosition(Notifications.Position position)	Sets position of notification.
Notifications.NotificationBuilder	withStyleName(String styleName)	Sets CSS class name for notification DOM element.
Notifications.NotificationBuilder	withType(Notifications.NotificationType notificationType)	Sets type of notification.

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_STYLENAME

public static final String SYSTEM_STYLENAME

See Also:

• Constant Field Values

caption

protected String caption

description

protected String description

styleName

protected String styleName

htmlSanitizerEnabled

protected boolean htmlSanitizerEnabled

position

protected Notifications.Position position

hideDelayMs

protected int hideDelayMs

contentMode

protected ContentMode contentMode

notificationType

protected Notifications.NotificationType notificationType

eventHub

protected EventHub eventHub

Constructor Details

NotificationBuilderImpl

public NotificationBuilderImpl()

Method Details

withCaption

public Notifications.NotificationBuilder withCaption(String caption)

Description copied from interface: Notifications.NotificationBuilder

Sets notification caption.

Specified by:

withCaption in interface Notifications.NotificationBuilder

Parameters:

caption - caption

Returns:

this

getCaption

public String getCaption()

Specified by:

getCaption in interface Notifications.NotificationBuilder

Returns:

caption

withDescription

public Notifications.NotificationBuilder withDescription(String description)

Description copied from interface: Notifications.NotificationBuilder

Sets notification description.

Specified by:

withDescription in interface Notifications.NotificationBuilder

Parameters:

description - description

Returns:

this

getDescription

public String getDescription()

Specified by:

getDescription in interface Notifications.NotificationBuilder

Returns:

description

withType

public Notifications.NotificationBuilder withType(Notifications.NotificationType notificationType)

Description copied from interface: Notifications.NotificationBuilder

Sets type of notification.

Specified by:

withType in interface Notifications.NotificationBuilder

Parameters:

notificationType - type

Returns:

this

getType

public Notifications.NotificationType getType()

Specified by:

getType in interface Notifications.NotificationBuilder

Returns:

type

withContentMode

public Notifications.NotificationBuilder withContentMode(ContentMode contentMode)

Description copied from interface: Notifications.NotificationBuilder

Sets content mode for caption and description of notification.

Specified by:

withContentMode in interface Notifications.NotificationBuilder

Parameters:

contentMode - content mode

Returns:

this

getContentMode

public ContentMode getContentMode()

Specified by:

getContentMode in interface Notifications.NotificationBuilder

Returns:

content mode

withStyleName

public Notifications.NotificationBuilder withStyleName(String styleName)

Description copied from interface: Notifications.NotificationBuilder

Sets CSS class name for notification DOM element.

Specified by:

withStyleName in interface Notifications.NotificationBuilder

Parameters:

styleName - CSS class name

Returns:

this

getStyleName

public String getStyleName()

Specified by:

getStyleName in interface Notifications.NotificationBuilder

Returns:

CSS class name

withPosition

public Notifications.NotificationBuilder withPosition(Notifications.Position position)

Description copied from interface: Notifications.NotificationBuilder

Sets position of notification.

Specified by:

withPosition in interface Notifications.NotificationBuilder

Parameters:

position - position

Returns:

this

getPosition

public Notifications.Position getPosition()

Specified by:

getPosition in interface Notifications.NotificationBuilder

Returns:

position

withHtmlSanitizer

public Notifications.NotificationBuilder withHtmlSanitizer(boolean htmlSanitizerEnabled)

Description copied from interface: Notifications.NotificationBuilder

Sets whether html sanitizer is enabled or not for notification content.

Specified by:

withHtmlSanitizer in interface Notifications.NotificationBuilder

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

Returns:

builder

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Specified by:

isHtmlSanitizerEnabled in interface Notifications.NotificationBuilder

Returns:

html sanitizer is enabled for notification content

withHideDelayMs

public Notifications.NotificationBuilder withHideDelayMs(int hideDelayMs)

Description copied from interface: Notifications.NotificationBuilder

Sets the delay before the notification disappears.

Specified by:

withHideDelayMs in interface Notifications.NotificationBuilder

Parameters:

hideDelayMs - the desired delay in milliseconds, -1 to require the user to click the message

getHideDelayMs

public int getHideDelayMs()

Specified by:

getHideDelayMs in interface Notifications.NotificationBuilder

Returns:

the delay before the notification disappears in milliseconds

withCloseListener

public Notifications.NotificationBuilder withCloseListener(Consumer<Notifications.CloseEvent> closeListener)

Description copied from interface: Notifications.NotificationBuilder

Sets the listener that will be fired when notification will be closed.

Specified by:

withCloseListener in interface Notifications.NotificationBuilder

Parameters:

closeListener - Notifications.CloseEvent consumer

Returns:

this

convertType

protected com.vaadin.ui.Notification.Type convertType(Notifications.NotificationType notificationType)

setNotificationDelayMsec

protected void setNotificationDelayMsec(com.vaadin.ui.Notification notification,
 Notifications.NotificationType type)

createNotification

protected com.vaadin.ui.Notification createNotification()

show

public void show()

Description copied from interface: Notifications.NotificationBuilder

Shows notification.

Specified by:

show in interface Notifications.NotificationBuilder