[android] Implementing SearchView in action bar

I need to create SearchView from my arrayList<String> and show the suggestions in the drop-down list same this

I look for tutorials that explain step by step how to build a SearchView in a action bar.

I have read the documentation and following the example google but it was not useful to me.

I have created the search

<?xml version="1.0" encoding="utf-8"?>

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

But I do not know how to set the parameters of the array of strings. I tried to retrieve the result in a different Activity but not work.

SearchDialog or SearchWidget ?

When it comes to implement a search functionality there are two suggested approach by official Android Developer Documentation.
You can either use a SearchDialog or a SearchWidget.
I am going to explain the implementation of Search functionality using SearchWidget.

How to do it with Search widget ?

I will explain search functionality in a RecyclerView using SearchWidget. It's pretty straightforward.

Just follow these 5 Simple steps

1) Add searchView item in the menu

You can add SearchView can be added as actionView in menu using

app:useActionClass = "android.support.v7.widget.SearchView" .

<menu xmlns:android="http://schemas.android.com/apk/res/android"
   xmlns:app="http://schemas.android.com/apk/res-auto"
   xmlns:tools="http://schemas.android.com/tools"
   tools:context="rohksin.com.searchviewdemo.MainActivity">
   <item
       android:id="@+id/searchBar"
       app:showAsAction="always"
       app:actionViewClass="android.support.v7.widget.SearchView"
   />
</menu>

2) Set up SerchView Hint text, listener etc

You should initialize SearchView in the onCreateOptionsMenu(Menu menu) method.

  @Override
  public boolean onCreateOptionsMenu(Menu menu) {
     // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.menu_main, menu);

        MenuItem searchItem = menu.findItem(R.id.searchBar);

        SearchView searchView = (SearchView) searchItem.getActionView();
        searchView.setQueryHint("Search People");
        searchView.setOnQueryTextListener(this);
        searchView.setIconified(false);

        return true;
   }

3) Implement SearchView.OnQueryTextListener in your Activity

OnQueryTextListener has two abstract methods

1. onQueryTextSubmit(String query)
2. onQueryTextChange(String newText

So your Activity skeleton would look like this

YourActivity extends AppCompatActivity implements SearchView.OnQueryTextListener{

     public boolean onQueryTextSubmit(String query)

     public boolean onQueryTextChange(String newText) 

}

4) Implement SearchView.OnQueryTextListener

You can provide the implementation for the abstract methods like this

public boolean onQueryTextSubmit(String query) {

    // This method can be used when a query is submitted eg. creating search history using SQLite DB

    Toast.makeText(this, "Query Inserted", Toast.LENGTH_SHORT).show();
    return true;
}

@Override
public boolean onQueryTextChange(String newText) {

    adapter.filter(newText);
    return true;
}

5) Write a filter method in your RecyclerView Adapter.

Most important part. You can write your own logic to perform search.
Here is mine. This snippet shows the list of Name which contains the text typed in the SearchView

public void filter(String queryText)
{
    list.clear();

    if(queryText.isEmpty())
    {
       list.addAll(copyList);
    }
    else
    {

       for(String name: copyList)
       {
           if(name.toLowerCase().contains(queryText.toLowerCase()))
           {
              list.add(name);
           }
       }

    }

   notifyDataSetChanged();
}

Relevant link:

Full working code on SearchView with an SQLite database in this Music App

If anyone else is having a nullptr on the searchview variable, I found out that the item setup is a tiny bit different:

old:

android:showAsAction="ifRoom"
android:actionViewClass="android.widget.SearchView"

new:

app:showAsAction="ifRoom|collapseActionView"
app:actionViewClass="androidx.appcompat.widget.SearchView"

pre-android x:

app:showAsAction="ifRoom|collapseActionView"
app:actionViewClass="android.support.v7.widget.SearchView"

For more information, it's updated documentation is located here.

For Searchview use these code

1. For XML

   <android.support.v7.widget.SearchView
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:id="@+id/searchView">
   
   </android.support.v7.widget.SearchView>
   

   ---

