Обробка вибору елемента в RecyclerView

При роботі з віджетом RecyclerView неминуче виникає питання, як обробляти вибір елемента в RecyclerView. І тут слід зазначити, що на відміну від інших типів віджетів для роботи зі списками, RecyclerView за замовчуванням не надає якогось спеціального методу, за допомогою якого можна було б визначити слухач на натискання на елемент у списку. Тому всю інфраструктуру необхідно визначати самому розробнику. Але на щастя, на практиці все не так складно. Для прикладу візьмемо проект з попередньої теми:

package com.example.listapp;

public class State {

    private String name; // назва
    private String capital;  // столиця
    private int flagResource; // ресурс прапора

    public State(String name, String capital, int flag){

        this.name=name;
        this.capital=capital;
        this.flagResource=flag;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getCapital() {
        return this.capital;
    }

    public void setCapital(String capital) {
        this.capital = capital;
    }

    public int getFlagResource() {
        return this.flagResource;
    }

    public void setFlagResource(int flagResource) {
        this.flagResource = flagResource;
    }
}

Клас State містить поля для збереження назви та столиці країни, а також посилання на ресурс зображення прапора країни. В даному випадку передбачається, що в папці res/drawable знаходяться файли зображень прапорів для використаних країн.

У папці res/layout для виведення одного об'єкта State в списку визначений наступний файл list_item.xml:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="wrap_content">
    <ImageView
        android:id="@+id/flag"
        android:layout_width="70dp"
        android:layout_height="50dp"
        android:layout_marginTop="16dp"
        android:layout_marginBottom="16dp"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toLeftOf="@+id/name"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent" />

    <TextView
        android:id="@+id/name"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_marginLeft="16dp"
        android:text="Назва"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintLeft_toRightOf="@+id/flag"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toTopOf="@+id/capital" />

    <TextView
        android:id="@+id/capital"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_marginLeft="16dp"
        android:text="Столиця"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintLeft_toRightOf="@+id/flag"
        app:layout_constraintTop_toBottomOf="@+id/name"
        app:layout_constraintBottom_toBottomOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

Тепер перейдемо до класу StateAdapter і наступним чином визначимо його код:

package com.example.listapp;

import android.content.Context;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ImageView;
import android.widget.TextView;
import androidx.recyclerview.widget.RecyclerView;

import java.util.List;

public class StateAdapter  extends RecyclerView.Adapter<StateAdapter.ViewHolder>{

    interface OnStateClickListener{
        void onStateClick(State state, int position);
    }

    private final OnStateClickListener onClickListener;

    private final LayoutInflater inflater;
    private final List<State> states;

    StateAdapter(Context context, List<State> states, OnStateClickListener onClickListener) {
        this.onClickListener = onClickListener;
        this.states = states;
        this.inflater = LayoutInflater.from(context);
    }

    @Override
    public StateAdapter.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {

        View view = inflater.inflate(R.layout.list_item, parent, false);
        return new ViewHolder(view);
    }

    @Override
    public void onBindViewHolder(StateAdapter.ViewHolder holder, int position) {
        State state = states.get(position);
        holder.flagView.setImageResource(state.getFlagResource());
        holder.nameView.setText(state.getName());
        holder.capitalView.setText(state.getCapital());

        holder.itemView.setOnClickListener(new View.OnClickListener(){
            @Override
            public void onClick(View v)
            {
                onClickListener.onStateClick(state, position);
            }
        });
    }

    @Override
    public int getItemCount() {
        return states.size();
    }

