Add a way to animate swiping from code (#15)

Author: Tunous

README.md

@@ -19,6 +19,7 @@ SwipeActionView is a swipe-able view, which allows users to perform actions by s
 - [Disabling gestures](#disabling-gestures)
 - [Ripple animations](#ripple-animations)
 - [Click listeners](#click-listeners)
+- [Animate from code](#code-animation)
 - [Attributes](#attr)
   - [sav_rippleTakesPadding](#attr-rippleTakesPadding)
   - [sav_swipeLeftRippleColor](#attr-swipeLeftRippleColor)
@@ -170,7 +171,7 @@ In order to be able to perform actions when users swipe the `SwipeActionView` yo
 
 Each of these methods returns `Boolean` as a result. Most of the time you'll want to return `true` here. Returning `false` is designed for advanced usage. By doing so, the view won't be automatically animated to the original position but will stay at the full translation. This allows you to manipulate the content of the visible background view. One great example of this is displaying progress wheel and manually returning the view to the original position once some long action finishes execution.
 
-To return the view to its original position you can call the `moveToOriginalPosition()` method at any time.
+To return the view to its original position you can call the `animateToOriginalPosition()` method at any time.
 
 ```java
 swipeView.setSwipeGestureListener(new SwipeGestureListener() {
@@ -186,12 +187,12 @@ swipeView.setSwipeGestureListener(new SwipeGestureListener() {
     public boolean onSwipedRight(@NonNull SwipeActionView swipeActionView) {
         showToast("Swiped right");
 
-        // Returning false requires calling moveToOriginalPosition() manually to
+        // Returning false requires calling animateToOriginalPosition() manually to
         // reset view to original position
 
         // Here we are using optional parameter which will move our view to
         // original position after delay in ms. In this case it's 2s.
-        swipeActionView.moveToOriginalPosition(2000);
+        swipeActionView.animateToOriginalPosition(2000);
 
         return false;
     }
@@ -203,7 +204,6 @@ If you want to dynamically enable or disable gesture in a specific direction you
 
 **Note:** The gesture enabling part is controlled by presence and visibility of background views. This method is only provided for convenience since it can also be changed by switching visibility of background views. It was coded like this so the specific swipe directions can be disabled by default from XML using `visibility` attribute on views corresponding to these directions.
 
-
 ```java
 swipeView.setDirectionEnabled(SwipeDirection.Left, false);
 ```
@@ -222,6 +222,29 @@ swipeView.setRippleColor(SwipeDirection.Right, Color.BLUE);
 
 The only exception is that you shouldn't add click listeners for background views. This library wasn't designed to add support for this behavior. If it's possible then, that's only a positive side effect. You are better of with using libraries such as [AndroidSwipeLayout] instead.
 
+# <a id="code-animation">Animate from code</a>
+When needed you can manually animate the view to desired position from code by using one of the dedicated methods.
+
+Method `animateInDirection(swipeDirection: SwipeDirection, animateBack: Boolean, delayBeforeAnimatingBack: Long)` animates the view in the specified direction and optionally animates it back after a delay.
+
+```java
+// Animate the view to the right and then animate it back after 1s
+swipeView.animateInDirection(SwipeDirection.Right, true, 1000);
+
+// Animate the view to the left and do not animate it back
+swipeView.animateInDirection(SwipeDirection.Left, false);
+```
+
+Method `animateToOriginalPosition(startDelay: Long)` animates the view to its original position with optional start delay.
+
+```java
+// Wait 500ms and then animate the view to its original position
+swipeView.animateToOriginalPosition(500)
+
+// Instantly animate the view to its original position
+swipeView.animateToOriginalPosition()
+```
+
 # <a id="attr">Attributes</a>
 
 #### <a id="attr-rippleTakesPadding">`app:sav_rippleTakesPadding="true|false"`</a>
@@ -256,7 +279,7 @@ He also created `SwipeRippleDrawable` and allowed me to [reimplement][SwipeRippl
 
 # <a id="license">License</a>
 ```
-Copyright © 2016-2018 Łukasz Rutkowski
+Copyright © 2016-2019 Łukasz Rutkowski
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

library/src/main/kotlin/me/thanel/swipeactionview/SwipeActionView.kt

@@ -48,6 +48,7 @@ import me.thanel.swipeactionview.utils.totalWidth
 /**
  * View that allows users to perform various actions by swiping it to the left or right sides.
  */
+@Suppress("MemberVisibilityCanBePrivate")
 class SwipeActionView : FrameLayout {
     /**
      * Distance from edges in pixels that prevents starting of drag movement.
@@ -114,6 +115,11 @@ class SwipeActionView : FrameLayout {
      */
     private val rippleAnimationDuration = 400L
 
+    /**
+     * The duration of swipe animation.
+     */
+    private val swipeAnimationDuration = 250L
+
     /**
      * Bounds for the ripple animations.
      */
@@ -262,13 +268,13 @@ class SwipeActionView : FrameLayout {
         val swipeRightRippleColor =
             typedArray.getColorStateList(R.styleable.SwipeActionView_sav_swipeRightRippleColor)
         rippleTakesPadding =
-                typedArray.getBoolean(R.styleable.SwipeActionView_sav_rippleTakesPadding, false)
+            typedArray.getBoolean(R.styleable.SwipeActionView_sav_rippleTakesPadding, false)
 
         if (isInEditMode) {
             previewBackground =
-                    typedArray.getInt(R.styleable.SwipeActionView_sav_tools_previewBackground, 0)
+                typedArray.getInt(R.styleable.SwipeActionView_sav_tools_previewBackground, 0)
             previewRipple =
-                    typedArray.getInt(R.styleable.SwipeActionView_sav_tools_previewRipple, 0)
+                typedArray.getInt(R.styleable.SwipeActionView_sav_tools_previewRipple, 0)
         }
 
         typedArray.recycle()
@@ -435,25 +441,54 @@ class SwipeActionView : FrameLayout {
         view.visibility = if (enabled) View.VISIBLE else View.GONE
     }
 
-    /**
-     * Move the view to its original position.
-     */
-    fun moveToOriginalPosition() {
-        moveToOriginalPosition(0)
+    @JvmOverloads
+    @Deprecated(
+        message = "use animateToOriginalPosition instead",
+        replaceWith = ReplaceWith("animateToOriginalPosition(startDelay)")
+    )
+    fun moveToOriginalPosition(startDelay: Long = 0) {
+        animateToOriginalPosition(startDelay)
     }
 
     /**
-     * Move the view to its original position.
+     * Animate the view to its original position.
      *
-     * @param startDelay
-     * The amount of delay, in milliseconds, to wait before starting the movement animation.
+     * @param startDelay The amount of delay, in milliseconds, to wait before starting the
+     * movement animation. (Defaults to 0)
      */
-    fun moveToOriginalPosition(startDelay: Long) {
-        animateContainer(0f, 350, startDelay) {
+    @JvmOverloads
+    fun animateToOriginalPosition(startDelay: Long = 0) {
+        animateContainer(0f, swipeAnimationDuration, startDelay) {
             canPerformSwipeAction = true
         }
     }
 
+    /**
+     * Animate the view in the specified [swipeDirection].
+     *
+     * @param animateBack Tells whether the view should be automatically swiped back to original
+     * position after initial animation finishes.
+     * @param delayBeforeAnimatingBack Delay in milliseconds before the view animates back to its
+     * original position. Has no effect if [animateBack] is set to `false`. (Defaults to 200ms)
+     */
+    @JvmOverloads
+    fun animateInDirection(
+        swipeDirection: SwipeDirection,
+        animateBack: Boolean,
+        delayBeforeAnimatingBack: Long = 200
+    ) {
+        val distance = if (swipeDirection == SwipeDirection.Right) {
+            maxRightSwipeDistance
+        } else {
+            -maxLeftSwipeDistance
+        }
+        animateContainer(distance, swipeAnimationDuration, 0) {
+            if (animateBack) {
+                animateToOriginalPosition(delayBeforeAnimatingBack)
+            }
+        }
+    }
+
     /**
      * Set ripple color for the specified swipe direction. Use -1 to disable ripple.
      *
@@ -484,7 +519,7 @@ class SwipeActionView : FrameLayout {
             MotionEvent.ACTION_UP,
             MotionEvent.ACTION_CANCEL -> {
                 cancelDrag()
-                moveToOriginalPosition()
+                animateToOriginalPosition()
             }
         }
 
@@ -523,7 +558,7 @@ class SwipeActionView : FrameLayout {
 
             MotionEvent.ACTION_CANCEL -> {
                 cancelDrag()
-                moveToOriginalPosition()
+                animateToOriginalPosition()
             }
         }
 
@@ -738,14 +773,14 @@ class SwipeActionView : FrameLayout {
         val swipedFastEnough = Math.abs(velocityTracker.xVelocity) > minActivationSpeed
 
         if (swipedFastEnough && !isValidDelta(velocityTracker.xVelocity)) {
-            moveToOriginalPosition()
+            animateToOriginalPosition()
             return
         }
 
         if (hasSwipedFarEnough(container.translationX) || swipedFastEnough) {
             activate(container.translationX > 0)
         } else {
-            moveToOriginalPosition()
+            animateToOriginalPosition()
         }
     }
 
@@ -774,7 +809,7 @@ class SwipeActionView : FrameLayout {
         // If activation animation didn't finish, move the view to original position without
         // executing activate callback.
         if (!canPerformSwipeAction) {
-            moveToOriginalPosition()
+            animateToOriginalPosition()
             return
         }
         canPerformSwipeAction = false
@@ -785,15 +820,16 @@ class SwipeActionView : FrameLayout {
             leftSwipeRipple.restart()
         }
 
-        animateContainer(if (swipedRight) maxRightSwipeDistance else -maxLeftSwipeDistance, 250) {
+        val targetTranslationX = if (swipedRight) maxRightSwipeDistance else -maxLeftSwipeDistance
+        animateContainer(targetTranslationX, swipeAnimationDuration) {
             val shouldFinish = if (swipedRight) {
                 swipeGestureListener?.onSwipedRight(this)
             } else {
                 swipeGestureListener?.onSwipedLeft(this)
             }
 
             if (shouldFinish != false) {
-                moveToOriginalPosition(200)
+                animateToOriginalPosition(200)
             }
         }
     }

sample/src/main/java/me/thanel/swipeactionview/sample/MainActivity.java

@@ -17,17 +17,19 @@
 package me.thanel.swipeactionview.sample;
 
 import android.os.Bundle;
-import androidx.annotation.NonNull;
-import androidx.appcompat.app.AppCompatActivity;
 import android.view.View;
-import android.widget.Button;
 import android.widget.Toast;
 
+import androidx.annotation.NonNull;
+import androidx.appcompat.app.AppCompatActivity;
 import me.thanel.swipeactionview.SwipeActionView;
+import me.thanel.swipeactionview.SwipeDirection;
 import me.thanel.swipeactionview.SwipeGestureListener;
 
 public class MainActivity extends AppCompatActivity {
 
+    private SwipeActionView swipeCustomLayout;
+
     @Override
     protected void onCreate(final Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -65,35 +67,35 @@ public boolean onSwipedRight(@NonNull SwipeActionView swipeActionView) {
         SwipeGestureListener delayedSwipeGestureListener = new SwipeGestureListener() {
             @Override
             public boolean onSwipedLeft(@NonNull SwipeActionView swipeActionView) {
-                swipeActionView.moveToOriginalPosition(1000);
+                swipeActionView.animateToOriginalPosition(1000);
                 return false;
             }
 
             @Override
             public boolean onSwipedRight(@NonNull SwipeActionView swipeActionView) {
-                swipeActionView.moveToOriginalPosition(500);
+                swipeActionView.animateToOriginalPosition(500);
                 return false;
             }
         };
 
         SwipeActionView swipeDelayed = findViewById(R.id.swipe_delayed);
         swipeDelayed.setSwipeGestureListener(delayedSwipeGestureListener);
 
-        SwipeActionView swipeCustomLayout = findViewById(R.id.swipe_layout);
+        swipeCustomLayout = findViewById(R.id.swipe_layout);
         swipeCustomLayout.setSwipeGestureListener(swipeGestureListener);
-
-        Button button = findViewById(R.id.button);
-        button.setOnClickListener(new View.OnClickListener() {
-            @Override
-            public void onClick(View v) {
-                Toast.makeText(MainActivity.this, R.string.clicked, Toast.LENGTH_SHORT).show();
-            }
-        });
     }
 
     private void showToast(Boolean swipedRight) {
         int resId = swipedRight ? R.string.swiped_right : R.string.swiped_left;
 
         Toast.makeText(this, resId, Toast.LENGTH_SHORT).show();
     }
+
+    public void swipeLeft(View view) {
+        swipeCustomLayout.animateInDirection(SwipeDirection.Left, true);
+    }
+
+    public void swipeRight(View view) {
+        swipeCustomLayout.animateInDirection(SwipeDirection.Right, true);
+    }
 }

sample/src/main/res/layout/activity_main.xml

@@ -168,11 +168,29 @@
                         android:layout_height="wrap_content"
                         android:text="@string/full_control" />
 
-                    <Button
-                        android:id="@+id/button"
+
+                    <LinearLayout
                         android:layout_width="match_parent"
                         android:layout_height="wrap_content"
-                        android:text="@string/click_me" />
+                        android:orientation="horizontal">
+
+                        <Button
+                            android:id="@+id/swipe_left_button"
+                            android:layout_width="match_parent"
+                            android:layout_height="wrap_content"
+                            android:layout_weight="1"
+                            android:onClick="swipeLeft"
+                            android:text="@string/swipe_left" />
+
+                        <Button
+                            android:id="@+id/swipe_right_button"
+                            android:layout_width="match_parent"
+                            android:layout_height="wrap_content"
+                            android:layout_weight="1"
+                            android:onClick="swipeRight"
+                            android:text="@string/swipe_right" />
+
+                    </LinearLayout>
                 </LinearLayout>
             </LinearLayout>
         </me.thanel.swipeactionview.SwipeActionView>

sample/src/main/res/values/strings.xml

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!--
   ~ Copyright © 2016-2018 Łukasz Rutkowski
   ~
@@ -12,21 +13,28 @@
   ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
-  -->
+  --><resources>
+    <string name="advanced_layout">Advanced layout</string>
+
+    <string name="animated_ripple">Displays animated ripple when swiped</string>
 
-<resources>
     <string name="app_name">SwipeActionView</string>
-    <string name="can_swipe_right">Can swipe right</string>
-    <string name="can_swipe_left">Can swipe left</string>
+
+    <string name="can_be_customized">This can also be customized</string>
     <string name="can_swipe_in_both_directions">Can swipe in both directions</string>
+    <string name="can_swipe_left">Can swipe left</string>
+    <string name="can_swipe_right">Can swipe right</string>
+
+    <string name="clicked">Clicked</string>
+
+    <string name="full_control">You have full control over look of SwipeActionView</string>
+
+    <string name="returns_after_delay">Returns to original position after delay</string>
+
+    <string name="swipe_able_card_view">Swipe-able CardView</string>
+    <string name="swipe_left">Swipe left</string>
+    <string name="swipe_right">Swipe right</string>
+
     <string name="swiped_left">Swiped left</string>
     <string name="swiped_right">Swiped right</string>
-    <string name="swipe_able_card_view">Swipe-able CardView</string>
-    <string name="animated_ripple">Displays animated ripple when swiped</string>
-    <string name="returns_after_delay">Returns to original position after delay</string>
-    <string name="can_be_customized">This can also be customized</string>
-    <string name="advanced_layout">Advanced layout</string>
-    <string name="full_control">You have full control over look of SwipeActionView</string>
-    <string name="click_me">Click me!</string>
-    <string name="clicked">Clicked</string>
 </resources>