How do I capture SearchView's clear button click?

Question

How can I capture the event of user click on clear SearchView text by clicking on the X button on the right

I already captured onQueryTextChange event but, this is for any text change not for that X button

I am also looking for an answer to this question. Anyone has a link because I searched for the past few hours on google and I couldn't find anything. — Sitram, Jul 19 '14 at 09:50

score 118 · Accepted Answer · answered Jul 19 '14 at 21:03

After trying a lot of combinations, I found how to capture the event behind the X button in SearchView

Below is a code snippet from onCreateOptionsMenu function in one of my apps. mSearchMenu and mSearchView are global variables. The X is actually an ImageView with ID search_close_btn and the text area is an EditText view with ID search_src_text

@SuppressLint("NewApi")
    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu items for use in the action bar
        MenuInflater inflater = getMenuInflater();
        inflater.inflate(R.menu.country_list_activity_actions, menu);
        mSearchMenu = menu.findItem(R.id.action_search);

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) {
            // Get the SearchView and set the searchable configuration
            SearchManager searchManager = (SearchManager) getSystemService(Context.SEARCH_SERVICE);
            mSearchView = (SearchView) menu.findItem(R.id.action_search).getActionView();

            // Assumes current activity is the searchable activity
            mSearchView.setSearchableInfo(searchManager.getSearchableInfo(getComponentName()));
            mSearchView.setIconifiedByDefault(false); // Do not iconify the widget; expand it by default

            // Get the search close button image view
            ImageView closeButton = (ImageView)mSearchView.findViewById(R.id.search_close_btn);

            // Set on click listener
            closeButton.setOnClickListener(new View.OnClickListener() {

                @Override
                public void onClick(View v) {
                    LoggerUtils.d(LOG, "Search close button clicked");
                    //Find EditText view
                    EditText et = (EditText) findViewById(R.id.search_src_text);

                    //Clear the text from EditText view
                    et.setText("");

                    //Clear query
                    mSearchView.setQuery("", false);
                    //Collapse the action view
                    mSearchView.onActionViewCollapsed();
                    //Collapse the search widget
                    mSearchMenu.collapseActionView();
                }
            });
        }

        // When using the support library, the setOnActionExpandListener() method is
        // static and accepts the MenuItem object as an argument
        mSearchMenu.setOnActionExpandListener(new OnActionExpandListener() {

            @Override
            public boolean onMenuItemActionExpand(MenuItem item) {
                //Nothing to do here
                LoggerUtils.d(LOG, "Search widget expand ");
                return true; // Return true to expand action view
            }

            @Override
            public boolean onMenuItemActionCollapse(MenuItem item) {
                LoggerUtils.d(LOG, "Search widget colapsed ");
                return true; // Return true to collapse action view
            }
        });

        return super.onCreateOptionsMenu(menu);
    }

I have a similar problem here: http://stackoverflow.com/questions/43702055/android-how-do-i-get-searchview-close-button-to-return-to-search-edittext?noredirect=1#comment74449117_43702055. mSearchView.onActionViewExpanded() doesn't work. Do you have any thoughts or ideas on how I can fix? — AJW, Apr 30 '17 at 02:25

score 58 · Answer 2 · answered Nov 06 '14 at 02:28

58

you can just use the onCloseListener()

sv= (SearchView) findViewById(R.id.searchView1);

sv.setOnCloseListener(new OnCloseListener() {
            @Override
            public boolean onClose() {
                Toast t = Toast.makeText(MainActivity.this, "close", Toast.LENGTH_SHORT);
                t.show();

                return false;
            }
        });

answered Nov 06 '14 at 02:28

spaceMonkey

4,475
4
26
34

i dont see any reason for not working. unless http://stackoverflow.com/a/14622049/4127670 – spaceMonkey Feb 02 '15 at 09:07
42

Perhaps this works on a collapsing `SearchView`, but it doesn't work for me with `iconifiedByDefault="false"` – Richard Le Mesurier Jan 18 '16 at 07:12

score 36 · Answer 3 · edited Nov 27 '16 at 07:07

36

I had problems trying to find the component by its ID but I found another way to search this component using the context of the same SearchView

// Catch event on [x] button inside search view
int searchCloseButtonId = searchView.getContext().getResources()
                .getIdentifier("android:id/search_close_btn", null, null);
ImageView closeButton = (ImageView) this.searchView.findViewById(searchCloseButtonId);
// Set on click listener
closeButton.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
       // Manage this event.
    }
});

edited Nov 27 '16 at 07:07

Jared Burrows

54,294
25
151
185

answered Jul 21 '14 at 01:56

Jhegs

497
5
8

3

It works, just don't forget to add `searchView.setIconified(true);` or `searchView.setIconified(false);` accordingly – Gidi Sprintzin Nov 16 '16 at 07:47
3

This look hackish – Sharp Edge Dec 28 '17 at 19:51
3

