🏭 ⏳ 🤽 RecyclerView में खींचें और स्वाइप करें। भाग 1: आइटमटच हेल्पर 💌 🥓 🧒🏻

RecyclerView में खींचें और स्वाइप करें। भाग 1: आइटमटच हेल्पर

एंड्रॉइड में RecyclerView का उपयोग करके कई ट्यूटोरियल, लाइब्रेरी और ड्रैग एंड ड्रॉप और स्वाइप-टू-आउट कार्यान्वयन हैं । उनमें से अधिकांश अभी भी चित्रित View.OnDragListener और SwipeToDismiss दृष्टिकोण का उपयोग करते हैं, जो कि अल्बानिक द्वारा विकसित किया गया है। हालांकि नए और अधिक प्रभावी तरीके पहले से ही उपलब्ध हैं। बहुत कम ही नवीनतम APIs का उपयोग करते हैं, अक्सर GestureDetectors और onInterceptTouchEvent या अन्य अधिक जटिल कार्यान्वयन पर निर्भर होते हैं। वास्तव में, इन कार्यों को RecyclerView जोड़ने का एक बहुत ही सरल तरीका है। इसके लिए केवल एक वर्ग की आवश्यकता होती है, जो एंड्रॉइड सपोर्ट लाइब्रेरी का भी हिस्सा है।

ItemTouchHelper

ItemTouchHelper एक शक्तिशाली उपयोगिता है, जो आपके द्वारा ड्रैग एंड ड्रॉप को जोड़ने और RecyclerView कार्यों को स्वाइप- आउट करने के लिए स्वाइप करने की जरूरत है। यह उपयोगिता RecyclerView.ItemDecoration का एक उपवर्ग है, जिससे लगभग किसी भी मौजूदा LayoutManager और एडेप्टर को जोड़ना आसान हो जाता है। यह तत्व एनीमेशन के साथ भी काम करता है और सूची में तत्वों के एक प्रकार को दूसरी जगह खींचने और छोड़ने की क्षमता प्रदान करता है। इस लेख में, मैं ItemTouchHelper एक सरल कार्यान्वयन का प्रदर्शन ItemTouchHelper । बाद में, लेखों की इस श्रृंखला के हिस्से के रूप में, हम दायरे का विस्तार करेंगे और अन्य विकल्पों पर विचार करेंगे।

नोट। अभी परिणाम देखना चाहते हैं? Github देखें: Android-ItemTouchHelper-Demo । पहली प्रतिबद्ध इस लेख से संबंधित है। डेमो .apk फ़ाइल यहाँ डाउनलोड की जा सकती है ।

उदाहरण

समायोजन

पहले हमें RecyclerView को कॉन्फ़िगर करना होगा। यदि आपने पहले से ऐसा नहीं किया है, तो अपनी build.gradle . build.gradle फ़ाइल में RecyclerView निर्भरता जोड़ें।

 compile 'com.android.support:recyclerview-v7:22.2.0'

ItemTouchHelper लगभग किसी भी RecyclerView.Adapter और LayoutManager साथ काम करेगा, लेकिन यह लेख इन फ़ाइलों का उपयोग करने वाले उदाहरणों पर आधारित है।

ItemTouchHelper और ItemTouchHelper.Callback का उपयोग करना

ItemTouchHelper उपयोग करने के लिए, आपको एक ItemTouchHelper.Callback बनाना होगा । यह एक इंटरफ़ेस है जो आपको आंदोलन की गतिविधियों को ट्रैक करने की अनुमति देता है ( eng। मूव) और स्वाइप ( eng। स्वाइप)। इसके अलावा, यहां आप चयनित view घटक की स्थिति को नियंत्रित कर सकते हैं और डिफ़ॉल्ट एनीमेशन को ओवरराइड कर सकते हैं। एक सहायक वर्ग है जिसे आप उपयोग कर सकते हैं यदि आप मूल कार्यान्वयन का उपयोग करना चाहते हैं, तो SimpleCallback । लेकिन यह समझने के लिए कि व्यवहार में यह कैसे काम करता है, हम सब कुछ अपने दम पर करेंगे।

