Android
 Computer >> コンピューター >  >> プログラミング >> Android

KotlinでAndroidのListViewに検索機能を実装する方法をわかりやすく解説

この記事では、Kotlinを使ってAndroidアプリのListView(リストビュー)に検索機能を実装する方法を、実際のサンプルコードとともに段階的に解説します。EditTextに入力されたテキストに応じて、リストの項目がリアルタイムで絞り込まれる仕組みを作ります。

完成イメージ

画面上部に検索用の入力欄(EditText)を配置し、その下に月名の一覧を表示するListViewを設置します。検索欄に文字を入力すると、一致する項目だけがリストに表示されるようになります。

手順1:新規プロジェクトを作成する

Android Studioを起動し、「File」→「New Project」を選択して、必要な情報を入力して新しいプロジェクトを作成します。テンプレートは「Empty Activity」で問題ありません。

手順2:レイアウトファイル(activity_main.xml)を編集する

res/layout/activity_main.xml に以下のコードを記述します。検索用のEditTextと、一覧表示用のListViewを配置しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="4dp"
    tools:context=".MainActivity">
    <EditText
        android:id="@+id/etSearch"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="ここに入力して検索" />
    <ListView
        android:id="@+id/listView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_below="@id/etSearch" />
</RelativeLayout>

手順3:MainActivity.ktにロジックを実装する

src/MainActivity.kt に以下のコードを記述します。ポイントは、EditTextにTextWatcherを設定し、テキストが変更されるたびにArrayAdapterのfilterメソッドを呼び出してリストを絞り込んでいる点です。

import android.os.Bundle
import android.text.Editable
import android.text.TextWatcher
import android.widget.ArrayAdapter
import android.widget.EditText
import android.widget.ListView
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {
    lateinit var listView: ListView
    var months: ArrayList<String> = ArrayList()
    var arrayAdapter: ArrayAdapter<String>? = null
    lateinit var etSearch: EditText

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        title = "KotlinApp"
        listView = findViewById(R.id.listView)
        etSearch = findViewById(R.id.etSearch)

        months.add("January")
        months.add("February")
        months.add("March")
        months.add("April")
        months.add("May")
        months.add("June")
        months.add("July")
        months.add("August")
        months.add("September")
        months.add("October")
        months.add("November")
        months.add("December")

        arrayAdapter = ArrayAdapter(this, android.R.layout.simple_list_item_1, android.R.id.text1, months)
        listView.adapter = arrayAdapter

        etSearch.addTextChangedListener(object : TextWatcher {
            override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {}
            override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
                arrayAdapter!!.filter.filter(s)
            }
            override fun afterTextChanged(s: Editable) {}
        })
    }
}

コードのポイント

  • TextWatcher:EditTextのテキスト変化を監視するインターフェースです。onTextChanged内でフィルタ処理を実行します。
  • arrayAdapter.filter.filter(s):ArrayAdapterが標準で持つフィルタ機能を使い、入力文字列に部分一致する項目だけを表示します。
  • lateinit:後から初期化するView変数に対して使用しています。

手順4:AndroidManifest.xmlを確認する

androidManifest.xml は以下のようになっています。特別な権限は不要ですが、MainActivityがランチャーアクティビティとして登録されていることを確認してください。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="com.example.q11">
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認する

それではアプリを実行してみましょう。実機のAndroidスマートフォンをパソコンに接続していることを前提に説明します。Android Studioでプロジェクト内のアクティビティファイルを開き、ツールバーの「Run(実行)」アイコンをクリックします。デバイスの選択ダイアログが表示されたら、接続したモバイル端末を選択してください。

アプリが起動すると、まず12か月分の月名が一覧表示されます。次に、上部の検索欄に「Ma」などと入力すると、該当する「March」「May」だけがリアルタイムに絞り込まれて表示されます。

まとめ

Kotlinでは、TextWatcherとArrayAdapterのfilter機能を組み合わせるだけで、少ないコード量でListViewの検索・絞り込み機能を実現できます。カスタムアダプターを使用する場合も、BaseAdapterのgetFilter()をオーバーライドすることで同様の検索機能を実装できるので、応用としてぜひ試してみてください。

  1. AndroidでListViewにカスタムアダプターを追加する方法を徹底解説

    この記事では、AndroidアプリのListViewにカスタムアダプター(BaseAdapter)を実装する方法を、サンプルプロジェクトのコードとともにステップ形式で解説します。リストの各行に「番号」「名前」「電話番号」を表示するシンプルな連絡先リストを作成しながら、カスタムアダプターの基本的な仕組みを学びましょう。カスタムアダプターとは?ListViewは、データの一覧をスクロール可能な形で表示するためのUIコンポーネントです。デフォルトの ArrayAdapter では単純なテキストしか表示できませんが、BaseAdapter を継承したカスタムアダプターを使えば、複数の TextView

  2. AndroidのカスタムListViewに検索機能を実装する方法【サンプルコード付き】

    はじめに このチュートリアルでは、AndroidアプリのListView(リストビュー)に検索機能を実装する方法を解説します。EditTextに入力した文字列に応じて、表示中のリスト項目をリアルタイムで絞り込む仕組みを作成します。 手順1:新規プロジェクトを作成する Android Studioを開き、「File」→「New Project」を選択して、必要な項目をすべて入力し、新しいプロジェクトを作成します。 手順2:レイアウトファイル(activity_main.xml)を編集する res/layout/activity_main.xml に以下のコードを記述します。上部に検索ワードを入力