com.vaadin.client.ui
Class VOverlay

java.lang.Object
  PopupPanel
      com.vaadin.client.widgets.Overlay
          com.vaadin.client.ui.VOverlay

All Implemented Interfaces:

com.google.gwt.event.logical.shared.CloseHandler<PopupPanel>, com.google.gwt.event.shared.EventHandler

Direct Known Subclasses:

DefaultReconnectDialog, VContextMenu, VDebugWindow, VDebugWindow.Menu, VFilterSelect.SuggestionPopup, VNotification, VPopupView.CustomPopup, VTooltip, VWindow

Deprecated. as this is specifically for Vaadin only, it should not be used directly.

@Deprecated
public class VOverlay
extends Overlay
implements com.google.gwt.event.logical.shared.CloseHandler<PopupPanel>

In Vaadin UI this VOverlay should always be used for all elements that temporary float over other components like context menus etc. This is to deal stacking order correctly with VWindow objects.

To use this correctly, use GWT#create(Class) to create the Overlay superclass and the default widgetset will replace it with this. The widget will not be dependent on this Vaadin specific widget and can be used in a pure GWT environment.

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.client.widgets.Overlay

Overlay.PositionAndSize, Overlay.ResizeAnimation

Field Summary

protected ApplicationConnection	ac Deprecated.
protected static VOverlay	current Deprecated.

Fields inherited from class com.vaadin.client.widgets.Overlay

ADDITIONAL_CLASSNAME_ANIMATE_IN, ADDITIONAL_CLASSNAME_ANIMATE_OUT, CLASSNAME_CONTAINER, CLASSNAME_SHADOW, Z_INDEX

Constructor Summary

VOverlay()
Deprecated.

VOverlay(boolean autoHide)
Deprecated.

VOverlay(boolean autoHide, boolean modal)
Deprecated.

VOverlay(boolean autoHide, boolean modal, boolean showShadow)
Deprecated. See main JavaDoc for VOverlay. Use the other constructors without the showShadow parameter.

Method Summary

protected ApplicationConnection	getApplicationConnection() Deprecated. Get the ApplicationConnection that this overlay belongs to.
com.google.gwt.user.client.Element	getOverlayContainer() Deprecated. Gets the 'overlay container' element.
static com.google.gwt.user.client.Element	getOverlayContainer(ApplicationConnection ac) Deprecated. Gets the 'overlay container' element pertaining to the given ApplicationConnection.
static void	setOverlayContainerLabel(ApplicationConnection applicationConnection, java.lang.String overlayContainerLabel) Deprecated. Set the label of the container element, where tooltip, notification and dialgs are added to.

Methods inherited from class com.vaadin.client.widgets.Overlay

center, getOwner, hide, hide, hide, isShadowEnabled, isShimElementEnabled, isSinkShadowEvents, needsShimElement, onAttach, onClose, onDetach, positionOrSizeUpdated, setHeight, setOwner, setPopupPosition, setShadowEnabled, setShadowStyle, setSinkShadowEvents, setVisible, setWidth, setZIndex, show, sinkEvents, updateShadowSizeAndPosition, useShadowDiv

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.logical.shared.CloseHandler

onClose

Field Detail

ac

protected ApplicationConnection ac

Deprecated.

current

protected static VOverlay current

Deprecated.

Constructor Detail

VOverlay

public VOverlay()

Deprecated.

VOverlay

public VOverlay(boolean autoHide)

Deprecated.

VOverlay

public VOverlay(boolean autoHide,
                boolean modal)

Deprecated.

VOverlay

@Deprecated
public VOverlay(boolean autoHide,
                           boolean modal,
                           boolean showShadow)

Deprecated. See main JavaDoc for VOverlay. Use the other constructors without the showShadow parameter.

Method Detail

getApplicationConnection

protected ApplicationConnection getApplicationConnection()

Deprecated.

Get the ApplicationConnection that this overlay belongs to. If it's not set, Overlay.getOwner() is used to figure it out.

Returns:

getOverlayContainer

public com.google.gwt.user.client.Element getOverlayContainer()

Deprecated.

Gets the 'overlay container' element. Tries to find the current ApplicationConnection using getApplicationConnection().

Overrides:

getOverlayContainer in class Overlay

Returns:

the overlay container element for the current ApplicationConnection or another element if the current ApplicationConnection cannot be determined.

getOverlayContainer

public static com.google.gwt.user.client.Element getOverlayContainer(ApplicationConnection ac)

Deprecated.

Gets the 'overlay container' element pertaining to the given ApplicationConnection. Each overlay should be created in a overlay container element, so that the correct theme and styles can be applied.

Parameters:

ac - A reference to ApplicationConnection

Returns:

The overlay container

setOverlayContainerLabel

public static void setOverlayContainerLabel(ApplicationConnection applicationConnection,
                                            java.lang.String overlayContainerLabel)

Deprecated.

Set the label of the container element, where tooltip, notification and dialgs are added to.

Parameters:

applicationConnection - the application connection for which to change the label

overlayContainerLabel - label for the container