Package com.vaadin.client.ui
Class VFilterSelect.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.VFilterSelect.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:
- VFilterSelect
public class VFilterSelect.SuggestionMenu extends MenuBar implements SubPartAware, com.google.gwt.event.dom.client.LoadHandler
The menu where the suggestions are rendered
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voiddoPostFilterSelectedItemAction()Triggered after a selection has been madevoiddoSelectedItemAction()Send the current selection to the server.voidfixHeightTo(int pageItemsCount)Fixes menus height to use same space as full page would use.com.google.gwt.user.client.ElementgetSubPartElement(String subPart)Locates an element inside a component using the identifier provided insubPart.StringgetSubPartName(com.google.gwt.user.client.Element subElement)Provides an identifier that identifies the element within the component.booleanisScrollActive()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).voidonLoad(com.google.gwt.event.dom.client.LoadEvent event)voidselectFirstItem()Deprecated.useVFilterSelect.SuggestionPopup.selectFirstItem()instead.voidselectLastItem()Deprecated.useVFilterSelect.SuggestionPopup.selectLastItem()instead.voidsetSuggestions(Collection<VFilterSelect.FilterSelectSuggestion> 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
-
-
-
-
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<VFilterSelect.FilterSelectSuggestion> suggestions)
Sets the suggestions rendered in the menu- Parameters:
suggestions- The suggestions to be rendered in the menu
-
doSelectedItemAction
public void doSelectedItemAction()
Send the current selection to the server. Triggered when a selection is made or on a blur event.
-
doPostFilterSelectedItemAction
public void doPostFilterSelectedItemAction()
Triggered after a selection has been made
-
getSubPartElement
public com.google.gwt.user.client.Element getSubPartElement(String subPart)
Description copied from interface:SubPartAwareLocates an element inside a component using the identifier provided insubPart. ThesubPartidentifier is component specific and may be any string of characters, numbers, space characters and brackets.- Specified by:
getSubPartElementin interfaceSubPartAware- 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:SubPartAwareProvides an identifier that identifies the element within the component. ThesubElementis a part of the component and must never be null.Note!
getSubPartElement(getSubPartName(element)) == elementis not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions withsubElementare 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 assubElementbecause interactions with the DIV and the root button element produce the same result.- Specified by:
getSubPartNamein interfaceSubPartAware- Parameters:
subElement- The element the identifier string should uniquely identify- Returns:
- An identifier that uniquely identifies
subElementor null if no identifier could be provided.
-
onLoad
public void onLoad(com.google.gwt.event.dom.client.LoadEvent event)
- Specified by:
onLoadin interfacecom.google.gwt.event.dom.client.LoadHandler
-
selectFirstItem
@Deprecated public void selectFirstItem()
Deprecated.useVFilterSelect.SuggestionPopup.selectFirstItem()instead.
-
selectLastItem
@Deprecated public void selectLastItem()
Deprecated.useVFilterSelect.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:
isScrollActivein classMenuBar- Returns:
- true if the scroll is active, otherwise false.
- Since:
- 7.2.6
-
-