io.jmix.ui

Interface Notifications.NotificationBuilder

All Known Implementing Classes:

NotificationsImpl.NotificationBuilderImpl

Enclosing interface:

Notifications

public static interface Notifications.NotificationBuilder

Notification builder object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaption()
ContentMode	getContentMode()
java.lang.String	getDescription()
int	getHideDelayMs()
Notifications.Position	getPosition()
java.lang.String	getStyleName()
Notifications.NotificationType	getType()
boolean	isHtmlSanitizerEnabled()
void	show() Shows notification.
Notifications.NotificationBuilder	withCaption(java.lang.String caption) Sets notification caption.
Notifications.NotificationBuilder	withCloseListener(java.util.function.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(java.lang.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(java.lang.String styleName) Sets CSS class name for notification DOM element.
Notifications.NotificationBuilder	withType(Notifications.NotificationType type) Sets type of notification.

Method Detail

withCaption

Notifications.NotificationBuilder withCaption(java.lang.String caption)

Sets notification caption.

Parameters:

caption - caption

Returns:

this

getCaption

java.lang.String getCaption()

Returns:

caption

withDescription

Notifications.NotificationBuilder withDescription(java.lang.String description)

Sets notification description.

Parameters:

description - description

Returns:

this

getDescription

java.lang.String getDescription()

Returns:

description

withType

Notifications.NotificationBuilder withType(Notifications.NotificationType type)

Sets type of notification.

Parameters:

type - type

Returns:

this

getType

Notifications.NotificationType getType()

Returns:

type

withContentMode

Notifications.NotificationBuilder withContentMode(ContentMode contentMode)

Sets content mode for caption and description of notification.

Parameters:

contentMode - content mode

Returns:

this

getContentMode

ContentMode getContentMode()

Returns:

content mode

withStyleName

Notifications.NotificationBuilder withStyleName(java.lang.String styleName)

Sets CSS class name for notification DOM element.

Parameters:

styleName - CSS class name

Returns:

this

getStyleName

java.lang.String getStyleName()

Returns:

CSS class name

withPosition

Notifications.NotificationBuilder withPosition(Notifications.Position position)

Sets position of notification.

Parameters:

position - position

Returns:

this

getPosition

Notifications.Position getPosition()

Returns:

position

withHtmlSanitizer

Notifications.NotificationBuilder withHtmlSanitizer(boolean htmlSanitizerEnabled)

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

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

Returns:

builder

isHtmlSanitizerEnabled

boolean isHtmlSanitizerEnabled()

Returns:

html sanitizer is enabled for notification content

withHideDelayMs

Notifications.NotificationBuilder withHideDelayMs(int hideDelayMs)

Sets the delay before the notification disappears.

Parameters:

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

getHideDelayMs

int getHideDelayMs()

Returns:

the delay before the notification disappears in milliseconds

withCloseListener

Notifications.NotificationBuilder withCloseListener(java.util.function.Consumer<Notifications.CloseEvent> closeListener)

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

Parameters:

closeListener - Notifications.CloseEvent consumer

Returns:

this

show

void show()

Shows notification.