Stay organized with collections
Save and categorize content based on your preferences.
SearchView.OnQueryTextListener
public
static
interface
SearchView.OnQueryTextListener
android.widget.SearchView.OnQueryTextListener
|
Callbacks for changes to the query text.
Summary
Public methods
onQueryTextChange
public abstract boolean onQueryTextChange (String newText)
Called when the query text is changed by the user.
Parameters |
newText |
String : the new content of the query text field. |
Returns |
boolean |
false if the SearchView should perform the default action of showing any
suggestions if available, true if the action was handled by the listener. |
onQueryTextSubmit
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 |
String : the query text that is to be submitted |
Returns |
boolean |
true if the query has been handled by the listener, false to let the
SearchView perform the default action. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# SearchView.OnQueryTextListener\n\nAdded in [API level 11](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nSearchView.OnQueryTextListener\n==============================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/widget/SearchView.OnQueryTextListener \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\n\n\ninterface\nSearchView.OnQueryTextListener\n`\n\n\n`\n\n\n`\n\n|-----------------------------------------------|\n| android.widget.SearchView.OnQueryTextListener |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nCallbacks for changes to the query text.\n\nSummary\n-------\n\n| ### Public methods ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract boolean` | ` `[onQueryTextChange](/reference/android/widget/SearchView.OnQueryTextListener#onQueryTextChange(java.lang.String))`(`[String](/reference/java/lang/String)` newText) ` Called when the query text is changed by the user. |\n| ` abstract boolean` | ` `[onQueryTextSubmit](/reference/android/widget/SearchView.OnQueryTextListener#onQueryTextSubmit(java.lang.String))`(`[String](/reference/java/lang/String)` query) ` Called when the user submits the query. |\n\nPublic methods\n--------------\n\n### onQueryTextChange\n\nAdded in [API level 11](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract boolean onQueryTextChange (String newText)\n```\n\nCalled when the query text is changed by the user.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------|-----------------------------------------------------------|\n| `newText` | `String`: the new content of the query text field. \u003cbr /\u003e |\n\n| Returns ||\n|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `boolean` | false if the SearchView should perform the default action of showing any suggestions if available, true if the action was handled by the listener. \u003cbr /\u003e |\n\n### onQueryTextSubmit\n\nAdded in [API level 11](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract boolean onQueryTextSubmit (String query)\n```\n\nCalled when the user submits the query. This could be due to a key press on the\nkeyboard or due to pressing a submit button.\nThe listener can override the standard behavior by returning true\nto indicate that it has handled the submit request. Otherwise return false to\nlet the SearchView handle the submission by launching any associated intent.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|---------------------------------------------------------|\n| `query` | `String`: the query text that is to be submitted \u003cbr /\u003e |\n\n| Returns ||\n|-----------|--------------------------------------------------------------------------------------------------------------------|\n| `boolean` | true if the query has been handled by the listener, false to let the SearchView perform the default action. \u003cbr /\u003e |"]]