com.atlassian.gwt
Interface QuickSearchSupport

All Known Implementing Classes:

QuickSearchInputField

public interface QuickSearchSupport

Provides an interface for an input widget to expose quick search functionality to the presentation layer.

Author:

Agens Ro, Ryan Ackley

Method Summary

void	bindDropDown(DropDownHandler handler) Sets the default query parameters for the quick search and adds a listener for js events called by the quick search.
void	cancelDropDown() Prevents the down down from showing, if any.
void	clearSearchCache() Clears the search cache used by the quick search dropdown.
boolean	dropDownHasFocus()
void	hideDropDown() Hides the current drop down, if any.
boolean	isDropDownOpen()

Method Detail

bindDropDown

void bindDropDown(DropDownHandler handler)

Sets the default query parameters for the quick search and adds a listener for js events called by the quick search.

Parameters:

handler - This is the event handler that does something when a user makes a selection from the quick search results.

hideDropDown

void hideDropDown()

Hides the current drop down, if any.

isDropDownOpen

boolean isDropDownOpen()

Returns:

true if the quick search drop down is visible

dropDownHasFocus

boolean dropDownHasFocus()

Returns:

true if there is a selection active in the drop down

cancelDropDown

void cancelDropDown()

Prevents the down down from showing, if any.

clearSearchCache

void clearSearchCache()

Clears the search cache used by the quick search dropdown. The cache is only based on the search query text so this needs to be cleared when any other search parameter changes (like the space key)