com.vaadin.terminal.gwt.client.ui.


Class VNotification

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.SimplePanel
                  com.google.gwt.user.client.ui.PopupPanel
                      com.vaadin.terminal.gwt.client.ui.VOverlay
                          com.vaadin.terminal.gwt.client.ui.VNotification

All Implemented Interfaces:

com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.EventPreview, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesPopupEvents, Iterable<com.google.gwt.user.client.ui.Widget>

public class VNotification
extends VOverlay

Nested Class Summary
static interface VNotification.EventListener
           
 class VNotification.HideEvent
           
 
Nested classes/interfaces inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay
VOverlay.PositionAndSize, VOverlay.ResizeAnimation
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.PopupPanel
com.google.gwt.user.client.ui.PopupPanel.PositionCallback
 
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
static int BOTTOM_LEFT
           
static int BOTTOM_RIGHT
           
static int CENTERED
           
static int CENTERED_BOTTOM
           
static int CENTERED_TOP
           
static int DELAY_FOREVER
           
static int DELAY_NONE
           
static String STYLE_SYSTEM
           
static int TOP_LEFT
           
static int TOP_RIGHT
           
 
Fields inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay
CLASSNAME_SHADOW, Z_INDEX
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
VNotification()
          Default constructor.
VNotification(int delayMsec)
          Deprecated. Use static createNotification(int) instead to enable GWT deferred binding.
VNotification(int delayMsec, int fadeMsec, int startOpacity)
          Deprecated. Use static #createNotification(int, int, int) instead to enable GWT deferred binding.
 
Method Summary
 void addEventListener(VNotification.EventListener listener)
           
static void bringNotificationsToFront()
          Moves currently visible notifications to the top of the event preview stack.
static VNotification createNotification(int delayMsec)
           
 void fade()
           
 void hide()
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
           
 boolean onEventPreview(com.google.gwt.user.client.Event event)
           
 void removeEventListener(VNotification.EventListener listener)
           
 void setPosition(int position)
           
 void show()
           
 void show(int position)
           
 void show(int position, String style)
           
 void show(String style)
           
 void show(String html, int position, String style)
           
 void show(com.google.gwt.user.client.ui.Widget widget, int position, String style)
           
static void showNotification(ApplicationConnection client, UIDL notification)
           
 void startDelay()
           
 
Methods inherited from class com.vaadin.terminal.gwt.client.ui.VOverlay
hide, isShadowEnabled, isSinkShadowEvents, needsShimElement, onClose, onDetach, positionOrSizeUpdated, setHeight, setPopupPosition, setShadowEnabled, setShadowStyle, setSinkShadowEvents, setVisible, setWidth, setZIndex, sinkEvents, updateShadowSizeAndPosition
 
Methods inherited from class com.google.gwt.user.client.ui.PopupPanel
addAutoHidePartner, addCloseHandler, addPopupListener, center, getContainerElement, getGlassElement, getGlassStyleName, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getStyleElement, getTitle, isAnimationEnabled, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, isGlassEnabled, isModal, isPreviewingAllNativeEvents, isShowing, isVisible, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, onPreviewNativeEvent, onUnload, removeAutoHidePartner, removePopupListener, setAnimationEnabled, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled, setGlassEnabled, setGlassStyleName, setModal, setPopupPositionAndShow, setPreviewingAllNativeEvents, setTitle, setWidget, showRelativeTo
 
Methods inherited from class com.google.gwt.user.client.ui.SimplePanel
add, getWidget, iterator, remove, setWidget
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onLoad, removeFromParent, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, 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.google.gwt.event.shared.HasHandlers
fireEvent
 

Field Detail

CENTERED

public static final int CENTERED

See Also:

Constant Field Values

CENTERED_TOP

public static final int CENTERED_TOP

See Also:

Constant Field Values

CENTERED_BOTTOM

public static final int CENTERED_BOTTOM

See Also:

Constant Field Values

TOP_LEFT

public static final int TOP_LEFT

See Also:

Constant Field Values

TOP_RIGHT

public static final int TOP_RIGHT

See Also:

Constant Field Values

BOTTOM_LEFT

public static final int BOTTOM_LEFT

See Also:

Constant Field Values

BOTTOM_RIGHT

public static final int BOTTOM_RIGHT

See Also:

Constant Field Values

DELAY_FOREVER

public static final int DELAY_FOREVER

See Also:

Constant Field Values

DELAY_NONE

public static final int DELAY_NONE

See Also:

Constant Field Values

STYLE_SYSTEM

public static final String STYLE_SYSTEM

See Also:

Constant Field Values

Constructor Detail

VNotification

public VNotification()

Default constructor. You should use GWT.create instead.

VNotification

@Deprecated
public VNotification(int delayMsec)

Deprecated. Use static createNotification(int) instead to enable GWT deferred binding.

Parameters:
delayMsec -

VNotification

@Deprecated
public VNotification(int delayMsec,
                                int fadeMsec,
                                int startOpacity)

Deprecated. Use static #createNotification(int, int, int) instead to enable GWT deferred binding.

Parameters:
delayMsec -
fadeMsec -
startOpacity -

Method Detail

startDelay

public void startDelay()

show

public void show()

Overrides:
show in class VOverlay

show

public void show(String style)

show

public void show(int position)

show

public void show(com.google.gwt.user.client.ui.Widget widget,
                 int position,
                 String style)

show

public void show(String html,
                 int position,
                 String style)

show

public void show(int position,
                 String style)

hide

public void hide()

Overrides:
hide in class com.google.gwt.user.client.ui.PopupPanel

fade

public void fade()

setPosition

public void setPosition(int position)

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class com.google.gwt.user.client.ui.Widget

onEventPreview

public boolean onEventPreview(com.google.gwt.user.client.Event event)

Specified by:
onEventPreview in interface com.google.gwt.user.client.EventPreview
Overrides:
onEventPreview in class com.google.gwt.user.client.ui.PopupPanel

addEventListener

public void addEventListener(VNotification.EventListener listener)

removeEventListener

public void removeEventListener(VNotification.EventListener listener)

showNotification

public static void showNotification(ApplicationConnection client,
                                    UIDL notification)

createNotification

public static VNotification createNotification(int delayMsec)

bringNotificationsToFront

public static void bringNotificationsToFront()

Moves currently visible notifications to the top of the event preview stack. Can be called when opening other overlays such as subwindows to ensure the notifications receive the events they need and don't linger indefinitely. See #7136. TODO Should this be a generic Overlay feature instead?