com.alkacon.geranium.client.ui

Class Notification

java.lang.Object

com.alkacon.geranium.client.ui.Notification

public final class Notification
extends java.lang.Object

User feedback provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Mode Notification Mode.
static class	Notification.Type Notification Type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANIMATION_DURATION The duration of the animations.

Method Summary

Methods

Modifier and Type	Method and Description
static Notification	get() Returns the singleton instance.
I_NotificationWidget	getWidget() Returns the widget.
boolean	hasWidget() Returns if the notification widget is set.
void	hide() Hides the notification message.
void	send(Notification.Type type, java.lang.String message) Sends a new notification.
void	sendBlocking(Notification.Type type, java.lang.String message) Sends a new blocking notification.
void	sendDeferred(Notification.Type type, java.lang.String message) Sends a new notification after all other events have been processed.
void	sendSticky(Notification.Type type, java.lang.String message) Sends a new sticky notification.
void	setWidget(I_NotificationWidget widget) Sets the widget.
static boolean	shouldRestoreMessage(Notification.Mode oldMode, Notification.Mode newMode, Notification.Type oldType, Notification.Type newType) Returns if the message of the old mode and type needs to be restored after a new message has been shown.

Methods inherited from class java.lang.Object

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

Field Detail

ANIMATION_DURATION

public static final int ANIMATION_DURATION

The duration of the animations.

See Also:

Constant Field Values

Method Detail

get

public static Notification get()

Returns the singleton instance.

Returns:

the singleton instance

shouldRestoreMessage

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

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

Parameters:

oldMode - the old mode

newMode - the new mode

oldType - the old type

newType - the new type

Returns:

true if the message needs to be restored

getWidget

public I_NotificationWidget getWidget()

Returns the widget.

Returns:

the widget

hasWidget

public boolean 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

hide

public void hide()

Hides the notification message.

send

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

Sends a new notification.

Parameters:

type - the notification type

message - the message

sendBlocking

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

Sends a new blocking notification.

Parameters:

type - the notification type

message - the message

sendDeferred

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

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

Parameters:

type - the notification type

message - the message

sendSticky

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

Sends a new sticky notification.

Parameters:

type - the notification type

message - the message

setWidget

public void setWidget(I_NotificationWidget widget)

Sets the widget.

Parameters:

widget - the widget to set