org.opencms.gwt.client.ui

类 CmsNotification

java.lang.Object

org.opencms.gwt.client.ui.CmsNotification

public final class CmsNotification
extends java.lang.Object

User feedback provider.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsNotification.Mode Notification Mode.
static class	CmsNotification.Type Notification Type.

字段概要

字段

限定符和类型	字段和说明
static int	ANIMATION_DURATION The duration of the animations.

方法概要

方法

限定符和类型	方法和说明
static CmsNotification	get() Returns the singleton instance.
I_CmsNotificationWidget	getWidget() Returns the widget.
boolean	hasWidget() Returns if the notification widget is set.
void	hide() Hides the notification message.
void	send(CmsNotification.Type type, java.lang.String message) Sends a new notification.
void	sendBlocking(CmsNotification.Type type, java.lang.String message) Sends a new blocking notification.
void	sendDeferred(CmsNotification.Type type, java.lang.String message) Sends a new notification after all other events have been processed.
void	sendSticky(CmsNotification.Type type, java.lang.String message) Sends a new sticky notification.
void	setWidget(I_CmsNotificationWidget widget) Sets the widget.
static boolean	shouldRestoreMessage(CmsNotification.Mode oldMode, CmsNotification.Mode newMode, CmsNotification.Type oldType, CmsNotification.Type newType) Returns if the message of the old mode and type needs to be restored after a new message has been shown.

从类继承的方法 java.lang.Object

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

字段详细资料

ANIMATION_DURATION

public static final int ANIMATION_DURATION

The duration of the animations.

另请参阅:

常量字段值

方法详细资料

get

public static CmsNotification get()

Returns the singleton instance.

返回:

the singleton instance

shouldRestoreMessage

public static boolean shouldRestoreMessage(CmsNotification.Mode oldMode,
                           CmsNotification.Mode newMode,
                           CmsNotification.Type oldType,
                           CmsNotification.Type newType)

Returns if the message of the old mode and type needs to be restored after a new message has been shown.

参数:

oldMode - the old mode

newMode - the new mode

oldType - the old type

newType - the new type

返回:

true if the message needs to be restored

getWidget

public I_CmsNotificationWidget getWidget()

Returns the widget.

返回:

the widget

hasWidget

public boolean hasWidget()

Returns if the notification widget is set. Only if the widget is set, notifications can be shown.

返回:

true if the notification widget is set

hide

public void hide()

Hides the notification message.

send

public void send(CmsNotification.Type type,
        java.lang.String message)

Sends a new notification.

参数:

type - the notification type

message - the message

sendBlocking

public void sendBlocking(CmsNotification.Type type,
                java.lang.String message)

Sends a new blocking notification.

参数:

type - the notification type

message - the message

sendDeferred

public void sendDeferred(CmsNotification.Type type,
                java.lang.String message)

Sends a new notification after all other events have been processed.

参数:

type - the notification type

message - the message

sendSticky

public void sendSticky(CmsNotification.Type type,
              java.lang.String message)

Sends a new sticky notification.

参数:

type - the notification type

message - the message

setWidget

public void setWidget(I_CmsNotificationWidget widget)

Sets the widget.

参数:

widget - the widget to set