Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public static interface

SearchView.OnQueryTextListener

android.widget.SearchView.OnQueryTextListener

Class Overview

Callbacks for changes to the query text.

Summary

Public Methods
abstract boolean onQueryTextChange ( String newText)
Called when the query text is changed by the user.
abstract boolean onQueryTextSubmit ( String query)
Called when the user submits the query.

Public Methods

public abstract boolean onQueryTextChange ( String newText)

Called when the query text is changed by the user.

Parameters
newText the new content of the query text field.
Returns
  • false if the SearchView should perform the default action of showing any suggestions if available, true if the action was handled by the listener.

public abstract boolean onQueryTextSubmit ( String query)

Called when the user submits the query. This could be due to a key press on the keyboard or due to pressing a submit button. The listener can override the standard behavior by returning true to indicate that it has handled the submit request. Otherwise return false to let the SearchView handle the submission by launching any associated intent.

Parameters
query the query text that is to be submitted
Returns
  • true if the query has been handled by the listener, false to let the SearchView perform the default action.