com.vaadin.client.ui

Class VComboBox.SuggestionMenu

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.vaadin.client.ui.menubar.MenuBar

com.vaadin.client.ui.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

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.

Nested Class Summary

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

Field Summary

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

DEBUG_ID_PREFIX

Method Summary

Modifier and Type	Method and Description
void	actOnEnteredValueAfterFiltering(String enteredItemValue) Create/select a suggestion based on the used entered string.
void	fixHeightTo(int pageItemsCount) Fixes menus height to use same space as full page would use.
com.google.gwt.user.client.Element	getSubPartElement(String subPart) Locates an element inside a component using the identifier provided in subPart.
String	getSubPartName(com.google.gwt.user.client.Element subElement) Provides an identifier that identifies the element within the component.
void	highlightSelectedItem() Highlight (select) an item matching the current text box content without triggering its action.
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).
void	markNewItemsHandled(String handledNewItem)
void	onLoad(com.google.gwt.event.dom.client.LoadEvent event)
void	selectFirstItem() Deprecated. use VComboBox.SuggestionPopup.selectFirstItem() instead.
void	selectLastItem() Deprecated. use VComboBox.SuggestionPopup.selectLastItem() instead.
void	setSuggestions(Collection<VComboBox.ComboBoxSuggestion> suggestions) Sets the suggestions rendered in the menu.

Methods inherited from class com.vaadin.client.ui.menubar.MenuBar

addItem, addItem, addItem, addItem, addItem, clearItems, doItemAction, getAutoOpen, getFirstItem, getItems, getLastItem, getPreferredHeight, getSelectedIndex, getSelectedItem, onBrowserEvent, onDetach, onPopupClosed, removeItem, scrollSelectionIntoView, selectItem, setAutoOpen, setScrollEnabled

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, 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

selectFirstItem

@Deprecated
public void selectFirstItem()

Deprecated. use VComboBox.SuggestionPopup.selectFirstItem() instead.

selectLastItem

@Deprecated
public void selectLastItem()

Deprecated. use VComboBox.SuggestionPopup.selectLastItem() instead.

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)