Package com.google.gwt.user.client.ui

Class AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay

java.lang.Object
com.google.gwt.user.client.ui.AbstractSuggestBoxNewEditor.SuggestionDisplay
com.google.gwt.user.client.ui.AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay
All Implemented Interfaces:
com.google.gwt.user.client.ui.HasAnimation
Enclosing class:
AbstractSuggestBoxNewEditor
public static class AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay extends AbstractSuggestBoxNewEditor.SuggestionDisplay implements com.google.gwt.user.client.ui.HasAnimation

The default implementation of AbstractSuggestBoxNewEditor.SuggestionDisplay displays suggestions in a PopupPanel beneath the AbstractSuggestBoxNewEditor.

CSS Style Rules

.gwt-SuggestBoxPopup
the suggestion popup
.gwt-SuggestBoxPopup .item
an unselected suggestion
.gwt-SuggestBoxPopup .item-selected
a selected suggestion
.gwt-SuggestBoxPopup .suggestPopupTopLeft
the top left cell
.gwt-SuggestBoxPopup .suggestPopupTopLeftInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupTopCenter
the top center cell
.gwt-SuggestBoxPopup .suggestPopupTopCenterInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupTopRight
the top right cell
.gwt-SuggestBoxPopup .suggestPopupTopRightInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupMiddleLeft
the middle left cell
.gwt-SuggestBoxPopup .suggestPopupMiddleLeftInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupMiddleCenter
the middle center cell
.gwt-SuggestBoxPopup .suggestPopupMiddleCenterInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupMiddleRight
the middle right cell
.gwt-SuggestBoxPopup .suggestPopupMiddleRightInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupBottomLeft
the bottom left cell
.gwt-SuggestBoxPopup .suggestPopupBottomLeftInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupBottomCenter
the bottom center cell
.gwt-SuggestBoxPopup .suggestPopupBottomCenterInner
the inner element of the cell
.gwt-SuggestBoxPopup .suggestPopupBottomRight
the bottom right cell
.gwt-SuggestBoxPopup .suggestPopupBottomRightInner
the inner element of the cell

  • Constructor Details

  • Method Details

    • hideSuggestions

      public void hideSuggestions()
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Hide the list of suggestions from view.
      Specified by:
      hideSuggestions in class AbstractSuggestBoxNewEditor.SuggestionDisplay

    • isAnimationEnabled

      public boolean isAnimationEnabled()
      Specified by:
      isAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

    • isSuggestionListHiddenWhenEmpty

      public boolean isSuggestionListHiddenWhenEmpty()
      Check whether or not the suggestion list is hidden when there are no suggestions to display.
      Returns:
      true if hidden when empty, false if not

    • isSuggestionListShowing

      public boolean isSuggestionListShowing()
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Check whether or not the list of suggestions is being shown.
      Overrides:
      isSuggestionListShowing in class AbstractSuggestBoxNewEditor.SuggestionDisplay
      Returns:
      true if the suggestions are visible, false if not

    • setAnimationEnabled

      public void setAnimationEnabled(boolean enable)
      Specified by:
      setAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

    • setPopupStyleName

      public void setPopupStyleName(String style)
      Sets the style name of the suggestion popup.
      Parameters:
      style - the new primary style name
      See Also:
      • UIObject.setStyleName(String)

    • setPositionRelativeTo

      public void setPositionRelativeTo(com.google.gwt.user.client.ui.UIObject uiObject)
      Sets the UI object where the suggestion display should appear next to.
      Parameters:
      uiObject - the uiObject used for positioning, or null to position relative to the suggest box

    • setSuggestionListHiddenWhenEmpty

      public void setSuggestionListHiddenWhenEmpty(boolean hideWhenEmpty)
      Set whether or not the suggestion list should be hidden when there are no suggestions to display. Defaults to true.
      Parameters:
      hideWhenEmpty - true to hide when empty, false not to

    • createPopup

      protected com.google.gwt.user.client.ui.PopupPanel createPopup()
      Create the PopupPanel that will hold the list of suggestions.
      Returns:
      the popup panel

    • decorateSuggestionList

      protected com.google.gwt.user.client.ui.Widget decorateSuggestionList(com.google.gwt.user.client.ui.Widget suggestionList)
      Wrap the list of suggestions before adding it to the popup. You can override this method if you want to wrap the suggestion list in a decorator.
      Parameters:
      suggestionList - the widget that contains the list of suggestions
      Returns:
      the suggestList, optionally inside of a wrapper

    • getCurrentSelection

      protected com.google.gwt.user.client.ui.SuggestOracle.Suggestion getCurrentSelection()
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Get the currently selected SuggestOracle.Suggestion in the display.
      Specified by:
      getCurrentSelection in class AbstractSuggestBoxNewEditor.SuggestionDisplay
      Returns:
      the current suggestion, or null if none selected

    • getPopupPanel

      protected com.google.gwt.user.client.ui.PopupPanel getPopupPanel()
      Get the PopupPanel used to display suggestions.
      Returns:
      the popup panel

    • getSuggestionMenu

      protected com.google.gwt.user.client.ui.MenuBar getSuggestionMenu()
      Get the MenuBar used to display suggestions.
      Returns:
      the suggestions menu

    • moveSelectionDown

      protected void moveSelectionDown()
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Highlight the suggestion directly below the current selection in the list.
      Specified by:
      moveSelectionDown in class AbstractSuggestBoxNewEditor.SuggestionDisplay

    • moveSelectionUp

      protected void moveSelectionUp()
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Highlight the suggestion directly above the current selection in the list.
      Specified by:
      moveSelectionUp in class AbstractSuggestBoxNewEditor.SuggestionDisplay

    • onEnsureDebugId

      protected void onEnsureDebugId(String baseID)
      Affected Elements.
      • -popup = The popup that appears with suggestions.
      • -item# = The suggested item at the specified index.
      Overrides:
      onEnsureDebugId in class AbstractSuggestBoxNewEditor.SuggestionDisplay
      Parameters:
      baseID - the baseID of the AbstractSuggestBoxNewEditor
      See Also:
      • UIObject.onEnsureDebugId(String)

    • showSuggestions

      protected void showSuggestions(AbstractSuggestBoxNewEditor suggestBox, Collection<? extends com.google.gwt.user.client.ui.SuggestOracle.Suggestion> suggestions, boolean isDisplayStringHtml, boolean isAutoSelectEnabled, AbstractSuggestBoxNewEditor.SuggestionCallback callback)
      Description copied from class: AbstractSuggestBoxNewEditor.SuggestionDisplay
      Update the list of visible suggestions.

      Use care when using isDisplayStringHtml; it is an easy way to expose script-based security problems.

      Specified by:
      showSuggestions in class AbstractSuggestBoxNewEditor.SuggestionDisplay
      Parameters:
      suggestBox - the suggest box where the suggestions originated
      suggestions - the suggestions to show
      isDisplayStringHtml - should the suggestions be displayed as HTML
      isAutoSelectEnabled - if true, the first item should be selected automatically
      callback - the callback used when the user makes a suggestion