de.swm.commons.mobile.client.widgets

Class NotificationBox

java.lang.Object

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

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

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

de.swm.commons.mobile.client.widgets.NotificationBox

All Implemented Interfaces:

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.HasWidgets, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, IsSWMMobileWidget, Iterable<com.google.gwt.user.client.ui.Widget>

public class NotificationBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.HasWidgets, IsSWMMobileWidget

A notification box wich displays a message at the botton of the Page. Will showup for 5 seconds and fadeout automatically after this time period. Useag NotificationBox.showPopupDialog(container, "Message1", "Message2");

Author:

Daniel Wiese

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gwt.user.client.ui.Anchor	closeButton
protected NotificationBoxCss	css
static NotificationBox	HIGH_LANDER There should only be one NotificationBox!
protected com.google.gwt.user.client.ui.HasWidgets	panelToOverlay
protected com.google.gwt.user.client.ui.FlowPanel	slideUpPanel

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
NotificationBox() Construct a popin dialog

Method Summary

Methods

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget w)
void	addText(String toAdd) Wil show the notificationf or 5 secs.
void	clear()
com.google.gwt.user.client.ui.HasWidgets	getPanelToOverlay() get the panel that the dialog overlays
boolean	isVisible() Returns true if this notification is currently visible.
Iterator<com.google.gwt.user.client.ui.Widget>	iterator()
void	onInitialLoad() When the widget is loaded first time.
void	onTransitionEnd() When an transition containing this widget ends.
boolean	remove(com.google.gwt.user.client.ui.Widget w)
void	setPanelToOverlay(com.google.gwt.user.client.ui.HasWidgets widgetToCover) Set the area to cover
void	setSecondaryStyle(String style) Will set the secondary style.
void	showCloseButton(boolean show, com.google.gwt.user.client.ui.HasWidgets containerForThisWidget) Defines if the notificationbox should have a close button or not.
static void	showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget, int fadeInAfter, int fadeOutAfter, boolean showCloseButton, String... messages) Will display a notification box, which will fade in and out after a specified time and defines if it should have a close button or not.
static void	showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget, int fadeInAfter, int fadeOutAfter, String... messages) Will display a notification box, which will fade in and out after a specified time.
static void	showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget, String... messages) Will dispay a notification for 5 seconds and hide it again.

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, unsinkEvents

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, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Field Detail

HIGH_LANDER

public static NotificationBox HIGH_LANDER

There should only be one NotificationBox!

slideUpPanel

protected final com.google.gwt.user.client.ui.FlowPanel slideUpPanel

panelToOverlay

protected com.google.gwt.user.client.ui.HasWidgets panelToOverlay

css

protected final NotificationBoxCss css

closeButton

protected final com.google.gwt.user.client.ui.Anchor closeButton

Constructor Detail

NotificationBox

public NotificationBox()

Construct a popin dialog

Method Detail

addText

public void addText(String toAdd)

Wil show the notificationf or 5 secs.

Parameters:

toAdd -

add

public void add(com.google.gwt.user.client.ui.Widget w)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

clear

public void clear()

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

iterator

public Iterator<com.google.gwt.user.client.ui.Widget> iterator()

Specified by:

iterator in interface com.google.gwt.user.client.ui.HasWidgets

Specified by:

iterator in interface Iterable<com.google.gwt.user.client.ui.Widget>

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

setPanelToOverlay

public void setPanelToOverlay(com.google.gwt.user.client.ui.HasWidgets widgetToCover)

Set the area to cover

Parameters:

widgetToCover - the widet to cover

getPanelToOverlay

public com.google.gwt.user.client.ui.HasWidgets getPanelToOverlay()

get the panel that the dialog overlays

Returns:

the panel that is overlayed by this dialog

isVisible

public boolean isVisible()

Returns true if this notification is currently visible.

Specified by:

isVisible in interface com.google.gwt.user.client.ui.HasVisibility

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

true if visible

onInitialLoad

public void onInitialLoad()

When the widget is loaded first time.

Specified by:

onInitialLoad in interface IsSWMMobileWidget

onTransitionEnd

public void onTransitionEnd()

When an transition containing this widget ends.

Specified by:

onTransitionEnd in interface IsSWMMobileWidget

setSecondaryStyle

public void setSecondaryStyle(String style)

Will set the secondary style.

Specified by:

setSecondaryStyle in interface IsSWMMobileWidget

Parameters:

style - the style to set.

showCloseButton

public void showCloseButton(boolean show,
                   com.google.gwt.user.client.ui.HasWidgets containerForThisWidget)

Defines if the notificationbox should have a close button or not.

Parameters:

show - .

containerForThisWidget - .

showPopupDialog

public static void showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget,
                   String... messages)

Will dispay a notification for 5 seconds and hide it again.

Parameters:

containerForThisWidget - the container (may outer HTML pannel of a Page)

messages - messages to display

showPopupDialog

public static void showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget,
                   int fadeInAfter,
                   int fadeOutAfter,
                   String... messages)

Will display a notification box, which will fade in and out after a specified time.

Parameters:

containerForThisWidget - -

fadeInAfter - .

fadeOutAfter - .

messages - .

showPopupDialog

public static void showPopupDialog(com.google.gwt.user.client.ui.HasWidgets containerForThisWidget,
                   int fadeInAfter,
                   int fadeOutAfter,
                   boolean showCloseButton,
                   String... messages)

Will display a notification box, which will fade in and out after a specified time and defines if it should have a close button or not.

Parameters:

containerForThisWidget - .

fadeInAfter - .

fadeOutAfter - .

showCloseButton - .

messages - .