    public static class ViewHolder extends RecyclerView.ViewHolder {
        final ImageView flagView;
        final TextView nameView, capitalView;
        ViewHolder(View view){
            super(view);
            flagView = view.findViewById(R.id.flag);
            nameView = view.findViewById(R.id.name);
            capitalView = view.findViewById(R.id.capital);
        }
    }
}

Тут я зупинюся на тих моментах, які були додані порівняно з кодом з попередньої статті.

Передусім потрібно визначити інтерфейс слухача події натискання. Для цього в класі StateAdapter визначено інтерфейс:

interface OnStateClickListener{
    void onStateClick(State state, int position);
}

Інтерфейс визначає один метод onStateClick(), який, як передбачається, буде викликатися при виборі об'єкта State і який отримає вибраний об'єкт State та його позицію в списку.

Наступний момент - визначення в класі адаптера змінної для збереження об'єкта цього інтерфейсу та отримання для неї значення в конструкторі:

private final OnStateClickListener onClickListener;

StateAdapter(Context context, List<State> states, OnStateClickListener onClickListener) {
    this.onClickListener = onClickListener;
    // ........................
}

Таким чином, поза кодом адаптера ми можемо встановити будь-який об'єкт слухача і передати його в адаптер.

І третій момент - виклик методу слухача при натисканні на елемент у списку в методі onBindViewHolder:

public void onBindViewHolder(StateAdapter.ViewHolder holder, int position) {
    State state = states.get(position);
    holder.flagView.setImageResource(state.getFlagResource());
    holder.nameView.setText(state.getName());
    holder.capitalView.setText(state.getCapital());

    // обробка натискання
    holder.itemView.setOnClickListener(new View.OnClickListener(){
        @Override
        public void onClick(View v)
        {
            // викликаємо метод слухача, передаючи йому дані
            onClickListener.onStateClick(state, position);
        }
    });
}

Клас ViewHolder має поле itemView, яке представляє інтерфейс для одного об'єкта в списку і фактично є об'єктом View. А в цього об'єкта є метод setOnClickListener(), через який можна підключити стандартний слухач натискання OnClickListener і в його методі onClick() викликати метод нашого інтерфейсу, передавши йому необхідні дані - вибраний об'єкт State та його позицію в списку.

Може виникнути питання, чому б не обробляти натискання на елемент безпосередньо тут? Навіщо створювати додатковий інтерфейс, його змінну і викликати його метод? Звісно, ми можемо спробувати безпосередньо обробити натискання тут, але це не є гарною або поширеною практикою, оскільки, можливо, ми захочемо визначити обробку натискання в класі MainActivity, виходячи з того коду, який там визначений (або з якогось іншого місця ззовні).

У файлі activity_main.xml залишається той самий візуальний інтерфейс:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="16dp">
    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/list"
        android:layout_width="0dp"
        android:layout_height="0dp"
         
        app:layoutManager="androidx.recyclerview.widget.LinearLayoutManager"
         
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintBottom_toBottomOf="parent"/>
</androidx.constraintlayout.widget.ConstraintLayout>

І наприкінці змінимо клас MainActivity:

package com.example.listapp;

import androidx.appcompat.app.AppCompatActivity;
import androidx.recyclerview.widget.RecyclerView;
import android.os.Bundle;
import android.widget.Toast;
import java.util.ArrayList;

public class MainActivity extends AppCompatActivity {

    ArrayList<State> states = new ArrayList<State>();

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

        // початкова ініціалізація списку
        setInitialData();

        RecyclerView recyclerView = findViewById(R.id.list);

        // визначаємо слухача натискання елемента у списку
        StateAdapter.OnStateClickListener stateClickListener = new StateAdapter.OnStateClickListener() {
            @Override
            public void onStateClick(State state, int position) {
                // показуємо спливаюче повідомлення з назвою країни
                Toast.makeText(getApplicationContext(), "Був вибраний пункт " + state.getName(),
                        Toast.LENGTH_SHORT).show();
            }
        };

        // створюємо адаптер і передаємо йому слухача
        StateAdapter adapter = new StateAdapter(this, states, stateClickListener);

        // встановлюємо адаптер для RecyclerView
        recyclerView.setAdapter(adapter);
    }

    // метод для додавання початкових даних
    private void setInitialData(){
        states.add(new State("Бразилія", "Бразиліа", R.drawable.brazilia));
        states.add(new State("Аргентина", "Буенос-Айрес", R.drawable.argentina));
        states.add(new State("Колумбія", "Богота", R.drawable.columbia));
        states.add(new State("Уругвай", "Монтевідео", R.drawable.uruguai));
        states.add(new State("Чилі", "Сантьяго", R.drawable.chile));
    }
}

Під час створення адаптера йому передається визначений у класі MainActivity слухач:

StateAdapter.OnStateClickListener stateClickListener = new StateAdapter.OnStateClickListener() {
    @Override
    public void onStateClick(State state, int position) {
 
        Toast.makeText(getApplicationContext(), "Був обраний пункт " + state.getName(),  
                        Toast.LENGTH_SHORT).show();
    }
};

Тут просто виводиться спливаюче повідомлення про обраний елемент списку.

Edit this page on GitHub

Lesson3RecyclerView

Lesson3Стилі