[BREAKING CHANGE] Introduce onItemDragStarted()/onItemDragFinished() …

…callbacks and reduce internal notifyDatasetChanged() method calls
Bender42 · Oct 9, 2017 · 84d5818 · 84d5818
1 parent fc256af
commit 84d5818
Show file tree

Hide file tree

Showing 17 changed files with 298 additions and 29 deletions.
diff --git a/...a/com/h6ah4i/android/example/advrecyclerview/demo_composition_all/MyDraggableAdapter.java b/...a/com/h6ah4i/android/example/advrecyclerview/demo_composition_all/MyDraggableAdapter.java
@@ -120,6 +120,16 @@ public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
 
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     @Override
     public void onClick(View v) {
         RecyclerView rv = RecyclerViewAdapterUtils.getParentRecyclerView(v);

diff --git a/.../com/h6ah4i/android/example/advrecyclerview/demo_d_basic/DraggableExampleItemAdapter.java b/.../com/h6ah4i/android/example/advrecyclerview/demo_d_basic/DraggableExampleItemAdapter.java
@@ -151,4 +151,14 @@ public ItemDraggableRange onGetItemDraggableRange(MyViewHolder holder, int posit
     public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
+
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
 }
diff --git a/...xample/advrecyclerview/demo_d_check_can_drop/DraggableCheckCanDropExampleItemAdapter.java b/...xample/advrecyclerview/demo_d_check_can_drop/DraggableCheckCanDropExampleItemAdapter.java
@@ -151,4 +151,14 @@ public ItemDraggableRange onGetItemDraggableRange(MyViewHolder holder, int posit
     public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return (draggingPosition % 2) == (dropPosition % 2);
     }
+
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
 }
diff --git a/...a/com/h6ah4i/android/example/advrecyclerview/demo_d_grid/DraggableGridExampleAdapter.java b/...a/com/h6ah4i/android/example/advrecyclerview/demo_d_grid/DraggableGridExampleAdapter.java
@@ -152,4 +152,14 @@ public ItemDraggableRange onGetItemDraggableRange(MyViewHolder holder, int posit
     public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
+
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
 }
diff --git a/...6ah4i/android/example/advrecyclerview/demo_d_minimal/MinimalDraggableExampleActivity.java b/...6ah4i/android/example/advrecyclerview/demo_d_minimal/MinimalDraggableExampleActivity.java
@@ -137,5 +137,13 @@ public ItemDraggableRange onGetItemDraggableRange(MyViewHolder holder, int posit
         public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
             return true;
         }
+
+        @Override
+        public void onItemDragStarted(int position) {
+        }
+
+        @Override
+        public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        }
     }
 }
diff --git a/...4i/android/example/advrecyclerview/demo_d_on_longpress/DragOnLongPressExampleAdapter.java b/...4i/android/example/advrecyclerview/demo_d_on_longpress/DragOnLongPressExampleAdapter.java
@@ -151,4 +151,14 @@ public ItemDraggableRange onGetItemDraggableRange(MyViewHolder holder, int posit
     public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
+
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
 }
diff --git a/...d/example/advrecyclerview/demo_d_staggered_grid/DraggableStaggeredGridExampleAdapter.java b/...d/example/advrecyclerview/demo_d_staggered_grid/DraggableStaggeredGridExampleAdapter.java
@@ -216,6 +216,16 @@ public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
 
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     static int getHeaderItemCount() {
         return (USE_DUMMY_HEADER) ? 1 : 0;
     }

