Package org.opencms.gwt.client.ui
Class CmsNotification
java.lang.Object
org.opencms.gwt.client.ui.CmsNotification
User feedback provider.
- Since:
- 8.0.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Notification Mode.static enum
Notification Type. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The duration of the animations. -
Method Summary
Modifier and TypeMethodDescriptionstatic CmsNotification
get()
Returns the singleton instance.Returns the widget.boolean
Returns if the notification widget is set.void
removeMessage
(CmsNotificationMessage message) Removes the given notification message.void
send
(CmsNotification.Type type, String message) Sends a new notification, that will be removed automatically.void
sendAlert
(CmsNotification.Type type, String message) Sends a new blocking alert notification that can be closed by the user.sendBusy
(CmsNotification.Type type, String message) Sends a new blocking notification that can not be removed by the user.void
sendDeferred
(CmsNotification.Type type, String message) Sends a new notification after all other events have been processed.sendSticky
(CmsNotification.Type type, String message) Sends a new sticky notification that can not be removed by the user.void
setWidget
(I_CmsNotificationWidget widget) Sets the widget.
-
Field Details
-
ANIMATION_DURATION
The duration of the animations.- See Also:
-
-
Method Details
-
get
Returns the singleton instance.- Returns:
- the singleton instance
-
getWidget
Returns the widget.- Returns:
- the widget
-
hasWidget
Returns if the notification widget is set. Only if the widget is set, notifications can be shown.- Returns:
true
if the notification widget is set
-
removeMessage
Removes the given notification message.- Parameters:
message
- the message to remove
-
send
Sends a new notification, that will be removed automatically.- Parameters:
type
- the notification typemessage
- the message
-
sendAlert
Sends a new blocking alert notification that can be closed by the user.- Parameters:
type
- the notification typemessage
- the message
-
sendBusy
Sends a new blocking notification that can not be removed by the user.- Parameters:
type
- the notification typemessage
- the message- Returns:
- the message, use to hide the message
-
sendDeferred
Sends a new notification after all other events have been processed.- Parameters:
type
- the notification typemessage
- the message
-
sendSticky
Sends a new sticky notification that can not be removed by the user.- Parameters:
type
- the notification typemessage
- the message- Returns:
- the message, use to hide the message
-
setWidget
Sets the widget.- Parameters:
widget
- the widget to set
-