इंटरफ़ेस के मुख्य कार्य जिन्हें हमें ड्रैग एंड ड्रॉप और स्वाइप-टू-आउट की बुनियादी कार्यक्षमता को शामिल करने के लिए फिर से परिभाषित करना होगा:

 getMovementFlags(RecyclerView, ViewHolder) onMove(RecyclerView, ViewHolder, ViewHolder) onSwiped(ViewHolder, int)

हम कई सहायक विधियों का भी उपयोग करेंगे:

 isLongPressDragEnabled() isItemViewSwipeEnabled()

आइए एक-एक करके उन पर विचार करें।

 @Override public int getMovementFlags(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder) { int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN; int swipeFlags = ItemTouchHelper.START | ItemTouchHelper.END; return makeMovementFlags(dragFlags, swipeFlags); }

ItemTouchHelper किसी ईवेंट की दिशा निर्धारित करना आसान बनाता है। आपको यह इंगित करने के लिए getMovementFlags() विधि को ओवरराइड करने की आवश्यकता है कि किन दिशाओं को खींचने और छोड़ने का समर्थन किया जाएगा। वापसी ध्वज बनाने के लिए, सहायक विधि का उपयोग करें ItemTouchHelper.makeMovementFlags(int, int) । इस उदाहरण में, हम दोनों दिशाओं में ड्रैग और ड्रॉप की अनुमति देते हैं।

 @Override public boolean isLongPressDragEnabled() { return true; }

ItemTouchHelper उपयोग केवल स्वाइप कार्यक्षमता (या इसके विपरीत) के लिए ड्रैग और ड्रॉप के लिए किया जा सकता है, इसलिए आपको यह निर्दिष्ट करना होगा कि किन विशेषताओं का समर्थन किया जाना चाहिए। isLongPressDragEnabled() विधि को isLongPressDragEnabled() तत्व पर लंबे क्लिक के बाद ड्रैग और ड्रॉप का समर्थन करने के लिए true लौटना चाहिए। वैकल्पिक रूप से, आप मैन्युअल रूप से खींचना शुरू करने के लिए ItemTouchHelper.startDrag(RecyclerView.ViewHolder) विधि कह सकते हैं। हम इस विकल्प पर बाद में विचार करेंगे।

 @Override public boolean isItemViewSwipeEnabled() { return true; }

view घटक के भीतर कहीं भी स्पर्श करने के बाद isItemViewSwipeEnabled() को सक्षम करने के लिए, केवल isItemViewSwipeEnabled() विधि से true लौटें। वैकल्पिक रूप से, आप मैन्युअल रूप से स्वाइप शुरू करने के लिए ItemTouchHelper.startSwipe(RecyclerView.ViewHolder) विधि कह सकते हैं।

निम्नलिखित दो विधियाँ, onMove() और onSwiped() , आपको डेटा अपडेट के बारे में सूचित करने के लिए आवश्यक हैं। इसलिए, पहले हम एक इंटरफ़ेस बनाएंगे जो इन घटनाओं को कॉल चेन के साथ पारित करने की अनुमति देगा।

ItemTouchHelperAdapter.java

 public interface ItemTouchHelperAdapter { void onItemMove(int fromPosition, int toPosition); void onItemDismiss(int position); }

