【Android】ListViewでチェック済みアイテムをすべて取得する方法を徹底解説

はじめに

この記事では、AndroidアプリのListViewでチェックされたすべてのアイテムを取得する方法を、実際に動作するサンプルプロジェクトを通じて段階的に解説します。CheckBoxを組み込んだカスタムアダプターの作成から、全選択・全解除ボタンの実装まで、初心者の方でも理解できるよう丁寧に説明していきます。

ステップ1：新規プロジェクトの作成

まず、Android Studioを起動し、File ⇒ New Projectから新しいプロジェクトを作成します。必要な項目をすべて入力してプロジェクトをセットアップしましょう。

ステップ2：メインレイアウト（activity_main.xml）の作成

次に、res/layout/activity_main.xmlに以下のコードを追加します。このレイアウトには、全選択用のボタンとListViewが含まれています。

<?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:orientation="vertical"
   tools:context="MainActivity">
   <LinearLayout
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:gravity="center"
      android:orientation="horizontal">
   <Button
      android:id="@+id/viewCheckedItem"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Select all" />
   </LinearLayout>
   <ListView
      android:id="@+id/listView"
      android:layout_width="match_parent"
      android:layout_height="0dp"
      android:layout_marginTop="30dp"
      android:layout_weight="1">
   </ListView>
</LinearLayout>

ステップ3：カスタムアダプター（CustomAdapter.java）の作成

ListViewにCheckBoxを表示するために、CustomAdapter.javaというJavaクラスを作成し、以下のコードを記述します。ViewHolderパターンを使用することで、リストのスクロール性能を向上させています。各CheckBoxのクリックイベントで、対応するモデルの選択状態を切り替える仕組みです。

import android.annotation.SuppressLint;
import android.content.Context;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.CheckBox;
import android.widget.TextView;
import android.widget.Toast;
import java.util.ArrayList;
import java.util.Objects;
class CustomAdapter extends BaseAdapter {
   private Context context;
   private static ArrayList<Model> modelArrayList;
   CustomAdapter(Context context, ArrayList<Model> modelArrayList) {
      this.context = context;
      CustomAdapter.modelArrayList = modelArrayList;
   }
   @Override
   public int getViewTypeCount() {
      return getCount();
   }
   @Override
   public int getItemViewType(int position) {
      return position;
   }
   @Override
   public int getCount() {
      return modelArrayList.size();
   }
   @Override
   public Object getItem(int position) {
      return modelArrayList.get(position);
   }
   @Override
      public long getItemId(int position) {
      return 0;
   }
   @SuppressLint("InflateParams")
   @Override
   public View getView(int position, View convertView, ViewGroup parent) {
      final ViewHolder holder;
      if (convertView == null) {
         holder = new ViewHolder();
         LayoutInflater inflater = (LayoutInflater)
         context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
         convertView = Objects.requireNonNull(inflater).inflate(R.layout.listitem, null, true);
         holder.checkBox = convertView.findViewById(R.id.checkBox);
         holder.tvPlayer = convertView.findViewById(R.id.playerNameList);
         convertView.setTag(holder);
      } else {
         holder = (ViewHolder) convertView.getTag();
      }
      holder.checkBox.setText("Checkbox " + position);
      holder.tvPlayer.setText(modelArrayList.get(position).getPlayer());
      holder.checkBox.setChecked(modelArrayList.get(position).getSelected());
      holder.checkBox.setTag(R.integer.btnPlusView, convertView);
      holder.checkBox.setTag(position);
      holder.checkBox.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            Integer pos = (Integer) holder.checkBox.getTag();
            Toast.makeText(context, "Checkbox " +pos+ "Clicked!",
            Toast.LENGTH_SHORT).show();
            if (modelArrayList.get(pos).getSelected()) {
               modelArrayList.get(pos).setSelected(false);
            } else {
               modelArrayList.get(pos).setSelected(true);
            }
         }
      });
      return convertView;
   }
   private class ViewHolder {
      CheckBox checkBox;
      private TextView tvPlayer;
   }
}

ステップ4：モデルクラス（Model.java）の作成

次に、各リスト項目のデータを保持するためのModel.javaクラスを作成します。このクラスは、プレイヤー名とチェック状態（選択フラグ）を管理します。

