com.alkacon.geranium.client.ui

Class A_NotificationWidget

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.alkacon.geranium.client.ui.A_NotificationWidget

All Implemented Interfaces:

I_NotificationWidget, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

DialogNotificationWidget, ToolbarNotificationWidget

public abstract class A_NotificationWidget
extends com.google.gwt.user.client.ui.Composite
implements I_NotificationWidget

The notification widget.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
A_NotificationWidget()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	animateHide() Animates the notification out of view.
protected abstract void	animateShow() Animates the notification into view.
protected A_Animation	getAnimation() Returns the currently running animation.
protected abstract java.lang.String	getMessage() Returns the current notification message.
Notification.Mode	getMode() Returns the mode.
com.google.gwt.user.client.Timer	getTimer() Returns the timer.
Notification.Type	getType() Returns the type.
void	hide() Hides the widget.
protected void	hide(boolean force) Hides the notification message.
protected abstract void	onHideComplete() Execute when hiding is complete.
protected abstract void	onShowComplete() Execute when notification is completely visible.
protected void	setAnimation(A_Animation animation) Sets the currently running animation.
protected abstract void	setClassForType(Notification.Type type) Sets the appropriate css class for the given type.
protected abstract void	setMessage(java.lang.String message) Sets the current notification message.
void	show(Notification.Mode mode, Notification.Type type, java.lang.String message) Sets the notification.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alkacon.geranium.client.ui.I_NotificationWidget

setBlocking

Constructor Detail

A_NotificationWidget

public A_NotificationWidget()

Method Detail

getMode

public Notification.Mode getMode()

Returns the mode.

Returns:

the mode

getTimer

public com.google.gwt.user.client.Timer getTimer()

Returns the timer.

Returns:

the timer

getType

public Notification.Type getType()

Returns the type.

Returns:

the type

hide

public void hide()

Description copied from interface: I_NotificationWidget

Hides the widget.

Specified by:

hide in interface I_NotificationWidget

See Also:

I_NotificationWidget.hide()

show

public void show(Notification.Mode mode,
        Notification.Type type,
        java.lang.String message)

Description copied from interface: I_NotificationWidget

Sets the notification.

Specified by:

show in interface I_NotificationWidget

Parameters:

mode - the current notification mode

type - the notification type

message - the message to set

See Also:

I_NotificationWidget.show(com.alkacon.geranium.client.ui.Notification.Mode, com.alkacon.geranium.client.ui.Notification.Type, java.lang.String)

animateHide

protected abstract void animateHide()

Animates the notification out of view.

animateShow

protected abstract void animateShow()

Animates the notification into view.

getAnimation

protected A_Animation getAnimation()

Returns the currently running animation.

Returns:

the animation

getMessage

protected abstract java.lang.String getMessage()

Returns the current notification message.

Returns:

the notification message

hide

protected void hide(boolean force)

Hides the notification message.

Parameters:

force - if true will also hide the message if mode is fixed

onHideComplete

protected abstract void onHideComplete()

Execute when hiding is complete.

onShowComplete

protected abstract void onShowComplete()

Execute when notification is completely visible.

setAnimation

protected void setAnimation(A_Animation animation)

Sets the currently running animation.

Parameters:

animation - the animation

setClassForType

protected abstract void setClassForType(Notification.Type type)

Sets the appropriate css class for the given type.

Parameters:

type - the message type

setMessage

protected abstract void setMessage(java.lang.String message)

Sets the current notification message.

Parameters:

message - the notification message