Androidアプリ開発

RecyclerView スワイプ操作で画面遷移

この記事は約21分で読めます。
記事内に広告が含まれています。
スポンサーリンク

この記事は Androidスマホ用のアプリ開発の中で、
今後の開発で再使用性が高いと思われるコーディングをまとめたものです。
Java での開発経験、XML構文規則、Android のアプリ開発経験がある方を対象としています。
Android のアプリ開発でお役にたててれば、嬉しいです。
(これから Android のアプリ開発や Java での開発を始めたい方への案内は、
記事の最後で紹介します)

この記事のテーマ


RecyclerViewでアイテムのスワイプ操作で画面を遷移する

ポイント

RecyclerViewでスワイプ操作を実装する場合、ItemTouchHelperを使った実装になります。
ItemTouchHelperのスワイプ(onSwiped)は、アイテムがリストから消滅した時点でイベント発生します。
スワイプ
アイテムの削除とした場合は問題ありませんが、選択したアイテムで画面遷移とする場合に違和感があります。
今回は、スワイプ操作でアイテムがリストから消滅しない、選択したアイテムで画面遷移する実装を紹介します。

ItemTouchHelperについて

スワイプヘルパー

スワイプ操作でアイテムがリストからを消滅しない、スワイプ操作をイベント処理できるスワイプヘルパーを作成します。
リストからを消滅しないように、スワイプのアニメーションで空白を描画することで再現します。
また、スワイプ後に元に戻すためのキューを用意します。
スワイプ操作のイベント処理は、空白を描画したことをフックするようにします。

public abstract class SwipeHelper extends ItemTouchHelper.SimpleCallback {
    public static final int         SWIPE_WIDTH = 80;
    private final VerticalListView  verticalListView;
    private List<SwipeArea>         areas;
    private final GestureDetector   gestureDetector;
    private int                     swipedPos = -1;
    private float                   swipeThreshold = 0.5f;
    private final Map<Integer, List<SwipeArea>>
                                    areasBuffer;
    private final Queue<Integer>    recoverQueue;