class Model {
   private boolean isSelected;
   private String player;
   String getPlayer() {
      return player;
   }
   void setPlayer(String player) {
      this.player = player;
   }
   boolean getSelected() {
      return isSelected;
   }
   void setSelected(boolean selected) {
      isSelected = selected;
   }
}

ステップ5：strings.xmlへの定義追加

res/values/strings.xmlに以下のコードを追加します。ここでは、CheckBoxのタグ管理に使用する整数リソースを定義しています。

<resources>
   <string name="app_name">Sample</string>
   <integer name="btnPlusView">1</integer>
   <integer name="btnPlusPos">2</integer>
</resources>

ステップ6：リスト項目レイアウト（listItem.xml）の作成

ListViewの各行の見た目を定義するため、listItem.xmlというレイアウトファイルを作成し、以下のコードを追加します。CheckBoxとTextViewを横並びに配置したシンプルな構成です。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
   android:orientation="horizontal" android:layout_width="match_parent"
   android:layout_height="match_parent">
   <CheckBox
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:id="@+id/checkBox" />
       <TextView
           android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:id="@+id/playerNameList"
           android:layout_marginStart="20dp"
           android:textSize="20sp" />
</LinearLayout>

ステップ7：MainActivity.javaの実装

最後に、アプリのメイン処理となるsrc/MainActivity.javaに以下のコードを追加します。このアクティビティでは、サッカー選手のリストを表示し、「全選択」ボタンと「全解除」ボタンでチェック状態を一括操作できるようにしています。

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.ListView;
import android.widget.Toast;
import java.util.ArrayList;
public class MainActivity extends AppCompatActivity {
   private ListView listView;
   private ArrayList<Model> modelArrayList;
   private CustomAdapter customAdapter;
   Button btnSelect, btnDeselect;
   public static String[] playerList = new String[]{"Sunil Chetri - INDIA",
      "Cristiano Ronaldo - Portugal",
      "Lionel Messi - Argentina",
      "Neymar Jr - Brazil",
      "Eden Hazard - Belgium",
      "Gigi Buffon - Italy",
      "James Rodrigues - Columbia",
      "Sadio Mane - Senegal",
      "Toni Kroos - Germany"};
      @Override
      protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
         listView = findViewById(R.id.listView);
         btnSelect = findViewById(R.id.viewCheckedItem);
         btnDeselect = findViewById(R.id.deSelect);
         modelArrayList = getModel(false);
         customAdapter = new CustomAdapter(MainActivity.this, modelArrayList);
         listView.setAdapter(customAdapter);
         btnSelect.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
               modelArrayList = getModel(true);
               customAdapter = new CustomAdapter(MainActivity.this, modelArrayList);
               listView.setAdapter(customAdapter);
               Toast.makeText(getApplicationContext(), "Checked all items",
               Toast.LENGTH_SHORT).show();
            }
         });
         btnDeselect.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
               modelArrayList = getModel(false);
               customAdapter = new CustomAdapter(MainActivity.this,modelArrayList);
               listView.setAdapter(customAdapter);
               Toast.makeText(getApplicationContext(), "Unchecked all items",
               Toast.LENGTH_SHORT).show();
            }
         });
      }
      private ArrayList<Model> getModel(boolean isSelect) {
         ArrayList<Model>list = new ArrayList<>();
         for (int i = 0; i < 9; i++) {
            Model model = new Model();
            model.setSelected(isSelect);
            model.setPlayer(playerList[i]);
            list.add(model);
         }
         return list;
      }
   }

ステップ8：AndroidManifest.xmlの設定

androidManifest.xmlに以下のコードを追加して、MainActivityをランチャーアクティビティとして登録します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
   package="app.com.sample">
   <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（実行）アイコンをクリックします。デバイスの選択画面で自分のモバイル端末を選択すると、端末に以下のようなデフォルト画面が表示されます。

まとめ

このように、カスタムアダプターとモデルクラスを組み合わせることで、ListView内の各アイテムのチェック状態を簡単に管理できます。チェック済みアイテムを取得したい場合は、ModelクラスのgetSelected()メソッドがtrueを返す要素をリストから抽出するだけで実現可能です。ぜひ本記事のコードを参考に、ご自身のアプリ開発に役立ててください。