Fragment replacement triggers onQueryTextChange on searchview

Question

This is how I navigate through my app:

• Open fragment with list
• Filter list by a text entered in searchview
• Tap on listitem (list fragment get

Answer 1

The problem is ActionBar (and subcomponents) are collapsed when the fragment holding it is replaced. When this happens the SearchView query is cleared as seen in onActionViewCollapsed. Workarounds include:

Prevent collapsing

Remove setShowAsAction(MenuItem.SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW); from the searchview's creation code or android:showAsAction="collapseActionView" from its xml code.

This will affect how/when the view's close/voicesearch buttons are displayed upon attempting to collapse it

It would also be possible to prevent collapsing by overriding SearchView's onActionViewCollapsed() method to do nothing but would accomplish the same.

Ignore query changes when appropriate

When the fragment is not valid (being replaced) then ignore query changes that would otherwise cause the fragment to alter its saved query text or layout (changing the layout would cause an exception if the fragment doesn't actually have view content).

public boolean onQueryTextChange(String newText) {
    if (!isVisible()) {
        // The fragment was replaced so ignore
        return true;
    }
    // Text was actually changed, perform search
    return true;
}

This would be the better option as it doesn't affect the functionality of the searchview.

Answer 2

Using androidx.appcompat.widget.SearchView + LiveData + ViewModel :

searchView.setOnQueryTextListener(object: SearchView.OnQueryTextListener {
    override fun onQueryTextSubmit(query: String?): Boolean {
        viewModel.setSearchQuery(query)
        return true
    }
    override fun onQueryTextChange(newText: String?): Boolean {
        if(searchView.isIconified || !isVisible) {
            // Don't call setSearchQuery when SearchView is collapsing/collapsed
            return true
        }
        viewModel.setSearchQuery(newText)
        return true
    }
})

Answer 3

If anyone experiences this same issue, the onQueryTextChange callback will be fired when replacing the Fragment when using the following action in your menu XML file when your SearchView is currently expanded:

android:showAsAction="always|collapseActionView"

When you attempt to use isVisible() (Java) or isVisible (Kotlin) in the onQueryTextChange callback as a way to determine if the Fragment is actually visible or not, the value returned will always return true.

The reason for this is that the onQueryTextChange callback will be fired when you're SearchView is currently expanded when you attempt to change Fragment's.

The default action of collapseActionView at this stage is to collapse the SearchView when changing Fragment's.

Solution:

Simply call your SearchView !isIconified (Kotlin) method in your onQueryTextChange callback and only set your logic if it returns false, i.e. the SearchView is currently expanded. Full example described below:

yourSearchView.setOnQueryTextListener(object: SearchView.OnQueryTextListener {
    override fun onQueryTextSubmit(query: String?): Boolean {
        // Do search query here if you use a submit action
        return true
    }

    override fun onQueryTextChange(newText: String?): Boolean {
        if (!yourSearchView.isIconified) {
            // Don't execute your search query here when SearchView is 
            // currently open
            return true
        }
        // Do search query here
        return true
    }
})

Answer 4

After 2 days of Googling i got the solution that will definitely helps you.

I have just cut and pasted code from onCreateOptionMenu() to onPrepareOptionMenu()

I do not know why it happens, I think listener of searchView is not going to be NULL by the way you can change your code this way.

@Override
public void onPrepareOptionsMenu(Menu menu) {
    super.onPrepareOptionsMenu(menu);
    getSherlockActivity().getSupportMenuInflater().inflate(R.menu.menu_all_order, menu);

    searchView = (SearchView) menu.findItem(R.id.menu_all_order_search).getActionView();
    searchView.setInputType(InputType.TYPE_CLASS_NUMBER);
    searchView.setQueryHint("Enter Order No");
    searchView.setOnQueryTextListener(this);
}

and Remove:

@Override
public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
    super.onCreateOptionsMenu(menu, inflater);
}

Thanks :)

Answer 5

I see you didn't find a solution yet, I have same problem posted here:

I found that when invalidateOptionsMenu is called also the method onQueryTextChange is called because the View launch dispatchRestoreInstanceState with the previous value after you've cleared the search for example. Do you call invalidateOptionsMenu maybe?

Maybe, inside onQueryTextChange, you can check a boolean on some current state of your application objects to know if the method content should be executed. In my case I use mDrawerLayout.isDrawerOpen(..) to allow the search.

Also you can implement the SearchView.OnQueryTextListener on each Class you use, on a Fragment or on the Main Activity class, somewhere in the class you could set a boolean module variable that you will check inside onQueryTextChange.

Answer 6

I modified the menu item attribute showAsAction from android:showAsAction="always|collapseActionView" to android:showAsAction="always". Now the look and behavior of the searchview has changed a bit, but the searchQuery doesn't get cleared!

<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <item
            android:id="@+id/actionSearch"
            android:icon="@android:drawable/ic_menu_search"
            android:actionViewClass="android.widget.SearchView"
            android:showAsAction="always"
            android:title="@android:string/search_go"
    />
</menu>