    @SuppressLint("ClickableViewAccessibility")
    public SwipeHelper(Context context, VerticalListView verticalListView) {
        super(0, ItemTouchHelper.RIGHT);
        this.verticalListView = verticalListView;
        this.areas = new ArrayList<>();
        GestureDetector.SimpleOnGestureListener gestureListener = new GestureDetector.SimpleOnGestureListener() {
            @Override
            public boolean onSingleTapConfirmed(MotionEvent e) {
                return true;
            }
        };
        this.gestureDetector = new GestureDetector(context, gestureListener);
        View.OnTouchListener onTouchListener = new View.OnTouchListener() {
            @Override
            public boolean onTouch(View view, MotionEvent e) {
                if (swipedPos < 0) return false;
                Point point = new Point((int) e.getRawX(), (int) e.getRawY());
                RecyclerView.ViewHolder swipedViewHolder = verticalListView.findViewHolderForAdapterPosition(swipedPos);
                View swipedItem = Objects.requireNonNull(swipedViewHolder).itemView;
                Rect rect = new Rect();
                swipedItem.getGlobalVisibleRect(rect);
                if (e.getAction() == MotionEvent.ACTION_DOWN || e.getAction() == MotionEvent.ACTION_UP || e.getAction() == MotionEvent.ACTION_MOVE) {
                    if (rect.top < point.y && rect.bottom > point.y) {
                        gestureDetector.onTouchEvent(e);
                    } else {
                        recoverQueue.add(swipedPos);
                        swipedPos = -1;
                        recoverSwipedItem();
                    }
                }
                return false;
            }
        };
        this.verticalListView.setOnTouchListener(onTouchListener);
        areasBuffer = new HashMap<>();
        recoverQueue = new LinkedList<Integer>() {
            @Override
            public boolean add(Integer o) {
                if (contains(o))
                    return false;
                else
                    return super.add(o);
            }
        };
        attachSwipe();
    }
    @Override
    public boolean onMove(@NonNull RecyclerView recyclerView, @NonNull RecyclerView.ViewHolder viewHolder, @NonNull RecyclerView.ViewHolder target) {
        return false;
    }
    @Override
    public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) {
        int pos = viewHolder.getBindingAdapterPosition();
        if (swipedPos != pos) {
            recoverQueue.add(swipedPos);
        }
        swipedPos = pos;
        if (areasBuffer.containsKey(swipedPos)) {
            areas = areasBuffer.get(swipedPos);
            if (areas != null) areas.get(0).onSwipe(pos);
        } else {
            areas.clear();
        }
        areasBuffer.clear();
        swipeThreshold = 0.5f * areas.size() * SWIPE_WIDTH;
        recoverSwipedItem();
    }
    @Override
    public float getSwipeThreshold(@NonNull RecyclerView.ViewHolder viewHolder) {
        return swipeThreshold;
    }
    @Override
    public float getSwipeEscapeVelocity(float defaultValue) {
        return 0.1f * defaultValue;
    }
    @Override
    public float getSwipeVelocityThreshold(float defaultValue) {
        return 5.0f * defaultValue;
    }
    @Override
    public void onChildDraw(@NonNull Canvas c, @NonNull RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, float dX, float dY, int actionState, boolean isCurrentlyActive) {
        int pos = viewHolder.getBindingAdapterPosition();
        float translationX = dX;
        View itemView = viewHolder.itemView;
        if (pos < 0){
            swipedPos = pos;
            return;
        }
       if (actionState == ItemTouchHelper.ACTION_STATE_SWIPE) {
            if(dX > 0) {
                List<SwipeArea> buffer = new ArrayList<>();
                if (!areasBuffer.containsKey(pos)){
                    instantiateUnderlaySwipe(viewHolder, buffer);
                    areasBuffer.put(pos, buffer);
                } else {
                    buffer = areasBuffer.get(pos);
                }
                translationX = dX * Objects.requireNonNull(buffer).size() * SWIPE_WIDTH / itemView.getWidth();
                drawAreas(c, itemView, buffer, translationX);
            }
        }
        super.onChildDraw(c, recyclerView, viewHolder, translationX, dY, actionState, isCurrentlyActive);
    }
    private void drawAreas(Canvas c, View itemView, List<SwipeArea> buffer, float dX) {
        float left = itemView.getLeft();
        float swipeWidth = (-1) * dX / buffer.size();
        for (SwipeArea area : buffer) {
            float right = left - swipeWidth;
            area.onDraw(c, new RectF(left, itemView.getTop(), right, itemView.getBottom()));
            left = right;
        }
    }
    private synchronized void recoverSwipedItem(){
        while (!recoverQueue.isEmpty()){
            @SuppressWarnings("ConstantConditions")
            int pos = recoverQueue.poll();
            if (pos > -1) {
                if (verticalListView.getAdapter() != null) {
                    verticalListView.getAdapter().notifyItemChanged(pos);
                }
            }
        }
    }
    public void attachSwipe(){
        ItemTouchHelper itemTouchHelper = new ItemTouchHelper(this);
        itemTouchHelper.attachToRecyclerView(verticalListView);
    }
    public abstract void instantiateUnderlaySwipe(RecyclerView.ViewHolder viewHolder, List<SwipeArea> swipeAreas);

    public static class SwipeArea {
        private final int color;
        Context context;
        private final SwipeHelper.onDrawListener onDrawListener;
        public SwipeArea(Context context, int color, SwipeHelper.onDrawListener onDrawListener) {
            this.color = color;
            this.context = context;
            this.onDrawListener = onDrawListener;
        }
        public void onDraw(Canvas c, RectF rect){
            Paint p = new Paint();
            p.setColor(color);
            c.drawRect(rect, p);
            p.setColor(Color.WHITE);
        }
        public void onSwipe(int pos) {
            onDrawListener.onSwipe(pos);
        }
    }
    public interface onDrawListener {
        void onSwipe(int pos);
    }
}

