Contact us
Create app
com.vaadin.client.ui.

Class VPopupView

  • java.lang.Object
    • com.google.gwt.user.client.ui.UIObject
      • com.google.gwt.user.client.ui.Widget
        • com.google.gwt.user.client.ui.LabelBase<String>
          • com.google.gwt.user.client.ui.Label
            • com.google.gwt.user.client.ui.HTML
              • com.vaadin.client.ui.VPopupView

  • All Implemented Interfaces:

    com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<String>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.client.HasDirection, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAutoHorizontalAlignment, com.google.gwt.user.client.ui.HasDirectionalHtml, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, DeferredWorker, Iterable<com.google.gwt.user.client.ui.Widget>

    public class VPopupView
extends com.google.gwt.user.client.ui.HTML
implements com.google.gwt.user.client.ui.HasEnabled, Iterable<com.google.gwt.user.client.ui.Widget>, DeferredWorker

    Widget class for the PopupView component.

    Author:

    Vaadin Ltd

    • Nested Class Summary

      Nested Classes
      Modifier and Type Class Description
      class  VPopupView.CustomPopup

      This class is only public to enable overriding showPopup, and is currently not intended to be extended or otherwise used directly.

      • 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.i18n.client.HasDirection

        com.google.gwt.i18n.client.HasDirection.Direction

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

        com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

    • Field Summary

      Fields
      Modifier and Type Field Description
      static String CLASSNAME

      Default classname for this widget.
      ApplicationConnection client

      For internal use only.
      boolean hostPopupVisible

      Helps to communicate popup visibility to the server.
      VPopupView.CustomPopup popup

      For internal use only.
      String uidlId

      For server-client communication.

      • Fields inherited from class com.google.gwt.user.client.ui.Label

        DEFAULT_DIRECTION_ESTIMATOR

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

        DEBUG_ID_PREFIX

      • Fields inherited from interface com.google.gwt.user.client.ui.HasAutoHorizontalAlignment

        ALIGN_CONTENT_END, ALIGN_CONTENT_START

      • Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

        ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

    • Constructor Summary

      Constructors
      Constructor Description
      VPopupView()

      Loading constructor.

    • Method Summary

      All Methods
      Modifier and Type Method Description
      com.google.gwt.event.shared.HandlerRegistration addVisibilityChangeHandler​(VisibilityChangeHandler visibilityChangeHandler)

      Adds the given visibility change handler to this widget.
      void center()

      For internal use only.
      boolean isEnabled()

      Returns true if the popup is enabled, false if not.
      boolean isWorkPending()

      Checks whether there are operations pending for this widget that must be executed before reaching a steady state.
      Iterator<com.google.gwt.user.client.ui.Widget> iterator()  
      protected void onDetach()

      Make sure that we remove the popup when the main widget is removed.
      void preparePopup​(VPopupView.CustomPopup popup)

      For internal use only.
      void setEnabled​(boolean enabled)

      Sets whether this popup is enabled.
      void showPopup​(VPopupView.CustomPopup popup)

      Determines the correct position for a popup and displays the popup at that position.

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

        getHTML, getTextOrHtml, setHTML, setHTML, setHTML, setHTML, wrap

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

        addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, asEditor, getDirection, getText, getTextDirection, removeClickListener, removeMouseListener, removeMouseWheelListener, setDirection, setText, setText

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

        getAutoHorizontalAlignment, getDirectionEstimator, getHorizontalAlignment, getWordWrap, setAutoHorizontalAlignment, setDirectionEstimator, setDirectionEstimator, setHorizontalAlignment, setWordWrap, updateHorizontalAlignment

      • 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, isAttached, isOrWasAttached, onAttach, onBrowserEvent, 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, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

      • Methods inherited from interface com.google.gwt.user.client.ui.HasDirectionalText

        getTextDirection, setText

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

        fireEvent

      • Methods inherited from interface com.google.gwt.user.client.ui.HasText

        getText, setText

    • Field Detail

      • uidlId

        public String uidlId

        For server-client communication.

        For internal use only. May be removed or replaced in the future.

      • client

        public ApplicationConnection client

        For internal use only. May be removed or replaced in the future.

      • hostPopupVisible

        public boolean hostPopupVisible

        Helps to communicate popup visibility to the server.

        For internal use only. May be removed or replaced in the future.

      • popup

        public final VPopupView.CustomPopup popup

        For internal use only. May be removed or replaced in the future.

    • Constructor Detail

      • VPopupView

        public VPopupView()

        Loading constructor.

    • Method Detail

      • preparePopup

        public void preparePopup​(VPopupView.CustomPopup popup)

        For internal use only. May be removed or replaced in the future.

        Parameters:

        popup - the popup that should be shown

      • showPopup

        public void showPopup​(VPopupView.CustomPopup popup)

        Determines the correct position for a popup and displays the popup at that position. By default, the popup is shown centered relative to its host component, ensuring it is visible on the screen if possible. Can be overridden to customize the popup position.

        Parameters:

        popup - the popup whose position should be updated

      • center

        public void center()

        For internal use only. May be removed or replaced in the future.

      • onDetach

        protected void onDetach()

        Make sure that we remove the popup when the main widget is removed.

        Overrides:

        onDetach in class com.google.gwt.user.client.ui.Widget

        See Also:

        Widget.onUnload()

      • isEnabled

        public boolean isEnabled()

        Returns true if the popup is enabled, false if not.

        Specified by:

        isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

        Since:

        7.3.4

      • setEnabled

        public void setEnabled​(boolean enabled)

        Sets whether this popup is enabled.

        Specified by:

        setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

        Parameters:

        enabled - true to enable the popup, false to disable it

        Since:

        7.3.4

      • addVisibilityChangeHandler

        public com.google.gwt.event.shared.HandlerRegistration addVisibilityChangeHandler​(VisibilityChangeHandler visibilityChangeHandler)

        Adds the given visibility change handler to this widget.

        Parameters:

        visibilityChangeHandler - the handler that should be triggered when visibility changes

        Returns:

        the registration object for removing the given handler when no longer needed

      • iterator

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

        Specified by:

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

      • isWorkPending

        public boolean isWorkPending()

        Checks whether there are operations pending for this widget that must be executed before reaching a steady state.

        Specified by:

        isWorkPending in interface DeferredWorker

        Since:

        7.3.4