diff --git a/...droid/example/advrecyclerview/demo_d_with_section/DraggableWithSectionExampleAdapter.java b/...droid/example/advrecyclerview/demo_d_with_section/DraggableWithSectionExampleAdapter.java
@@ -196,6 +196,16 @@ public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
 
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     private int findFirstSectionItem(int position) {
         AbstractDataProvider.Data item = mProvider.getItem(position);
 

diff --git a/.../com/h6ah4i/android/example/advrecyclerview/demo_ds/DraggableSwipeableExampleAdapter.java b/.../com/h6ah4i/android/example/advrecyclerview/demo_ds/DraggableSwipeableExampleAdapter.java
@@ -218,6 +218,16 @@ public boolean onCheckCanDrop(int draggingPosition, int dropPosition) {
         return true;
     }
 
+    @Override
+    public void onItemDragStarted(int position) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onItemDragFinished(int fromPosition, int toPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     @Override
     public int onGetSwipeReactionType(MyViewHolder holder, int position, int x, int y) {
         if (onCheckCanStartDrag(holder, position, x, y)) {

diff --git a/...ah4i/android/example/advrecyclerview/demo_e_minimal/MinimalExpandableExampleActivity.java b/...ah4i/android/example/advrecyclerview/demo_e_minimal/MinimalExpandableExampleActivity.java
@@ -27,10 +27,7 @@
 import android.widget.TextView;
 
 import com.h6ah4i.android.example.advrecyclerview.R;
-import com.h6ah4i.android.widget.advrecyclerview.draggable.DraggableItemAdapter;
-import com.h6ah4i.android.widget.advrecyclerview.draggable.ItemDraggableRange;
 import com.h6ah4i.android.widget.advrecyclerview.expandable.RecyclerViewExpandableItemManager;
-import com.h6ah4i.android.widget.advrecyclerview.utils.AbstractDraggableItemViewHolder;
 import com.h6ah4i.android.widget.advrecyclerview.utils.AbstractExpandableItemAdapter;
 import com.h6ah4i.android.widget.advrecyclerview.utils.AbstractExpandableItemViewHolder;
 

diff --git a/...le/advrecyclerview/demo_ed_with_section/ExpandableDraggableWithSectionExampleAdapter.java b/...le/advrecyclerview/demo_ed_with_section/ExpandableDraggableWithSectionExampleAdapter.java
@@ -369,6 +369,26 @@ public void onMoveChildItem(int fromGroupPosition, int fromChildPosition, int to
         mProvider.moveChildItem(fromGroupPosition, fromChildPosition, toGroupPosition, toChildPosition);
     }
 
+    @Override
+    public void onGroupDragStarted(int groupPosition) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onChildDragStarted(int groupPosition, int childPosition) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onGroupDragFinished(int fromGroupPosition, int toGroupPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onChildDragFinished(int fromGroupPosition, int fromChildPosition, int toGroupPosition, int toChildPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     private int findFirstSectionItem(int position) {
         AbstractExpandableDataProvider.GroupData item = mProvider.getGroupItem(position);
 

diff --git a/.../android/example/advrecyclerview/demo_eds/ExpandableDraggableSwipeableExampleAdapter.java b/.../android/example/advrecyclerview/demo_eds/ExpandableDraggableSwipeableExampleAdapter.java
@@ -380,6 +380,26 @@ public void onMoveChildItem(int fromGroupPosition, int fromChildPosition, int to
         mProvider.moveChildItem(fromGroupPosition, fromChildPosition, toGroupPosition, toChildPosition);
     }
 
+    @Override
+    public void onGroupDragStarted(int groupPosition) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onChildDragStarted(int groupPosition, int childPosition) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onGroupDragFinished(int fromGroupPosition, int toGroupPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
+    @Override
+    public void onChildDragFinished(int fromGroupPosition, int fromChildPosition, int toGroupPosition, int toChildPosition, boolean result) {
+        notifyDataSetChanged();
+    }
+
     @Override
     public int onGetGroupItemSwipeReactionType(MyGroupViewHolder holder, int groupPosition, int x, int y) {
         if (onCheckGroupCanStartDrag(holder, groupPosition, x, y)) {

diff --git a/...c/main/java/com/h6ah4i/android/widget/advrecyclerview/draggable/DraggableItemAdapter.java b/...c/main/java/com/h6ah4i/android/widget/advrecyclerview/draggable/DraggableItemAdapter.java
@@ -62,4 +62,24 @@ public interface DraggableItemAdapter<T extends RecyclerView.ViewHolder> {
      * @return Whether can be dropped to the specified position.
      */
     boolean onCheckCanDrop(int draggingPosition, int dropPosition);
+
+    /**
+     * Callback method to be invoked when started dragging an item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param position The position of the item.
+     */
+    void onItemDragStarted(int position);
+
+    /**
+     * Callback method to be invoked when finished dragging an item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param fromPosition Previous position of the item.
+     * @param toPosition   New position of the item.
+     * @param result       Indicates whether the dragging operation was succeeded.
+     */
+    void onItemDragFinished(int fromPosition, int toPosition, boolean result);
 }
diff --git a/...java/com/h6ah4i/android/widget/advrecyclerview/draggable/DraggableItemWrapperAdapter.java b/...java/com/h6ah4i/android/widget/advrecyclerview/draggable/DraggableItemWrapperAdapter.java
@@ -51,6 +51,7 @@ private interface Constants extends DraggableItemConstants {
     private int mDraggingItemInitialPosition = RecyclerView.NO_POSITION;
     private int mDraggingItemCurrentPosition = RecyclerView.NO_POSITION;
     private int mItemMoveMode;
+    private boolean mCallingDragStarted;
 
     public DraggableItemWrapperAdapter(RecyclerViewDragDropManager manager, RecyclerView.Adapter<VH> adapter) {
         super(adapter);
@@ -223,7 +224,7 @@ private boolean shouldCancelDragOnDataUpdated() {
         if (DEBUG_BYPASS_MOVE_OPERATION_MODE) {
             return false;
         }
-        return isDragging();
+        return isDragging() && !mCallingDragStarted;
     }
 
     private void cancelDrag() {
@@ -233,7 +234,7 @@ private void cancelDrag() {
     }
 
     // NOTE: This method is called from RecyclerViewDragDropManager
-    /*package*/ void onDragItemStarted(DraggingItemInfo draggingItemInfo, RecyclerView.ViewHolder holder, ItemDraggableRange range, int wrappedItemPosition, int itemMoveMode) {
+    /*package*/ void startDraggingItem(DraggingItemInfo draggingItemInfo, RecyclerView.ViewHolder holder, ItemDraggableRange range, int wrappedItemPosition, int itemMoveMode) {
         if (LOCAL_LOGD) {
             Log.d(TAG, "onDragItemStarted(holder = " + holder + ")");
         }
@@ -257,24 +258,28 @@ private void cancelDrag() {
         mDraggingItemViewHolder = holder;
         mDraggableRange = range;
         mItemMoveMode = itemMoveMode;
+    }
 
-        notifyDataSetChanged();
+    // NOTE: This method is called from RecyclerViewDragDropManager
+    /*package*/ void onDragItemStarted() {
+        mCallingDragStarted = true;
+        mDraggableItemAdapter.onItemDragStarted(getDraggingItemInitialPosition());
+        mCallingDragStarted = false;
     }
 
     // NOTE: This method is called from RecyclerViewDragDropManager
-    /*package*/ void onDragItemFinished(boolean result) {
+    /*package*/ void onDragItemFinished(
+            int draggingItemInitialPosition, int draggingItemCurrentPosition, boolean result) {
         if (LOCAL_LOGD) {
-            Log.d(TAG, "onDragItemFinished(result = " + result + ")");
+            Log.d(TAG, "onDragItemFinished(draggingItemInitialPosition = " + draggingItemInitialPosition +
+                    ", draggingItemCurrentPosition = " + draggingItemCurrentPosition + ", result = " + result + ")");
         }
 
         if (DEBUG_BYPASS_MOVE_OPERATION_MODE) {
             return;
         }
 
-        if (result && (mDraggingItemCurrentPosition != mDraggingItemInitialPosition)) {
-            // apply to wrapped adapter
-            mDraggableItemAdapter.onMoveItem(mDraggingItemInitialPosition, mDraggingItemCurrentPosition);
-        }
+        DraggableItemAdapter draggableItemAdapter = mDraggableItemAdapter;
 
         mDraggingItemInitialPosition = RecyclerView.NO_POSITION;
         mDraggingItemCurrentPosition = RecyclerView.NO_POSITION;
@@ -283,7 +288,12 @@ private void cancelDrag() {
         mDraggingItemViewHolder = null;
         mDraggableItemAdapter = null;
 
-        notifyDataSetChanged();
+        if (result && (draggingItemCurrentPosition != draggingItemInitialPosition)) {
+            // apply to wrapped adapter
+            draggableItemAdapter.onMoveItem(draggingItemInitialPosition, draggingItemCurrentPosition);
+        }
+
+        draggableItemAdapter.onItemDragFinished(draggingItemInitialPosition, draggingItemCurrentPosition, result);
     }
 
     @Override

diff --git a/...java/com/h6ah4i/android/widget/advrecyclerview/draggable/RecyclerViewDragDropManager.java b/...java/com/h6ah4i/android/widget/advrecyclerview/draggable/RecyclerViewDragDropManager.java
@@ -762,8 +762,7 @@ private void startDragging(RecyclerView rv, MotionEvent e, RecyclerView.ViewHold
 
         startScrollOnDraggingProcess();
 
-        // raise onDragItemStarted() event
-        mWrapperAdapter.onDragItemStarted(mDraggingItemInfo, holder, mDraggableRange, wrappedItemPosition, mCurrentItemMoveMode);
+        mWrapperAdapter.startDraggingItem(mDraggingItemInfo, holder, mDraggableRange, wrappedItemPosition, mCurrentItemMoveMode);
 
         // setup decorators
         mWrapperAdapter.onBindViewHolder(holder, wrappedItemPosition);
@@ -786,6 +785,9 @@ private void startDragging(RecyclerView rv, MotionEvent e, RecyclerView.ViewHold
             mEdgeEffectDecorator.reorderToTop();
         }
 
+        // raise onDragItemStarted() event
+        mWrapperAdapter.onDragItemStarted();
+
         if (mItemDragEventListener != null) {
             mItemDragEventListener.onItemDragStarted(mWrapperAdapter.getDraggingItemInitialPosition());
             mItemDragEventListener.onItemDragMoveDistanceUpdated(0, 0);
@@ -905,7 +907,10 @@ private void finishDragging(boolean result) {
         if (mWrapperAdapter != null) {
             draggingItemInitialPosition = mWrapperAdapter.getDraggingItemInitialPosition();
             draggingItemCurrentPosition = mWrapperAdapter.getDraggingItemCurrentPosition();
-            mWrapperAdapter.onDragItemFinished(result);
+            mWrapperAdapter.onDragItemFinished(
+                    draggingItemInitialPosition,
+                    draggingItemCurrentPosition,
+                    result);
         }
 
 //        if (draggedItem != null) {

diff --git a/.../com/h6ah4i/android/widget/advrecyclerview/expandable/ExpandableDraggableItemAdapter.java b/.../com/h6ah4i/android/widget/advrecyclerview/expandable/ExpandableDraggableItemAdapter.java
@@ -115,4 +115,47 @@ public interface ExpandableDraggableItemAdapter<GVH extends RecyclerView.ViewHol
      * @return Whether can be dropped to the specified position.
      */
     boolean onCheckChildCanDrop(int draggingGroupPosition, int draggingChildPosition, int dropGroupPosition, int dropChildPosition);
+
+    /**
+     * Callback method to be invoked when started dragging a group item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param groupPosition The position of the group item.
+     */
+    void onGroupDragStarted(int groupPosition);
+
+    /**
+     * Callback method to be invoked when started dragging a child item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param groupPosition The group position of the item.
+     * @param childPosition The child position of the item.
+     */
+    void onChildDragStarted(int groupPosition, int childPosition);
+
+    /**
+     * Callback method to be invoked when finished dragging a group item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param fromGroupPosition Previous position of the group item.
+     * @param toGroupPosition   New position of the group item.
+     * @param result       Indicates whether the dragging operation was succeeded.
+     */
+    void onGroupDragFinished(int fromGroupPosition, int toGroupPosition, boolean result);
+
+    /**
+     * Callback method to be invoked when finished dragging a child item.
+     *
+     * Call the {@link RecyclerView.Adapter#notifyDataSetChanged()} method in this callback to get the same behavior with v0.10.x or before.
+     *
+     * @param fromGroupPosition Previous group position of the item.
+     * @param fromChildPosition Previous child position of the item.
+     * @param toGroupPosition   New group position of the item.
+     * @param toChildPosition   New child position of the item.
+     * @param result       Indicates whether the dragging operation was succeeded.
+     */
+    void onChildDragFinished(int fromGroupPosition, int fromChildPosition, int toGroupPosition, int toChildPosition, boolean result);
 }