Package com.vaadin.client.ui

Class VComboBox.SuggestionPopup

  • 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.PopupPanel.PositionCallback, com.google.gwt.user.client.ui.SourcesPopupEvents, Iterable<com.google.gwt.user.client.ui.Widget>
    Enclosing class:
    VComboBox
    public class VComboBox.SuggestionPopup
extends VOverlay
implements com.google.gwt.user.client.ui.PopupPanel.PositionCallback, com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>
    Represents the popup box with the selection options. Wraps a suggestion menu.

    • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void hide()  
      boolean isJustClosed()
      Was the popup just closed?
      void onBrowserEvent​(com.google.gwt.user.client.Event event)  
      void onClose​(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)  
      protected void onLoad()  
      protected void onPreviewNativeEvent​(com.google.gwt.user.client.Event.NativePreviewEvent event)  
      protected void onUnload()  
      void selectFirstItem()
      Select the first item of the suggestions list popup.
      void selectLastItem()
      Select the last item of the suggestions list popup.
      void selectNextItem()
      Selects the next item in the filtered selections.
      void selectPrevItem()
      Selects the previous item in the filtered selections.
      void setPagingEnabled​(boolean paging)
      Should paging be enabled.
      void setPosition​(int offsetWidth, int offsetHeight)  
      void showSuggestions​(int currentPage)
      Shows the popup where the user can see the filtered options that have been set with a call to VComboBox.SuggestionMenu.setSuggestions(Collection).
      void updateStyleNames​(AbstractComponentState componentState)
      Updates style names in suggestion popup to help theme building.

      • 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, 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, removeFromParent, setLayoutData, sinkEvents, 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.shared.HasHandlers

        fireEvent

    • Method Detail

      • onLoad

        protected void onLoad()
        Overrides:
        onLoad in class com.google.gwt.user.client.ui.Widget

      • onUnload

        protected void onUnload()
        Overrides:
        onUnload in class com.google.gwt.user.client.ui.PopupPanel

      • hide

        public void hide()
        Overrides:
        hide in class Overlay

      • showSuggestions

        public void showSuggestions​(int currentPage)
        Shows the popup where the user can see the filtered options that have been set with a call to VComboBox.SuggestionMenu.setSuggestions(Collection).
        Parameters:
        currentPage - The current page number

      • selectNextItem

        public void selectNextItem()
        Selects the next item in the filtered selections.

      • selectPrevItem

        public void selectPrevItem()
        Selects the previous item in the filtered selections.

      • selectFirstItem

        public void selectFirstItem()
        Select the first item of the suggestions list popup.
        Since:
        7.2.6

      • selectLastItem

        public void selectLastItem()
        Select the last item of the suggestions list popup.
        Since:
        7.2.6

      • 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

      • onPreviewNativeEvent

        protected void onPreviewNativeEvent​(com.google.gwt.user.client.Event.NativePreviewEvent event)
        Overrides:
        onPreviewNativeEvent in class com.google.gwt.user.client.ui.PopupPanel

      • setPagingEnabled

        public void setPagingEnabled​(boolean paging)
        Should paging be enabled. If paging is enabled then only a certain amount of items are visible at a time and a scrollbar or buttons are visible to change page. If paging is turned of then all options are rendered into the popup menu.
        Parameters:
        paging - Should the paging be turned on?

      • setPosition

        public void setPosition​(int offsetWidth,
                        int offsetHeight)
        Specified by:
        setPosition in interface com.google.gwt.user.client.ui.PopupPanel.PositionCallback

      • isJustClosed

        public boolean isJustClosed()
        Was the popup just closed?
        Returns:
        true if popup was just closed

      • onClose

        public void onClose​(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)
        Specified by:
        onClose in interface com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>

      • updateStyleNames

        public void updateStyleNames​(AbstractComponentState componentState)
        Updates style names in suggestion popup to help theme building.
        Parameters:
        componentState - shared state of the combo box