2. In your Fragment or Activity

   package com.example.user.salaryin;
   
   import android.app.ProgressDialog;
   import android.os.Bundle;
   import android.support.v4.app.Fragment;
   import android.support.v4.view.MenuItemCompat;
   import android.support.v7.widget.GridLayoutManager;
   import android.support.v7.widget.LinearLayoutManager;
   import android.support.v7.widget.RecyclerView;
   import android.support.v7.widget.SearchView;
   import android.view.LayoutInflater;
   import android.view.Menu;
   import android.view.MenuInflater;
   import android.view.MenuItem;
   import android.view.View;
   import android.view.ViewGroup;
   import android.widget.Toast;
   import com.example.user.salaryin.Adapter.BusinessModuleAdapter;
   import com.example.user.salaryin.Network.ApiClient;
   import com.example.user.salaryin.POJO.ProductDetailPojo;
   import com.example.user.salaryin.Service.ServiceAPI;
   import java.util.ArrayList;
   import java.util.List;
   import retrofit2.Call;
   import retrofit2.Callback;
   import retrofit2.Response;
   
   
   public class OneFragment extends Fragment implements SearchView.OnQueryTextListener {
   
   RecyclerView recyclerView;
   RecyclerView.LayoutManager layoutManager;
   ArrayList<ProductDetailPojo> arrayList;
   BusinessModuleAdapter adapter;
   private ProgressDialog pDialog;
   GridLayoutManager gridLayoutManager;
   SearchView searchView;
   
   public OneFragment() {
       // Required empty public constructor
   }
   
   @Override
   public void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
   }
   
   @Override
   public View onCreateView(LayoutInflater inflater, ViewGroup container,
                            Bundle savedInstanceState) {
   
       View rootView = inflater.inflate(R.layout.one_fragment,container,false);
   
       pDialog = new ProgressDialog(getActivity());
       pDialog.setMessage("Please wait...");
   
   
       searchView=(SearchView)rootView.findViewById(R.id.searchView);
       searchView.setQueryHint("Search BY Brand");
       searchView.setOnQueryTextListener(this);
   
       recyclerView = (RecyclerView) rootView.findViewById(R.id.recyclerView);
       layoutManager = new LinearLayoutManager(this.getActivity());
       recyclerView.setLayoutManager(layoutManager);
       gridLayoutManager = new GridLayoutManager(this.getActivity().getApplicationContext(), 2);
       recyclerView.setLayoutManager(gridLayoutManager);
       recyclerView.setHasFixedSize(true);
       getImageData();
   
   
       // Inflate the layout for this fragment
       //return inflater.inflate(R.layout.one_fragment, container, false);
       return rootView;
   }
   
   
   private void getImageData() {
       pDialog.show();
       ServiceAPI service = ApiClient.getRetrofit().create(ServiceAPI.class);
       Call<List<ProductDetailPojo>> call = service.getBusinessImage();
   
       call.enqueue(new Callback<List<ProductDetailPojo>>() {
           @Override
           public void onResponse(Call<List<ProductDetailPojo>> call, Response<List<ProductDetailPojo>> response) {
               if (response.isSuccessful()) {
                   arrayList = (ArrayList<ProductDetailPojo>) response.body();
                   adapter = new BusinessModuleAdapter(arrayList, getActivity());
                   recyclerView.setAdapter(adapter);
                   pDialog.dismiss();
               } else if (response.code() == 401) {
                   pDialog.dismiss();
                   Toast.makeText(getActivity(), "Data is not found", Toast.LENGTH_SHORT).show();
               }
   
           }
   
           @Override
           public void onFailure(Call<List<ProductDetailPojo>> call, Throwable t) {
               Toast.makeText(getActivity(), t.getMessage(), Toast.LENGTH_SHORT).show();
               pDialog.dismiss();
   
           }
       });
   }
   
      /* @Override
       public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
       getActivity().getMenuInflater().inflate(R.menu.menu_search, menu);
       MenuItem menuItem = menu.findItem(R.id.action_search);
       SearchView searchView = (SearchView) MenuItemCompat.getActionView(menuItem);
       searchView.setQueryHint("Search Product");
       searchView.setOnQueryTextListener(this);
   }*/
   
   @Override
   public boolean onQueryTextSubmit(String query) {
       return false;
   }
   
   @Override
   public boolean onQueryTextChange(String newText) {
       newText = newText.toLowerCase();
       ArrayList<ProductDetailPojo> newList = new ArrayList<>();
       for (ProductDetailPojo productDetailPojo : arrayList) {
           String name = productDetailPojo.getDetails().toLowerCase();
   
           if (name.contains(newText) )
               newList.add(productDetailPojo);
           }
       adapter.setFilter(newList);
       return true;
      }
   }
   

3. In adapter class

    public void setFilter(List<ProductDetailPojo> newList){
       arrayList=new ArrayList<>();
       arrayList.addAll(newList);
       notifyDataSetChanged();
   }