io.jmix.ui.component

Interface NotificationFacet

All Superinterfaces:

Facet

All Known Implementing Classes:

NotificationFacetImpl

@StudioFacet(xmlElement="notification",
             caption="Notification",
             description="Prepares and shows notifications",
             defaultProperty="caption",
             category="Facets",
             icon="io/jmix/ui/icon/facet/notification.svg")
public interface NotificationFacet
extends Facet

Prepares and shows notifications.

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addCloseListener(java.util.function.Consumer<Notifications.CloseEvent> listener) Adds the given Consumer as notification Notifications.CloseEvent listener.
java.lang.String	getActionTarget()
java.lang.String	getButtonTarget()
java.lang.String	getCaption()
java.util.function.Supplier<java.lang.String>	getCaptionProvider()
ContentMode	getContentMode()
int	getDelay()
java.lang.String	getDescription()
java.util.function.Supplier<java.lang.String>	getDescriptionProvider()
Notifications.Position	getPosition()
java.lang.String	getStyleName()
Notifications.NotificationType	getType()
boolean	isHtmlSanitizerEnabled()
void	setActionTarget(java.lang.String actionId) Sets that notification should be shown when action with id actionId is performed.
void	setButtonTarget(java.lang.String buttonId) Sets that notification should be shown when button with id actionId is clicked.
void	setCaption(java.lang.String caption) Sets notification caption.
void	setCaptionProvider(java.util.function.Supplier<java.lang.String> captionProvider) Sets the given Supplier as notification caption provider.
void	setContentMode(ContentMode contentMode) Sets notification content mode.
void	setDelay(int delayMs) Sets the delay before the notification disappears.
void	setDescription(java.lang.String description) Sets notification description.
void	setDescriptionProvider(java.util.function.Supplier<java.lang.String> descriptionProvider) Sets the given Supplier as notification description provider.
void	setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled) Sets whether html sanitizer is enabled or not for notification content.
void	setPosition(Notifications.Position position) Sets notification position.
void	setStyleName(java.lang.String styleName) Sets notification style name.
void	setType(Notifications.NotificationType type) Sets notification type.
void	show() Shows notification.

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId, setOwner

Method Detail

setCaption

@StudioProperty(type=LOCALIZED_STRING)
void setCaption(@Nullable
                                                       java.lang.String caption)

Sets notification caption.

Parameters:

caption - caption

getCaption

@Nullable
java.lang.String getCaption()

Returns:

notification caption

setDescription

@StudioProperty(type=LOCALIZED_STRING)
void setDescription(@Nullable
                                                           java.lang.String description)

Sets notification description.

Parameters:

description - description

getDescription

@Nullable
java.lang.String getDescription()

Returns:

notification description

setDelay

@StudioProperty
 @PositiveOrZero
void setDelay(int delayMs)

Sets the delay before the notification disappears.

Parameters:

delayMs - the desired delay in milliseconds

getDelay

int getDelay()

Returns:

the delay before the notification disappears

setType

@StudioProperty(type=ENUMERATION,
                defaultValue="HUMANIZED")
void setType(Notifications.NotificationType type)

Sets notification type.

Parameters:

type - type

getType

Notifications.NotificationType getType()

Returns:

notification type

setContentMode

@StudioProperty(type=ENUMERATION,
                defaultValue="TEXT",
                options={"HTML","TEXT"})
void setContentMode(ContentMode contentMode)

Sets notification content mode.

Parameters:

contentMode - content mode

getContentMode

ContentMode getContentMode()

Returns:

notification content mode

setStyleName

@StudioProperty(name="stylename",
                type=CSS_CLASSNAME_LIST)
void setStyleName(java.lang.String styleName)

Sets notification style name.

Parameters:

styleName - style name

getStyleName

@Nullable
java.lang.String getStyleName()

Returns:

notification style name

setPosition

@StudioProperty(type=ENUMERATION,
                defaultValue="DEFAULT")
void setPosition(Notifications.Position position)

Sets notification position.

Parameters:

position - position

getPosition

Notifications.Position getPosition()

Returns:

notification position

getActionTarget

@Nullable
java.lang.String getActionTarget()

Returns:

id of action that triggers notification

setActionTarget

@StudioProperty(name="onAction",
                type=COMPONENT_REF,
                options="io.jmix.ui.action.Action")
void setActionTarget(@Nullable
                                                                                                                                              java.lang.String actionId)

Sets that notification should be shown when action with id actionId is performed.

Parameters:

actionId - action id

getButtonTarget

@Nullable
java.lang.String getButtonTarget()

Returns:

id of button that triggers notification

setButtonTarget

@StudioProperty(name="onButton",
                type=COMPONENT_REF,
                options="io.jmix.ui.component.Button")
void setButtonTarget(@Nullable
                                                                                                                                                 java.lang.String buttonId)

Sets that notification should be shown when button with id actionId is clicked.

Parameters:

buttonId - button id

setHtmlSanitizerEnabled

@StudioProperty(type=BOOLEAN,
                defaultValue="true")
void setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)

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

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

isHtmlSanitizerEnabled

boolean isHtmlSanitizerEnabled()

Returns:

html sanitizer is enabled for notification content

show

void show()

Shows notification.

setCaptionProvider

void setCaptionProvider(@Nullable
                        java.util.function.Supplier<java.lang.String> captionProvider)

Sets the given Supplier as notification caption provider.

Parameters:

captionProvider - notification caption provider

getCaptionProvider

@Nullable
java.util.function.Supplier<java.lang.String> getCaptionProvider()

Returns:

notification caption provider

setDescriptionProvider

void setDescriptionProvider(@Nullable
                            java.util.function.Supplier<java.lang.String> descriptionProvider)

Sets the given Supplier as notification description provider.

Parameters:

descriptionProvider - notification description provider

getDescriptionProvider

@Nullable
java.util.function.Supplier<java.lang.String> getDescriptionProvider()

Returns:

notification description provider

addCloseListener

io.jmix.core.common.event.Subscription addCloseListener(java.util.function.Consumer<Notifications.CloseEvent> listener)

Adds the given Consumer as notification Notifications.CloseEvent listener.

Parameters:

listener - close event listener

Returns:

close event subscription