Android Listview Custom Filter
Android Listview Custom Filter
Android developer blog. Tutorial for android development that helps you to become an android developer
Follow SwA
In the previous post we showed the way we can programming a custom adapter and a custom layout. One aspect we didnt cover by now, is how we can filter the items in the ListView. In this post we describe how we can filter items inside a ListView while the user writes words inside an input field. We can use the example shown in the last post and modify it. What do we need to do it? Modify the custom adapter, PlanetAdapter so that it will be able to filter the items Add an input field where the user can insert the keys to filter the ListView Lets start then.
123
If we didnt use a custom adapter with custom object inside the ListView, the things would be much easier. For example if we used just String as item content we simply could add a few lines of code to make our list filterable; but we have a custom layout that uses not a simply String but a complex object (i.e. Planet). So we need first modify our custom adapter (PlanetAdapter) so that it implements the android.widget.Filter interface. This interface requires we implement just only one method called getFilter() that returns a android.widget.Filter object. The problem is the way we can create this filter. Very easy!
1 2 3 4 5 6 7 8 9 10 11 12 private class PlanetFilter extends Filter { @Override protected FilterResults performFiltering(CharSequence constraint) { .... } @Override protected void publishResults(CharSequence constraint,FilterResults results) { ..... } }
?
Android app development :weather app with forecast Android Detect Face Android HTTP Client : Network error and ConnectivityManager Android UML : Design an App Part 2 Android UML: Design an App Part 1 Recent Posts Widget by Helplogger
Popular Posts
Android ListView Tutorial and basic example Android ListView : Custom Adapter and Layout Android ListView : Custom Filter and Filterable interface
We create a private class called PlanetFilter that extends the android.widget.Filter. This class has two abstract methods:
FilterResults performFiltering(CharSequence constraint) : invoked in worker thread, that has the task to filter the results according to the constraint void publishResults(CharSequence constraint,FilterResults results): that has the task to show the result set created by performingFiltering method Lets suppose we want to filter the planet list using the name attribute. In our case, then, the constraint can be the initial letters of the planet name, so that if the planet starts with those letters we show it otherwise we hide it.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 @Override protected FilterResults performFiltering(CharSequence constraint) { FilterResults results = new FilterResults(); // We implement here the filter logic if (constraint == null || constraint.length() == 0) { // No filter implemented we return all the list results.values = planetList; results.count = planetList.size(); } else { // We perform filtering operation List<Planet> nPlanetList = new ArrayList<Planet>();
?
Add a sliding menu with animation to an Activity Android HTTP Client: GET , POST , Download, Upload, Multipart Request
converted by Web2PDFConvert.com
17 18 19 20 21 22 23 24
In this method we have to return a FilterResults that has two static attributes called values and count. Values is a list of values to be shown while count is the number of these values. The first thing we do in this method is to verify if the constraint is null or empty, in this case we dont have to filter the result and simply
1 2 results.values = planetList; results.count = planetList.size();
?
In other words all the list. If the constraints arent null or empty we simply select the planet with its name starting with the constraint, as shown below.
1 2 3 4 5 6 7 8 9 List<Planet> nPlanetList = new ArrayList<Planet>(); for (Planet p : planetList) { if (p.getName().toUpperCase().startsWith(constraint.toString().toUpperCase())) nPlanetList.add(p); } results.values = nPlanetList; results.count = nPlanetList.size();
?
We said before that the PlanetAdapter has to implement Filterable interface and it has to implement getFilter() method:
1 2 3 4 5 6 7 @Override public Filter getFilter() { if (planetFilter == null) planetFilter = new PlanetFilter(); return planetFilter; }
?
This is code is quite trivial, we simply invalidate the result set if the result list is empty or we notify that the result set is changed. It is done!.quite done!We need now adding just an input field where user can insert the keyword to filter the result. The new layout becomes:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" android:focusable="true" android:focusableInTouchMode="true"> <EditText android:id="@+id/editTxt" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="5dp" android:maxLines="1" /> <ListView android:id="@+id/listView" android:layout_height="match_parent" android:layout_width="match_parent" android:layout_weight="1"/> <Button android:id="@+id/addBtn" android:text="Add planet" android:onClick="addPlanet" android:layout_weight="0.5" android:layout_height="80dp"
converted by Web2PDFConvert.com
?
27 28 29 30
android:layout_width="match_parent"/> </LinearLayout>
In the main activity we have to add some listener attached to EditText so that when user writes inside it we can filter the list items.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 editTxt.addTextChangedListener(new TextWatcher() { @Override public void onTextChanged(CharSequence s, int start, int before, int count) { System.out.println("Text ["+s+"]"); aAdpt.getFilter().filter(s.toString()); } @Override public void beforeTextChanged(CharSequence s, int start, int count, int after) { } @Override public void afterTextChanged(Editable s) { } });
?
TRICKS
One simple trick we have to use is to make soft keyboard hidden at the app startup. As soon as the app starts the EditText gains the focus and the OS shows the keyboard covering the list items. If we dont want this we can simply move the focus somewhere else:
1 2 android:focusable="true" android:focusableInTouchMode="true"
?
Source code here You might be interested on: Android ListView Tutorial And Basic Example Android ListView : Custom Adapter And Layout More On ListView Filterable Interface
Etichette: Filter, ListView, UI
2973 Google + 8 5 1 DZone 0 Reddit 0
Rohit ago
Hi Thanks a lot for this awesome tutorial.. I have successfully implemented it...
converted by Web2PDFConvert.com
Thanks a lot for this awesome tutorial.. I have successfully implemented it... But one question how do i implement in search widget and not using edit text I am going through http://developer.android.com/g... and also made the search widget... but how do i get edit text like id from it because search widget don't have any method as addTextChangedListener i suppose.. I am unable to make it through... can you help ?
Reply Share
survivingwithandroid Reply
I guess the approch is different. I will try to analyze your problem. Thank you
Share
2 months
3 months
dentex ago
Ciao, ho provato il codice da gitHub e funziona. Ma applicandolo al mio progetto, in cui ho implementato una mia versione di "Pianeta", il filtro non funziona. Il mio codice per la lista basato sul custom adapter del tuo esempio "SimpleList". Non riesco a capire cosa pu essere. In pratica quello che scrivo nell' EditText viene ignorato. Ho controllato tutto pi volte... Qualche idea? Il codice del mio progetto su https://github.com/dentex/ytdo... DashboardListItem.java DashboardActivity.java DashboardAdapter.java ciao e grazie comunque per gli ottimi tutorial.
Reply Share
survivingwithandroid 1 Reply
Adesso provo a scaricare il tuo progetto per vedere se riesco a capire xch il filtro non va.
Share
3 months
3 months
ho appena constatato che sull'emulatore questa implementazione funziona anche nella mia app, cos come l'avevo adattata. Quindi adesso devo cercare di capire perch non funziona sul dispositivo reale... Spero di non averti fatto perdere tempo.
Reply Share
3 months
Per la miseria funziona pure sul cellulare! Non ho toccato il codice, ho solo disinstallato la versione con la firma di Eclipse del portatile, e installato la versione dal desktop. Ieri ho perso una giornata... boh.
converted by Web2PDFConvert.com
Reply
Share
survivingwithandroid
Probabilmente non aveva installato il codice corretto. Avevo dato un'occhiata al codice e mi sembrava corretto e non vedevo errori, quindi doveva funzionare! :)
Reply Share
3 months
Forse ho capito perch non mi ero accorto che funzionava: in pratica se digiti un carattere che dovrebbe escludere tu gli elementi della lista (cio con cui nessun elemento inizia) non succede niente. Il filtro funziona solo se digiti qualcosa con cui effettivamente qualche elemento della lista inizia: es: - banana - mela - ciliegia se digito "d" la lista non viene modificata (o "x", o "y", ecc); se digito "m" vedo solo "mela" ecc.
Inoltre ho riscontrato lo stesso problema del commento successivo riguardante i "listener": ritornano la posizione della lista non filtrata. (nell'esempio sopra, cliccando su mela "filtrata", si avrebbe comunque il riferimento a "banana"). ;)
Reply Share
survivingwithandroid
Per quanto riguarda il filtro con la lettera iniziale che non esiste e quindi la lista dovrebbe essere vuota mi sembra di averlo provato questo caso e funzionava. Per il secondo problema trovi qualche info sui commenti al post cmq il problema che vai a prendere la posizione nella lista originale e non in quella filtrata.
Reply Share
8 days
Per avere una lista "vuota" (cio interamente filtrata) quando si inserisce un carattere con cui nessun elemento inizia, ho cambiato:
public void publishResults(CharSequence constraint,FilterResults results) { if (results.count == 0) { notifyDataSetInvalidated(); } else { itemsList = (List<dashboardlistitem>) results.values; notifyDataSetChanged(); } } in: public void publishResults(CharSequence constraint,FilterResults results) { itemsList = (List<dashboardlistitem>) results.values; notifyDataSetChanged(); } </dashboardlistitem></dashboardlistitem>
Reply
Share
3 months
3 months
Ho risolto su come fare riferimento alla lista filtrata. (ho risposto alla discussione in basso) :D
Reply Share
4 months
Great Tutorial. Well explained. I used your code from Github and it filters my list fine. However, when I select a listItem it only shows me th first item in the list [0], even if it that item was filtered out. I am using onListItemClick, where you use onItemClick. from SQLite database and using Parcelable to send the data from the listview to a detail view. This is a project that's due in next week so a reply would be real nice. Thanks.
Reply Share
survivingwithandroid
If i get correctly when you use a filtered list and select one item of this list you get always the first one. If so i think you are using t original arraylist instead of the filtered array.
Reply Share
4 months
Correct. I can't seem to select from the filtered list. Can you recommend a solution or is there a way I can get the source code to you? This is the Activity that uses the list *** And this is the adapter *** Thanks for the reply and hope to hear from you....
Reply Share
survivingwithandroid
Well i noticed two things in onListItemClick: 1. You shouldn't call super.onList... because you are handling the event by yourself
2. You get the bird information from original birds list and not from the filtered one. So you should ask to the adapter the new birds array (the filtered one) and then get the bird data from it.
Reply Share
4 months
Great, Thanks. I'll give it a go now. This is my first app and I'm just getting used to Android. Thanks again and I'll let you know how I got on...
1 Reply Share
4 months
I've removed the super call and set the updated bird list in publishResults with notifyDataSetChanged. Still not working however. What am I missing here? I think I'm looking at this too long today, the answer is probably staring back at me..
1 Reply Share
3 months
Before calling any method on a list element, you have to take a reference to the modified list (using the names from the example given on this site): Planet currentPlanet = aAdpt.getItem(position);
converted by Web2PDFConvert.com
where "position" is a parameter from, i.e.: public boolean onItemLongClick(AdapterView parent, View view, final int position, long id) { ... }
Reply Share
6 months
Anonymous ago
great tutorial..
Reply Share
6 months
Nice post.Give it up. Thanks for share this article. For more visit:android development
Reply Share
8 months
jfrankie ago
4 months
thanks for this great tutorial but where did you post the solution?
Reply Share
survivingwithandroid Reply
9 months
Anonymous ago
Hi, code provided by you has been a great help while working on filtering custom list. Could you please also tell how to get back the names in the list as the user deletes characters in the search bar to return to the actual list. Any help would be appreciated.
Reply Share
9 months
Anonymous ago
Ok,thank you veru much ,I try with autocompletetextview and that's not working too.
Reply Share
9 months
jfrankie ago
Since you are populating your list using a JSON URL it could be wise to use an async adapter. It could be that your list isnt still populated wh you filter it. I suggest to you to try with a "static" items and verify that everything works then you move on and try to populate the list usi JSON. It could be useful to verify if item ids are stable there's a method to verify it. Anyway i will try to set up an example code that populates the list using a JSON and i will verify the result. Reading your code it seems everything is fine so the only one thing that is different from my example is the JSON URL.
Reply Share
9 months
Anonymous ago
adapter=new item_com_Choice(this, results); list4.setAdapter(adapter); //Teliste_vide_label.setVisibility(View.INVISIBLE); list4.setVisibility(View.VISIBLE); list4.setTextFilterEnabled(true); filterText.addTextChangedListener(new TextWatcher() { @Override public void onTextChanged(CharSequence s, int start, int before, int count) { System.out.println("Text ["+s+"]"); adapter.getFilter().filter(s.toString());
see more
Reply
Share
9 months
Anonymous ago
public class item_com_Choice extends ArrayAdapter implements Filterable { private List planetList; private Context context; private Filter planetFilter; private List origPlanetList; public item_com_Choice(Context ctx,List planetList ) { super(ctx, R.layout.item4, planetList); this.planetList = planetList; this.context = ctx; this.origPlanetList = planetList; } @Override public int getCount() { return planetList.size(); } @Override
see more
Reply
Share
9 months
Anonymous ago
Thanks a lot ,but it still not working,when I write a letter in the EditText nothing happens...and I dont know why :(
Reply Share
9 months
9 months
Anonymous ago
That still not working...I also override the toString method in the class "gare"...but it still not working :( @Override protected void publishResults(CharSequence constraint, FilterResults results) { item_com_list = (List) results.values; //Now we have to inform the adapter about the new list filtered if (results.count == 0) notifyDataSetInvalidated(); else { item_com_list = (List) results.values;
converted by Web2PDFConvert.com
9 months
In the else part in the publish method you've to replace your code with: else { planetList = (List) results.values; notifyDataSetChanged(); } and remove it from the method.
Reply Share
9 months
Anonymous ago
if(results!=null && results.size() > 0) { final item_com_Choice adapter=new item_com_Choice(gare_choix_depart_activity.this, results); list4.setAdapter(adapter); //Teliste_vide_label.setVisibility(View.INVISIBLE); list4.setVisibility(View.VISIBLE); list4.setTextFilterEnabled(true); filterText.addTextChangedListener(new TextWatcher() { @Override public void onTextChanged(CharSequence s, int arg1, int arg2, int arg3) { // TODO Auto-generated method stub System.out.println("Text ["+s+"]"); adapter.getFilter().filter(s.toString());
see more
Reply
Share
9 months
Anonymous ago
Ok; Thank you very much. But the letter that I wrote is the first letter of a name of a "Station" in the data base This is the code source : private class gareFilter extends Filter {
@Override protected FilterResults performFiltering(CharSequence constraint) { FilterResults results = new FilterResults(); // We implement here the filter logic if (constraint == null || constraint.length() == 0) { // No filter implemented we return all the list results.values = item_com_list; results.count = item_com_list.size();
see more
Reply
Share
9 months
converted by Web2PDFConvert.com
The filter works comparing the first letter so if you entered a letter that doens't match any items the result is empty. In a few hours i will add to github the entire source code so if you are patient you can try again.
Reply Share
9 months
Anonymous ago
Hi ; I tried this code but I had an empty result when I wrote a character and I dont know why
Reply Share
10 months
jfrankie ago
Well in this case you should replate startsWith with indexOf and verify that that letter is present so indexOf result is != -1
Reply Share
10 months
Anonymous ago
I am using custom list Adapter in code.The listview is having indexbar.I need to show items whose words start with letters entered in searchbox i.e. if item is having 3 words and second word start with A and we enter A in searchbox then that item also should get searched
Reply Share
10 months
jfrankie ago
You can find me in g+ with survivingwithandroid. My email add is [email protected]. Btw i downloaded your app and it looks great and i didn't find the error even if i filtered the list in the bus line option very very fast (I'm using Gingerbread). Anyway if you like you can send me the code so i can have an idea more detailed. The error seems caused by the fact you try to update the view from an external thread in that case you should somehow implements something like a queue. I'd really like to investigate more about it.
Reply Share
10 months
Hi, Thanks for ur answer. Well, this bug that u found I already fix some months ago. I fix with this code: @Override protected void publishResults(CharSequence constraint, FilterResults results) { planetList = (List) results.values; // Now we have to inform the adapter about the new list filtered if (results.count == 0) notifyDataSetInvalidated(); else { notifyDataSetChanged(); } }
see more
Reply
Share
10 months
jfrankie ago
I tried to reproduce the error you told me...but even if i tried very fast with "a" and delete it the app didn't crash. I used 4.0.3 emulator. The only one bug i found is that the code doesn't show the complete list after you delete the filter in the edit view. This is caused by a mistake in the source code. You should create a copy of the original array showed in the listView and when the filter is empty set the value to this copy array. I will update the code. If you can repeat the error please send me the stack trace so i can have some clues.
converted by Web2PDFConvert.com
Reply
Share
10 months
jfrankie ago
Thanks for you comment. I will try to reproduce this bug and fix it and i will release a new source code version.
Reply Share
10 months
Nice work! I used it on my project, but I found a bug on this code. And it just found now, after I change my project android version to wo for 4.0.3 If I press "a" and delete.. repeat it very fast.. the app closes.. ListView need to be notified, that's the error message. But how to notify it again ? or how to avoid this bug ?
Reply Share
thanks!
r Comment feed
converted by Web2PDFConvert.com
2012-2013 Survivingwithandroid.com Sitemap All Rights Reserved. Reproduction without explicit permission is prohibited. Android Blog Contact me About Me
Blog Archive Search This Blog
Search
Follow SwA 2013 (25) 2012 (19) December (1) November (3) October (3) Android ListView : Custom Filter and Filterable in... Android ListView : Custom Adapter and Layout Android ListView : ArrayAdapter, Manage Items, Use... September (5) August (1) July (3) June (3)
Email address...
Submit
Popular Posts
Android ListView Tutorial and basic example One of the UI component we use often is ListView, for example when we need to show items in a vertical scrolling list. One interesting asp... Android ListView : Custom Adapter and Layout Topics covered Android ListView Array Adapter Custom layout Optimization: View holder pattern In the last post , we talked about how ... Android ListView : Custom Filter and Filterable interface In the previous post we showed the way we can programming a custom adapter and a custom layout. One aspect we didnt cover by now, is how w... Add a sliding menu with animation to an Activity I was playing around with animation, layers and so on and i have coded this simple sliding menu. The idea is very simple when user touches t... Android HTTP Client: GET, POST, Download, Upload, Multipart Request Topics covered HTTP connection Post request Download data Upload data Multipart request Often Android apps have to exchange informati...
converted by Web2PDFConvert.com
Android weather app: JSON, HTTP and Openweathermap Topics covered How to develop weather app HTTP connection JSON Parsing Openweathermap API In this post I want to describe how to creat... Android ListView with SectionIndexer and fast scroll In this post i want to analyze how to use ListView with SectionIndexer enabling the fast search. ListView has a method that enables the fa... Android ExpandableListView with Custom Adapter: BaseExpandableListAdapter Topics covered Android ExpandableListView BaseExpandableListAdapter Custom adapter In the previous post we talked about ListView and ho... Multi touch in Android : onTouchEvent example In this post i want to analyse how Android handles the multitouch. Reading some posts around the net i found that are a bit confusing and no... Fragment in Android: Tutorial with Example using WebView In this post we want to explain how to use fragment in Android with a real example . In the last post we talked about Fragment in Android...
converted by Web2PDFConvert.com