AndroidアプリでAutoCompleteTextViewを使う方法！入力補完機能の実装手順を解説

AutoCompleteTextViewとは？

AutoCompleteTextViewは、ユーザーが文字を入力すると、あらかじめ用意した候補リストから自動的に補完候補をドロップダウン形式で表示してくれるビューです。EditTextを継承しており、検索ボックスやフォーム入力などで活用することで、ユーザーの入力の手間を大幅に減らせます。

この記事では、AndroidアプリでAutoCompleteTextViewを使って入力補完機能を実装する手順を、サンプルコード付きでステップごとに解説します。

実装手順

ステップ1：新規プロジェクトを作成する

Android Studioを開き、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。

ステップ2：レイアウトファイル（activity_main.xml）にコードを追加する

res/layout/activity_main.xml に以下のコードを記述します。ここではAppCompatAutoCompleteTextViewを使用し、ヒントテキストとして「Enter fruit name（果物名を入力）」を設定しています。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout 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:layout_margin="16dp"
    android:orientation="vertical"
    tools:context=".MainActivity">

    <android.support.v7.widget.AppCompatAutoCompleteTextView
        android:id="@+id/autoTextView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="Enter fruit name"
        android:textColor="#000000"
        android:textColorHint="#000000" />
</LinearLayout>

ステップ3：MainActivity.javaにコードを追加する

src/MainActivity.java に以下のコードを記述します。果物名の配列をArrayAdapterに渡し、AutoCompleteTextViewにアダプターをセットしています。

package app.tutorialspoint.com.sample;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.AppCompatAutoCompleteTextView;
import android.widget.ArrayAdapter;

public class MainActivity extends AppCompatActivity {

    private String[] fruits = {"Apple", "Banana", "Cherry", "Date", "Grape", "Kiwi", "Mango", "Pear"};

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        AppCompatAutoCompleteTextView autoTextView = findViewById(R.id.autoTextView);
        ArrayAdapter<String> adapter = new ArrayAdapter<>(this,
                android.R.layout.select_dialog_item, fruits);

        autoTextView.setThreshold(1); // 1文字目の入力時点で補完候補を表示
        autoTextView.setAdapter(adapter);
    }
}

ポイントはsetThreshold(1)の部分です。このメソッドは、何文字入力された時点で補完候補を表示し始めるかを指定します。「1」を設定しているため、最初の1文字を入力した瞬間に候補リストが表示されます。たとえば「A」と入力すれば「Apple」が候補として現れます。

ステップ4：AndroidManifest.xmlにコードを追加する

androidManifest.xml に以下のコードを記述します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="app.tutorialspoint.com.sample">

    <uses-permission android:name="android.permission.VIBRATE" />

    <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」アイコンをクリックします。一覧から接続中のモバイルデバイスを選択すると、端末の画面に以下のようにAutoCompleteTextViewが表示されます。

テキストフィールドに文字を入力すると、入力内容に一致する果物名の候補がドロップダウンリストに表示され、タップすることで簡単に入力を完了できます。