to top
Android APIs
public static abstract class

SearchViewCompat.OnQueryTextListenerCompat

extends Object
java.lang.Object
   ↳ android.support.v4.widget.SearchViewCompat.OnQueryTextListenerCompat

Class Overview

Callbacks for changes to the query text.

Summary

Public Constructors

? Examples
SearchViewCompat.OnQueryTextListenerCompat()
Public Methods

? Examples
boolean onQueryTextChange( String newText)
Called when the query text is changed by the user.

? Examples
boolean onQueryTextSubmit( String query)
Called when the user submits the query.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SearchViewCompat.OnQueryTextListenerCompat ()

Public Methods

public 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 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.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.