Package io.jmix.ui.component.impl

Class NotificationFacetImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.NotificationFacetImpl

All Implemented Interfaces:

Facet, NotificationFacet

public class NotificationFacetImpl
extends AbstractFacet
implements NotificationFacet

Field Summary

Fields

Modifier and Type	Field	Description
protected String	actionId
protected String	buttonId
protected String	caption
protected Supplier<String>	captionProvider
protected List<Consumer<Notifications.CloseEvent>>	closeListeners
protected ContentMode	contentMode
protected int	delayMs
protected String	description
protected Supplier<String>	descriptionProvider
protected boolean	htmlSanitizerEnabled
protected Notifications.Position	position
protected String	styleName
protected Notifications.NotificationType	type

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor	Description
NotificationFacetImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addCloseListener(Consumer<Notifications.CloseEvent> listener)	Adds the given Consumer as notification Notifications.CloseEvent listener.
String	getActionTarget()
String	getButtonTarget()
String	getCaption()
Supplier<String>	getCaptionProvider()
ContentMode	getContentMode()
int	getDelay()
String	getDescription()
Supplier<String>	getDescriptionProvider()
Notifications.Position	getPosition()
String	getStyleName()
Notifications.NotificationType	getType()
protected void	internalRemoveCloseListener(Consumer<Notifications.CloseEvent> listener)
boolean	isHtmlSanitizerEnabled()
void	setActionTarget(String actionId)	Sets that notification should be shown when action with id actionId is performed.
void	setButtonTarget(String buttonId)	Sets that notification should be shown when button with id actionId is clicked.
void	setCaption(String caption)	Sets notification caption.
void	setCaptionProvider(Supplier<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(String description)	Sets notification description.
void	setDescriptionProvider(Supplier<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	setOwner(Frame owner)	Sets owner frame (Window or Fragment) to the facet.
void	setPosition(Notifications.Position position)	Sets notification position.
void	setStyleName(String styleName)	Sets notification style name.
void	setType(Notifications.NotificationType type)	Sets notification type.
void	show()	Shows notification.
protected void	subscribe()
protected void	subscribeOnAction(Frame owner)
protected void	subscribeOnButton(Frame owner)

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

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

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

getId, getOwner, setId

Field Details

caption

protected String caption

description

protected String description

delayMs

protected int delayMs

styleName

protected String styleName

type

protected Notifications.NotificationType type

contentMode

protected ContentMode contentMode

position

protected Notifications.Position position

captionProvider

protected Supplier<String> captionProvider

descriptionProvider

protected Supplier<String> descriptionProvider

closeListeners

protected List<Consumer<Notifications.CloseEvent>> closeListeners

actionId

protected String actionId

buttonId

protected String buttonId

htmlSanitizerEnabled

protected boolean htmlSanitizerEnabled

Constructor Details

NotificationFacetImpl

public NotificationFacetImpl()

Method Details

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: NotificationFacet

Sets notification caption.

Specified by:

setCaption in interface NotificationFacet

Parameters:

caption - caption

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface NotificationFacet

Returns:

notification caption

setDescription

public void setDescription(@Nullable
 String description)

Description copied from interface: NotificationFacet

Sets notification description.

Specified by:

setDescription in interface NotificationFacet

Parameters:

description - description

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface NotificationFacet

Returns:

notification description

setType

public void setType(Notifications.NotificationType type)

Description copied from interface: NotificationFacet

Sets notification type.

Specified by:

setType in interface NotificationFacet

Parameters:

type - type

getType

public Notifications.NotificationType getType()

Specified by:

getType in interface NotificationFacet

Returns:

notification type

setDelay

public void setDelay(int delayMs)

Description copied from interface: NotificationFacet

Sets the delay before the notification disappears.

Specified by:

setDelay in interface NotificationFacet

Parameters:

delayMs - the desired delay in milliseconds

getDelay

public int getDelay()

Specified by:

getDelay in interface NotificationFacet

Returns:

the delay before the notification disappears

setContentMode

public void setContentMode(ContentMode contentMode)

Description copied from interface: NotificationFacet

Sets notification content mode.

Specified by:

setContentMode in interface NotificationFacet

Parameters:

contentMode - content mode

getContentMode

public ContentMode getContentMode()

Specified by:

getContentMode in interface NotificationFacet

Returns:

notification content mode

setStyleName

public void setStyleName(String styleName)

Description copied from interface: NotificationFacet

Sets notification style name.

Specified by:

setStyleName in interface NotificationFacet

Parameters:

styleName - style name

getStyleName

@Nullable
public String getStyleName()

Specified by:

getStyleName in interface NotificationFacet

Returns:

notification style name

setPosition

public void setPosition(Notifications.Position position)

Description copied from interface: NotificationFacet

Sets notification position.

Specified by:

setPosition in interface NotificationFacet

Parameters:

position - position

getPosition

public Notifications.Position getPosition()

Specified by:

getPosition in interface NotificationFacet

Returns:

notification position

addCloseListener

public Subscription addCloseListener(Consumer<Notifications.CloseEvent> listener)

Description copied from interface: NotificationFacet

Adds the given Consumer as notification Notifications.CloseEvent listener.

Specified by:

addCloseListener in interface NotificationFacet

Parameters:

listener - close event listener

Returns:

close event subscription

internalRemoveCloseListener

protected void internalRemoveCloseListener(Consumer<Notifications.CloseEvent> listener)

setCaptionProvider

public void setCaptionProvider(@Nullable
 Supplier<String> captionProvider)

Description copied from interface: NotificationFacet

Sets the given Supplier as notification caption provider.

Specified by:

setCaptionProvider in interface NotificationFacet

Parameters:

captionProvider - notification caption provider

getCaptionProvider

@Nullable
public Supplier<String> getCaptionProvider()

Specified by:

getCaptionProvider in interface NotificationFacet

Returns:

notification caption provider

setDescriptionProvider

public void setDescriptionProvider(@Nullable
 Supplier<String> descriptionProvider)

Description copied from interface: NotificationFacet

Sets the given Supplier as notification description provider.

Specified by:

setDescriptionProvider in interface NotificationFacet

Parameters:

descriptionProvider - notification description provider

getDescriptionProvider

@Nullable
public Supplier<String> getDescriptionProvider()

Specified by:

getDescriptionProvider in interface NotificationFacet

Returns:

notification description provider

getActionTarget

@Nullable
public String getActionTarget()

Specified by:

getActionTarget in interface NotificationFacet

Returns:

id of action that triggers notification

setActionTarget

public void setActionTarget(@Nullable
 String actionId)

Description copied from interface: NotificationFacet

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

Specified by:

setActionTarget in interface NotificationFacet

Parameters:

actionId - action id

getButtonTarget

@Nullable
public String getButtonTarget()

Specified by:

getButtonTarget in interface NotificationFacet

Returns:

id of button that triggers notification

setButtonTarget

public void setButtonTarget(@Nullable
 String buttonId)

Description copied from interface: NotificationFacet

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

Specified by:

setButtonTarget in interface NotificationFacet

Parameters:

buttonId - button id

setHtmlSanitizerEnabled

public void setHtmlSanitizerEnabled(boolean htmlSanitizerEnabled)

Description copied from interface: NotificationFacet

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

Specified by:

setHtmlSanitizerEnabled in interface NotificationFacet

Parameters:

htmlSanitizerEnabled - specifies whether html sanitizer is enabled

isHtmlSanitizerEnabled

public boolean isHtmlSanitizerEnabled()

Specified by:

isHtmlSanitizerEnabled in interface NotificationFacet

Returns:

html sanitizer is enabled for notification content

setOwner

public void setOwner(@Nullable
 Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

show

public void show()

Description copied from interface: NotificationFacet

Shows notification.

Specified by:

show in interface NotificationFacet

subscribe

protected void subscribe()

subscribeOnAction

protected void subscribeOnAction(Frame owner)

subscribeOnButton

protected void subscribeOnButton(Frame owner)