VerticalListViewは、RecyclerViewを継承したカスタムクラスです。

アイテムのスワイプ操作で画面遷移する

RecyclerViewにSwipeHelperをアタッチすることで、アイテムのスワイプでアイテムの選択と画面遷移します。
SwipeHelperは、コンストラクタでRecyclerView(サンプルでは、VerticalListView)をアタッチします。
空白を描画したタイミングをインタフェースを使って、選択したアイテムで画面遷移を記述します。

    private VerticalListView        catalogView;
    private VerticalListView.Adapter
                                    catalogAdapter;

     :
        catalogAdapter = new VerticalListView.ArrayAdapter(catalogList) {
            @Override
            public View getView(ViewGroup parent) {
                return LayoutInflater.from(parent.getContext()).inflate(R.layout.item_vertical, parent, false);
            }
            @SuppressLint("ClickableViewAccessibility")
            @Override
            public void onBindView(View view, Object data, int position) {
                // コマンドボタン
                Button command = view.findViewById(R.id.command);
                command.setOnClickListener(view1 -> {
          :
                  // コマンドボタンをクリックしたときの処理
                });
                // タイトル
                TextView textView1 = view.findViewById(R.id.text_item);
                textView1.setOnClickListener(view12 -> {
                  :
                  // タイトルをクリックしたときの処理
                });
            }
        };
        catalogView.initialize(context);
        catalogView.setAdapter(catalogAdapter);
        new SwipeHelper(getContext(), catalogView) {
            @Override
            public void instantiateUnderlaySwipe(RecyclerView.ViewHolder viewHolder, List<SwipeArea> swipeAreas) {
                swipeAreas.add(new SwipeArea(
                        getContext(),
                        Color.TRANSPARENT,
                        position -> {
                :   
                           // 選択したアイテムで画面遷移する処理 
                        }
                ));
            }
            @Override
            public int getMovementFlags(@NonNull RecyclerView recyclerView, @NonNull RecyclerView.ViewHolder viewHolder) {
                int swipeFlags = operation ? ItemTouchHelper.RIGHT : 0;
                return makeMovementFlags(0, swipeFlags);
            }
        };

VerticalListViewは、RecyclerViewを継承したカスタムクラスです。

アイテムのスワイプ操作を無効にする

ItemTouchHelper.CallbackgetMovementFlagsでスワイプを無効にします。
サンプルでは、operation が false
の場合、スワイプを無効にしています。

今回は、ここまでです。

RecyclerViewでアイテムのスワイプで画面遷移にしているAndroidアプリです。

いまやGPS受信機はかなりお安く買えます。位置情報だけでなく時刻合わせにも使用できます♪

誤字脱字、意味不明でわかりづらい、
もっと詳しく知りたいなどのご意見は、
このページの最後にある
コメントか、
こちらから、お願いいたします♪

ポチッとして頂けると、
次のコンテンツを作成する励みになります♪

ブログランキング・にほんブログ村へ

これからAndroidのアプリ開発やJavaでの開発を始めたい方へ

アプリケーション開発経験がない方や、アプリケーション開発経験がある方でも、Java や C# などのオブジェクト指向言語が初めての方は、Android のアプリ開発ができるようになるには、かなりの時間がかかります。
オンラインスクールでの習得を、強くおススメします。

未経験者からシステムエンジニアを目指すのに最適です。まずは無料相談から♪

未経験者からプログラマーを目指すのに最適です。まずは無料カウンセリングから♪

カリキュラムとサポートがしっかりしています。お得なキャンペーンとかいろいろやっています♪

ゲーム系に強いスクール、UnityやUnrealEngineを習得するのに最適です。まずは無料オンライン相談から♪

参考になったら、💛をポッとしてね♪