Delay call to onQueryTextChange() in SearchView.OnQueryTextListener with SearchView

Question

Using a SearchView in my application.

Is there anyway in which I can make the call to onQueryTextChange() method delayed. Like, when user type a sequence of characters, he must wait before this method gets called.

This wait should not depend on number of characters typed yet but a small pause is required before method being hit.

I want to pause because, as the user types into the search view, a request with the string will be made to server to request the matched data, and then I will populate my ListView according to suggestions.

Activity information (if required) :
Implements SearchView.OnQueryTextListener.

    MenuItem searchItem = menu.findItem(R.id.action_search);
    SearchView searchView = (SearchView)MenuItemCompat.getActionView(searchItem);
    searchView.setOnQueryTextListener(this);

You can use a TimerTask to delay filtering your list. Put the code of filtering inside the timer. However I would not recommend delaying search. — Skynet, May 05 '15 at 08:28
@pskink To fetch data from server as the user types into the SearchView. Request must not be made every time a character is typed, rather, there should be a pause. — Shubham A., May 05 '15 at 08:28
@Skynet Please elaborate, why don't you recommend a TimerTask? — Shubham A., May 05 '15 at 08:30
use a Filterable interface, please don't reinvent the wheel, you can use FilterQueryProvider for example — pskink, May 05 '15 at 08:30
I second using a FilterQueryProvider. I said I dont recommend delaying search, you can use a timer task. If you dont want to access the server each time, allow the user to use the submit button of the SearchView. — Skynet, May 05 '15 at 08:38
@Skynet Why not to delay search? User usually knows what they are searching for (at least in my case, they do). If the search isn't delayed, ListView will get populated with 'S' suggestions, followed by "Sk", "Sky", till "Skynet". Though I know that the past data from ListView can be flushed. — Shubham A., May 05 '15 at 08:43

score 39 · Accepted Answer · edited May 31 '19 at 13:24

39

To delay the call to your server, use the following code in your onQueryTextChange method, the variables mQueryString and mHandler must be class variables. also check mHandler!=null

@Override
public boolean onQueryTextChange(String searchTerm) {
    mQueryString = searchTerm;
    mHandler.removeCallbacksAndMessages(null);

    mHandler.postDelayed(new Runnable() {
        @Override
        public void run() {
           //Put your call to the server here (with mQueryString)
        }
    }, 300);
    return true;
}

edited May 31 '19 at 13:24

Height8 droid

13
4

answered Oct 30 '15 at 11:17

killianke

423
5
9

Thanks that was grate. – Erik Feb 06 '18 at 16:37

score 9 · Answer 2 · answered Jul 21 '17 at 16:16

This should help you, your class need to implement "SearchView.OnQueryTextListener" and "cntr" must be declarated in your class

This is already twinked for a regular user typing, if you want to wait more, just raise the "waitingTime".

The request should be inside the "onFinish"

    private int waitingTime = 200;
    private CountDownTimer cntr;

    @Override
    public boolean onQueryTextChange(String newText) {
    if(cntr != null){
        cntr.cancel();
    }
    cntr = new CountDownTimer(waitingTime, 500) {

        public void onTick(long millisUntilFinished) {
            Log.d("TIME","seconds remaining: " + millisUntilFinished / 1000);
        }

        public void onFinish() {
            Log.d("FINISHED","DONE");
        }
    };
    cntr.start();
    return false;
}

This should be the accepted answer because the first answer has the undesirable effect to call the method 'run' twice — Christophe Blin, Apr 30 '18 at 09:03

score 7 · Answer 3 · answered May 31 '18 at 07:07

7

You can use Kotlin coroutines like this. Declare the countdown job

private lateinit var textChangeCountDownJob: Job

And then onQueryTextChange:

    override fun onQueryTextChange(newText: String): Boolean {

        if(::textChangeCountDownJob.isInitialized)
            textChangeCountDownJob.cancel()

        textChangeCountDownJob = launch(UI) {
            delay(800)
        }

        return false
    }

answered May 31 '18 at 07:07

Sukitha Udugamasooriya

2,268
1
35
56

1

i think using coroutines is simple and more effective. but which package does the `launch` method is from? – nadinnnnnne Aug 22 '20 at 07:04
1

@nadinnnnnne textChangeCountDownJob = lifecycleScope.launch { .. } – Udi Oshi Aug 03 '21 at 19:06

Ashutosh Srivastava · Answer 4 · 2020-06-05T08:33:53.460

Delay call to onQueryTextChange() in SearchView.OnQueryTextListener with SearchView

private long delay = 2000; 
private long editTextLastWord = 0;
privaste  SearchView searchView;
Handler handler = new Handler();

private Runnable runnable = new Runnable() {
    public void run() {
        if (System.currentTimeMillis() > (editTextLastWord + delay - 500)) {

          perFormTask();
        }
    }
};
 searchView=(SearchView) findViewById(R.id.searchView);
        searchView.setOnQueryTextListener(new SearchView.OnQueryTextListener() {
            @Override
            public boolean onQueryTextSubmit(String query) {
                return false;
 if (s.length() > 2) {              
          editTextLastWord = System.currentTimeMillis();
          handler.postDelayed(runnable, delay);
        } else {

        }
            }

            @Override
            public boolean onQueryTextChange(String newText) {
                return false;
  handler.removeCallbacks(runnable);
            }
        });

score 2 · Answer 5 · answered Mar 20 '19 at 09:23

1) Create abstract class:

public abstract class DelayedOnQueryTextListener implements SearchView.OnQueryTextListener {

    private Handler handler = new Handler();
    private Runnable runnable;

    @Override
    public boolean onQueryTextSubmit(String s) {
        return false;
    }

    @Override
    public boolean onQueryTextChange(String s) {
        handler.removeCallbacks(runnable);
        runnable = () -> onDelayerQueryTextChange(s);
        handler.postDelayed(runnable, 400);
        return true;
    }

    public abstract void onDelayerQueryTextChange(String query);
}

2) Set it like this:

searchView.setOnQueryTextListener(new DelayedOnQueryTextListener() {
    @Override
    public void onDelayerQueryTextChange(String query) {
        // Handle query
    }
});

Delay call to onQueryTextChange() in SearchView.OnQueryTextListener with SearchView

5 Answers5

Linked