Package com.vaadin.client.ui

Class VComboBox.SuggestionMenu

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.LoadHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.PopupListener, SubPartAware, EventListener
    Enclosing class:
    VComboBox
    public class VComboBox.SuggestionMenu
extends MenuBar
implements SubPartAware, com.google.gwt.event.dom.client.LoadHandler
    The menu where the suggestions are rendered.

    • Method Detail

      • fixHeightTo

        public void fixHeightTo​(int pageItemsCount)
        Fixes menus height to use same space as full page would use. Needed to avoid height changes when quickly "scrolling" to last page.

      • setSuggestions

        public void setSuggestions​(Collection<VComboBox.ComboBoxSuggestion> suggestions)
        Sets the suggestions rendered in the menu.
        Parameters:
        suggestions - The suggestions to be rendered in the menu

      • selectItem

        public void selectItem​(MenuItem item)
        Description copied from class: MenuBar
        Moves the selection to the given item and scrolls it into view. If the given item is null, previous selection is removed but no scrolling will happen.
        Overrides:
        selectItem in class MenuBar
        Parameters:
        item - the item to select

      • actOnEnteredValueAfterFiltering

        public void actOnEnteredValueAfterFiltering​(String enteredItemValue)
        Create/select a suggestion based on the used entered string. This method is called after filtering has completed with the given string.
        Parameters:
        enteredItemValue - user entered string

      • getSubPartElement

        public com.google.gwt.user.client.Element getSubPartElement​(String subPart)
        Description copied from interface: SubPartAware
        Locates an element inside a component using the identifier provided in subPart. The subPart identifier is component specific and may be any string of characters, numbers, space characters and brackets.
        Specified by:
        getSubPartElement in interface SubPartAware
        Parameters:
        subPart - The identifier for the element inside the component
        Returns:
        The element identified by subPart or null if the element could not be found.

      • getSubPartName

        public String getSubPartName​(com.google.gwt.user.client.Element subElement)
        Description copied from interface: SubPartAware
        Provides an identifier that identifies the element within the component. The subElement is a part of the component and must never be null.

        Note! getSubPartElement(getSubPartName(element)) == element is not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions with subElement are the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed as subElement because interactions with the DIV and the root button element produce the same result.

        Specified by:
        getSubPartName in interface SubPartAware
        Parameters:
        subElement - The element the identifier string should uniquely identify
        Returns:
        An identifier that uniquely identifies subElement or null if no identifier could be provided.

      • onLoad

        public void onLoad​(com.google.gwt.event.dom.client.LoadEvent event)
        Specified by:
        onLoad in interface com.google.gwt.event.dom.client.LoadHandler

      • isScrollActive

        public boolean isScrollActive()
        Returns true if the scroll is active on the menu element or if the menu currently displays the last page with less items then the maximum visibility (in which case the scroll is not active, but the scroll is active for any other page in general).
        Overrides:
        isScrollActive in class MenuBar
        Returns:
        true if the scroll is active, otherwise false.
        Since:
        7.2.6

      • highlightSelectedItem

        public void highlightSelectedItem()
        Highlight (select) an item matching the current text box content without triggering its action.

      • markNewItemsHandled

        public void markNewItemsHandled​(String handledNewItem)