cathced java.lang.NullPointerException (( – Serg Burlaka Oct 16 '18 at 12:11

score 29 · Answer 4 · answered Sep 25 '15 at 12:49

I use this code to catch text query clearing, and perform my actions

@Override
    public boolean onCreateOptionsMenu(Menu menu) {
        getMenuInflater().inflate(R.menu.search, menu);

        SearchView searchView = (SearchView) menu.findItem(R.id.search_button).getActionView();
        SearchManager searchManager = (SearchManager) getSystemService(Context.SEARCH_SERVICE);
        searchView.setSearchableInfo(searchManager.getSearchableInfo(getComponentName()));

        SearchView.OnQueryTextListener textChangeListener = new SearchView.OnQueryTextListener() {
            @Override
            public boolean onQueryTextChange(String cs) {
                if (TextUtils.isEmpty(cs)){
                    //Text is cleared, do your thing
                }
                return false;
            }

            @Override
            public boolean onQueryTextSubmit(String query) {
                //text query submitted
            }
        };
        searchView.setOnQueryTextListener(textChangeListener);

        return true;
    }

One problem that I ran into with this approach is that this also seems to trigger when the search view is closed by clicking the home/back icon. In my case I needed different behaviors for those two separate actions. — user1689757, Nov 12 '17 at 03:23
This answer does not address a key part of the question - how to differentiate between clearing via the 'x' button and clearing by hitting backspace until there is no text left. — Joeleski, Dec 20 '18 at 06:33

leon · Answer 5 · 2019-08-19T09:49:43.493

If you use Appcompat library, instead of using

getResources().getIdentifier("android:id/search_close_btn", null, null);

you can do this:

MenuItem searchItem = menu.findItem(R.id.action_search);
SearchView searchView = (SearchView) searchItem.getActionView();
View closeButton = searchView.findViewById(android.support.v7.appcompat.R.id.search_close_btn);
                closeButton.setOnClickListener(new View.OnClickListener() {
                    @Override
                    public void onClick(View v) {
                        //handle click
                    }
                });

EDIT AUGUST 2019:

If you use androidx: androidx.appcompat.R.id.search_close_btn

Thanks, this is the only solution that worked for me – DIRTY DAVE Mar 05 '21 at 11:33 — DIRTY DAVE, Mar 05 '21 at 11:33

score 12 · Answer 6 · answered Jun 26 '20 at 05:11

12

If you are using the SearchView from androidx, you can do this:

val closeButton: View? = searchView.findViewById(androidx.appcompat.R.id.search_close_btn)
closeButton?.setOnClickListener { 
    //TODO: Set your action
}

answered Jun 26 '20 at 05:11

GianMS

923
2
13
25

4

A caveat on this is that it overrides the clear functionality. Then, you should call `searchView.setQuery("", false)` as well. – djserva Feb 18 '21 at 11:25

score 6 · Answer 7 · answered May 15 '20 at 23:18

The solution from Eduardo doesnt work for me. I found something else which is working for Kotlin. I found this solution thanks to SjoerdvGestel and it's answer.

// Get the close button on the searchView
val closeButtonId: Int = searching.context.resources.getIdentifier("android:id/search_close_btn", null, null)
val closeButton = searching.findViewById(closeButtonId) as ImageView

// On close collapse the searchView
closeButton.setOnClickListener {
    searching.onActionViewCollapsed()
    true
}

score 5 · Answer 8 · answered Aug 18 '17 at 09:09

    ImageView closeButton = (ImageView) this.searchView.findViewById(android.support.v7.appcompat.R.id.search_close_btn);

    closeButton.setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            // Manage this event.


        }
    });

Use R.id.search_go_btn for "Submit" Button

score 5 · Answer 9 · answered Aug 10 '18 at 12:37

5

A kotlin answer:

mySearchView.setOnCloseListener(object : SearchView.OnCloseListener {
            override fun onClose(): Boolean {
                // Do your stuff
                return false
            }
        })

answered Aug 10 '18 at 12:37

Eduardo Viana

51
1
2

Lautaro Villarreal Culic' · Answer 10 · 2021-01-20T16:20:10.717

2

To return to the initial state of the SearchView, you can make a clear focus when the "X" is pressed, in addition, this clear focus hides the keyboard.

searchview.setOnCloseListener(new SearchView.OnCloseListener() {
            @Override
            public boolean onClose() {
                searchview.clearFocus();
                return false;
            }
});

edited Jan 20 '21 at 16:20

answered Jan 20 '21 at 15:42

Lautaro Villarreal Culic'

35
5

Please don't post only code as answer, but also provide an explanation what your code does and how it solves the problem of the question. Answers with an explanation are usually more helpful and of better quality, and are more likely to attract upvotes. – Zsolt Meszaros Jan 20 '21 at 16:15
1

Thanks for the clarification. – Lautaro Villarreal Culic' Jan 20 '21 at 16:20
This doesnt works if you add a breakpoint on clicking of cancel this block never gets executed. – Prajwal Waingankar Nov 15 '22 at 07:55

score 2 · Answer 11 · answered Mar 17 '22 at 02:10

I got this answer by checking the androidx.appcompat.widget.SearchView class and checked for the id close button and found ImageView mCloseButton = findViewById(R.id.search_close_btn); So the solution is to get the reference of this id in your searchView implementation and attach onClickListener to it. So what internally happens is that we are overriding the imageView's setOnClickListener and adding our implementation. Here is the code.

SearchView searchView = findViewById(R.id.search_view);
ImageView closeButton = searchView.findViewById(R.id.search_close_btn);
if (closeButton != null) closeButton.setOnClickListener(v -> {
       //your logic goes in here
    });

This has to be the simplest ans among all answers! – Prajwal Waingankar Nov 15 '22 at 07:59 — Prajwal Waingankar, Nov 15 '22 at 07:59

score 2 · Answer 12 · answered Jan 28 '23 at 21:17

This is the code that worked for me:

ImageView closeButton = (ImageView) this.searchView.findViewById(androidx.appcompat.R.id.search_close_btn);
            closeButton.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
               //DO SMTH
                }
            });

score 1 · Answer 13 · answered Dec 31 '21 at 09:28

1

A kotlin clean & simple answer using (Lambda):

mySearchView.setOnCloseListener {
    // Do your stuff
    return false
}

answered Dec 31 '21 at 09:28

Dharamveer Mithilesh Gupta

53
1
8

How do I capture SearchView's clear button click?

13 Answers13

Linked