ऐसा करने का सबसे आसान तरीका है कि RecyclerListAdapter को श्रोता को लागू करना है।

 public class RecyclerListAdapter extends RecyclerView.Adapter<ItemViewHolder> implements ItemTouchHelperAdapter { // ...   [](https://gist.github.com/iPaulPro/2216ea5e14818056cfcc#file-recyclerlistadapter-java) @Override public void onItemDismiss(int position) { mItems.remove(position); notifyItemRemoved(position); } @Override public boolean onItemMove(int fromPosition, int toPosition) { if (fromPosition < toPosition) { for (int i = fromPosition; i < toPosition; i++) { Collections.swap(mItems, i, i + 1); } } else { for (int i = fromPosition; i > toPosition; i--) { Collections.swap(mItems, i, i - 1); } } notifyItemMoved(fromPosition, toPosition); return true; }

notifyItemRemoved() और notifyItemMoved() विधियों को कॉल करना बहुत महत्वपूर्ण है ताकि एडेप्टर परिवर्तनों को देखता रहे। यह भी ध्यान दिया जाना चाहिए कि हम तत्व की स्थिति को हर बार बदलते हैं जब view घटक को एक नए सूचकांक में स्थानांतरित किया जाता है, न कि आंदोलन के बहुत अंत में ("ड्रॉप" घटना) ।

अब हम SimpleItemTouchHelperCallback बनाने के लिए वापस आ सकते हैं, क्योंकि हमें अभी भी onMove() और onSwiped() विधियों को ओवरराइड करने की आवश्यकता है। एडॉप्टर के लिए पहले कंस्ट्रक्टर और फ़ील्ड जोड़ें:

 private final ItemTouchHelperAdapter mAdapter; public SimpleItemTouchHelperCallback( ItemTouchHelperAdapter adapter) { mAdapter = adapter; }

फिर शेष घटनाओं को फिर से परिभाषित करें और इसे एडॉप्टर पर रिपोर्ट करें:

 @Override public boolean onMove(RecyclerView recyclerView, RecyclerView.ViewHolder viewHolder, RecyclerView.ViewHolder target) { mAdapter.onItemMove(viewHolder.getAdapterPosition(), target.getAdapterPosition()); return true; } @Override public void onSwiped(RecyclerView.ViewHolder viewHolder, int direction) { mAdapter.onItemDismiss(viewHolder.getAdapterPosition()); }

परिणामस्वरूप, Callback वर्ग को कुछ इस तरह दिखना चाहिए:

 public class SimpleItemTouchHelperCallback extends ItemTouchHelper.Callback { private final ItemTouchHelperAdapter mAdapter; public SimpleItemTouchHelperCallback(ItemTouchHelperAdapter adapter) { mAdapter = adapter; } @Override public boolean isLongPressDragEnabled() { return true; } @Override public boolean isItemViewSwipeEnabled() { return true; } @Override public int getMovementFlags(RecyclerView recyclerView, ViewHolder viewHolder) { int dragFlags = ItemTouchHelper.UP | ItemTouchHelper.DOWN; int swipeFlags = ItemTouchHelper.START | ItemTouchHelper.END; return makeMovementFlags(dragFlags, swipeFlags); } @Override public boolean onMove(RecyclerView recyclerView, ViewHolder viewHolder, ViewHolder target) { mAdapter.onItemMove(viewHolder.getAdapterPosition(), target.getAdapterPosition()); return true; } @Override public void onSwiped(ViewHolder viewHolder, int direction) { mAdapter.onItemDismiss(viewHolder.getAdapterPosition()); } }

जब कॉलबैक तैयार हो जाता है, तो हम एक ItemTouchHelper बना सकते हैं और attachToRecyclerView(RecyclerView) को attachToRecyclerView(RecyclerView) विधि (उदाहरण के लिए, MainFragment.java में ):

 ItemTouchHelper.Callback callback = new SimpleItemTouchHelperCallback(adapter); ItemTouchHelper touchHelper = new ItemTouchHelper(callback); touchHelper.attachToRecyclerView(recyclerView);

शुरू करने के बाद, आपको निम्नलिखित जैसा कुछ मिलना चाहिए:

परिणाम

निष्कर्ष

यह ItemTouchHelper का सबसे सरल कार्यान्वयन है। हालाँकि, आप देख सकते हैं कि आपको RecyclerView में मानक ड्रैग एंड ड्रॉप और स्वाइप-टू-एक्शन को लागू करने के लिए किसी तीसरे पक्ष के पुस्तकालय का उपयोग करने की आवश्यकता नहीं है। अगले भाग में, हम ड्रैग और ड्रॉप के समय तत्वों की उपस्थिति पर अधिक ध्यान देंगे।

स्रोत कोड

मैंने लेखों की इस श्रृंखला में प्रदर्शित किए जाने के लिए GitHub पर एक प्रोजेक्ट बनाया: Android-ItemTouchHelper-Demo । पहली प्रतिबद्ध मुख्य रूप से इस भाग से संबंधित है और दूसरी से थोड़ी।

→ RecyclerView में खींचें और स्वाइप करें। भाग 2: नियंत्रक, ग्रिड और कस्टम एनिमेशन खींचें और छोड़ें