com.vaadin.client.ui
Class VFilterSelect.SuggestionPopup

java.lang.Object
  PopupPanel
      com.vaadin.client.widgets.Overlay
          com.vaadin.client.ui.VOverlay
              com.vaadin.client.ui.VFilterSelect.SuggestionPopup

All Implemented Interfaces:

com.google.gwt.event.logical.shared.CloseHandler<PopupPanel>, com.google.gwt.event.shared.EventHandler

Enclosing class:

VFilterSelect

public class VFilterSelect.SuggestionPopup
extends VOverlay
implements com.google.gwt.event.logical.shared.CloseHandler<PopupPanel>

Represents the popup box with the selection options. Wraps a suggestion menu.

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.client.widgets.Overlay

Overlay.PositionAndSize, Overlay.ResizeAnimation

Field Summary

VFilterSelect.SuggestionMenu

menu For internal use only.

Fields inherited from class com.vaadin.client.ui.VOverlay

ac, current

Fields inherited from class com.vaadin.client.widgets.Overlay

ADDITIONAL_CLASSNAME_ANIMATE_IN, ADDITIONAL_CLASSNAME_ANIMATE_OUT, CLASSNAME_CONTAINER, CLASSNAME_SHADOW

Method Summary

boolean	isJustClosed() Was the popup just closed?
void	onBrowserEvent(Event event)
void	onClose(com.google.gwt.event.logical.shared.CloseEvent<PopupPanel> event)
protected void	onLoad()
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(java.util.Collection<VFilterSelect.FilterSelectSuggestion> currentSuggestions, int currentPage, int totalSuggestions) Shows the popup where the user can see the filtered options
void	updateStyleNames(UIDL uidl, com.vaadin.shared.AbstractComponentState componentState) Updates style names in suggestion popup to help theme building.

Methods inherited from class com.vaadin.client.ui.VOverlay

getApplicationConnection, getOverlayContainer, getOverlayContainer, setOverlayContainerLabel

Methods inherited from class com.vaadin.client.widgets.Overlay

center, getOwner, hide, hide, hide, isShadowEnabled, isShimElementEnabled, isSinkShadowEvents, needsShimElement, onAttach, onDetach, positionOrSizeUpdated, setHeight, setOwner, setPopupPosition, setShadowEnabled, setShadowStyle, setSinkShadowEvents, setVisible, setWidth, setZIndex, show, sinkEvents, updateShadowSizeAndPosition, useShadowDiv

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.logical.shared.CloseHandler

onClose

Field Detail

menu

public final VFilterSelect.SuggestionMenu menu

For internal use only. May be removed or replaced in the future.

Method Detail

onLoad

protected void onLoad()

onUnload

protected void onUnload()

showSuggestions

public void showSuggestions(java.util.Collection<VFilterSelect.FilterSelectSuggestion> currentSuggestions,
                            int currentPage,
                            int totalSuggestions)

Shows the popup where the user can see the filtered options

Parameters:

currentSuggestions - The filtered suggestions

currentPage - The current page number

totalSuggestions - The total amount of suggestions

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(Event event)

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)

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<PopupPanel> event)

Overrides:

onClose in class Overlay

updateStyleNames

public void updateStyleNames(UIDL uidl,
                             com.vaadin.shared.AbstractComponentState componentState)

Updates style names in suggestion popup to help theme building.

Parameters:

uidl - UIDL for the whole combo box

componentState - shared state of the combo box