com.vaadin.client.ui.

Class VOverlay

  • java.lang.Object
    • com.google.gwt.user.client.ui.UIObject
      • com.google.gwt.user.client.ui.Widget
        • com.google.gwt.user.client.ui.Panel

  • 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.HasVisibility, 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>

    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<com.google.gwt.user.client.ui.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.google.gwt.user.client.ui.PopupPanel

        com.google.gwt.user.client.ui.PopupPanel.AnimationType, 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

    • Constructor Summary

      Constructors
      Constructor and Description
      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

      All Methods
      Modifier and Type Method and Description
      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, String overlayContainerLabel)

      Deprecated. 

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

      • Methods inherited from class com.google.gwt.user.client.ui.PopupPanel

        addAutoHidePartner, addCloseHandler, addPopupListener, getAnimationType, getContainerElement, getGlassElement, getGlassStyleName, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getStyleElement, getTitle, isAnimationEnabled, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, isGlassEnabled, isModal, isPreviewingAllNativeEvents, isShowing, isVisible, onEventPreview, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, onPreviewNativeEvent, onUnload, removeAutoHidePartner, removePopupListener, setAnimationEnabled, setAnimationType, 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, clear, 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, onBrowserEvent, onLoad, removeFromParent, setLayoutData, unsinkEvents

      • 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, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, toString

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

        onClose

      • Methods inherited from interface com.google.gwt.event.shared.HasHandlers

        fireEvent

    • 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

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