データバインディングを使ったAndroidのSearchViewの例のチュートリアル
今日はAndroidのSearchViewウィジェットを調べて、検索テキストによってListViewをフィルタリングするアプリケーションを開発します。アクティビティとアダプターのレイアウトを接続するために、DataBindingを使用します。DataBindingについてまだ読んでいない場合は、最初にこのチュートリアルを参照して、より良い理解を得てください。
アンドロイドの検索ビュー
AndroidのSearchViewウィジェットを使用することで、私たちはアプリ内で検索機能を利用することができます。このSearchViewウィジェットは、ToolBar / ActionBarに表示するか、レイアウトに挿入することで使用可能です。AndroidのSearchViewウィジェットは、Android 3.0以降で利用可能です。以下にXMLレイアウトでSearchViewが定義されています。
<android.support.v7.widget.SearchView
android:id="@+id/search"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
Androidには、音声検索や候補など、さまざまな形式の検索方法があります。このチュートリアルでは、SearchView.OnQueryTextListenerとFilterableインターフェースを使用します。Filterableインターフェースは、ListView上のクエリテキストをフィルタリングし、結果のListView行を表示します。OnQueryTextListenerインターフェースは、2つのイベントを検出することができます。
-
- onQueryTextChangeは、ユーザーがテキストフィールドに各文字を入力するたびに呼び出されます。
- onQueryTextSubmitは、検索ボタンが押された時にトリガーされます。
アンドロイドのSearchViewの例
以下の画像は、最終的なAndroidのSearchViewのサンプルプロジェクトを示しています。このプロジェクトは、ListViewのためのアクティビティとアダプターから構成されています。
AndroidのSearchViewのサンプルコードの例
下記はactivity_main.xmlです。ListViewがあり、上部にはSearchViewが存在しています。
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="https://schemas.android.com/apk/res/android">
<RelativeLayout
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:orientation="horizontal">
<android.support.v7.widget.SearchView
android:id="@+id/search"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:clickable="true" />
<ListView
android:id="@+id/list_view"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_alignParentLeft="true"
android:layout_alignParentStart="true"
android:layout_below="@+id/search" />
</RelativeLayout>
</layout>
以下にMainActivity.javaが提供されています。
package com.scdev.searchview;
import android.databinding.DataBindingUtil;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.support.v7.widget.SearchView;
import com.scdev.searchview.databinding.ActivityMainBinding;
import java.util.ArrayList;
import java.util.List;
public class MainActivity extends AppCompatActivity {
ActivityMainBinding activityMainBinding;
ListAdapter adapter;
List<String> arrayList= new ArrayList<>();
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
activityMainBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);
arrayList.add("January");
arrayList.add("February");
arrayList.add("March");
arrayList.add("April");
arrayList.add("May");
arrayList.add("June");
arrayList.add("July");
arrayList.add("August");
arrayList.add("September");
arrayList.add("October");
arrayList.add("November");
arrayList.add("December");
adapter= new ListAdapter(arrayList);
activityMainBinding.listView.setAdapter(adapter);
activityMainBinding.search.setActivated(true);
activityMainBinding.search.setQueryHint("Type your keyword here");
activityMainBinding.search.onActionViewExpanded();
activityMainBinding.search.setIconified(false);
activityMainBinding.search.clearFocus();
activityMainBinding.search.setOnQueryTextListener(new SearchView.OnQueryTextListener() {
@Override
public boolean onQueryTextSubmit(String query) {
return false;
}
@Override
public boolean onQueryTextChange(String newText) {
adapter.getFilter().filter(newText);
return false;
}
});
}
}
上記のコードでは、リストアダプターに月のArrayListを渡しています。検索クエリのテキストが変更されるたびに、アダプタークラスで定義されているfilterメソッドを呼び出しています。ListAdapter.javaクラスは次のようになります。
package com.scdev.searchview;
import android.content.Context;
import android.databinding.DataBindingUtil;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.Filter;
import android.widget.Filterable;
import com.scdev.searchview.databinding.RowItemBinding;
import java.util.ArrayList;
import java.util.List;
public class ListAdapter extends BaseAdapter implements Filterable {
List<String> mData;
List<String> mStringFilterList;
ValueFilter valueFilter;
private LayoutInflater inflater;
public ListAdapter(List<String> cancel_type) {
mData=cancel_type;
mStringFilterList = cancel_type;
}
@Override
public int getCount() {
return mData.size();
}
@Override
public String getItem(int position) {
return mData.get(position);
}
@Override
public long getItemId(int position) {
return position;
}
@Override
public View getView(int position, View convertView, final ViewGroup parent) {
if (inflater == null) {
inflater = (LayoutInflater) parent.getContext()
.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
}
RowItemBinding rowItemBinding = DataBindingUtil.inflate(inflater, R.layout.row_item, parent, false);
rowItemBinding.stringName.setText(mData.get(position));
return rowItemBinding.getRoot();
}
@Override
public Filter getFilter() {
if (valueFilter == null) {
valueFilter = new ValueFilter();
}
return valueFilter;
}
private class ValueFilter extends Filter {
@Override
protected FilterResults performFiltering(CharSequence constraint) {
FilterResults results = new FilterResults();
if (constraint != null && constraint.length() > 0) {
List<String> filterList = new ArrayList<>();
for (int i = 0; i < mStringFilterList.size(); i++) {
if ((mStringFilterList.get(i).toUpperCase()).contains(constraint.toString().toUpperCase())) {
filterList.add(mStringFilterList.get(i));
}
}
results.count = filterList.size();
results.values = filterList;
} else {
results.count = mStringFilterList.size();
results.values = mStringFilterList;
}
return results;
}
@Override
protected void publishResults(CharSequence constraint,
FilterResults results) {
mData = (List<String>) results.values;
notifyDataSetChanged();
}
}
}
上記のコードで見るように、Filterクラスを拡張した内部クラスValueFilterを使用してフィルタリングを行っています。これは、検索クエリテキストがArrayListで与えられた文字列と一致するかどうかを確認してリストをフィルタリングします。ListViewの行のためのXMLレイアウトは以下に示されています。row_item.xml
<layout xmlns:android="https://schemas.android.com/apk/res/android">
<RelativeLayout
android:layout_width="match_parent"
android:layout_height="wrap_content">
<TextView
android:id="@+id/stringName"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_alignParentLeft="true"
android:layout_alignParentStart="true"
android:layout_centerVertical="true"
android:padding="@dimen/activity_horizontal_margin"
android:textAllCaps="false"
android:textAppearance="?android:attr/textAppearanceMedium" />
</RelativeLayout>
</layout>
以下は、Androidの検索ビューアプリの動作結果です。上記に表示されているSearchViewは、テキストフィールドをアクティブにするために検索アイコンを押す必要があります。また、ヒント/プレースホルダーテキストは含まれていません。デフォルトでSearchViewを有効にし、ヒントを表示するには、MainActivityに以下のコードを追加してください。
activityMainBinding.search.setActivated(true);
activityMainBinding.search.setQueryHint("Type your keyword here");
activityMainBinding.search.onActionViewExpanded();
activityMainBinding.search.setIconified(false);
activityMainBinding.search.clearFocus();
上記のカスタマイズ後のSearchViewは、次のようになります。これでAndroidのSearchViewチュートリアルは終わりです。後のチュートリアルでは、SearchViewの高度な機能について説明します。以下のリンクからAndroid SearchViewプロジェクトをダウンロードすることができます。
AndroidのSearchViewの例プロジェクトをダウンロードする。
