[Android] Use the platform SwipeRefreshLayout

chrome/android/java/src/org/chromium/chrome/browser/SwipeRefreshHandler.java

Index: chrome/android/java/src/org/chromium/chrome/browser/SwipeRefreshHandler.java
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/SwipeRefreshHandler.java b/chrome/android/java/src/org/chromium/chrome/browser/SwipeRefreshHandler.java
new file mode 100644
index 0000000000000000000000000000000000000000..26dcb5a0b7a5cc21fc447abf77cace063cd7699c
--- /dev/null
+++ b/chrome/android/java/src/org/chromium/chrome/browser/SwipeRefreshHandler.java
@@ -0,0 +1,164 @@
+// Copyright 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.browser;
+
+import android.content.Context;
+import android.view.ViewGroup.LayoutParams;
+
+import org.chromium.base.JNINamespace;
+import org.chromium.base.TraceEvent;
+import org.chromium.chrome.R;
+import org.chromium.content.browser.ContentViewCore;
+import org.chromium.content.browser.OverscrollRefreshHandler;
+import org.chromium.third_party.android.swiperefresh.SwipeRefreshLayout;
+
+/**
+ * An overscroll handler implemented in terms a modified version of the Android
+ * compat library's SwipeRefreshLayout effect.
+ */
+@JNINamespace("content")
+public class SwipeRefreshHandler implements OverscrollRefreshHandler {
+    // Synthetic delay between the {@link #didStopRefreshing()} signal and the
+    // call to stop the refresh animation.
+    private static final int STOP_REFRESH_ANIMATION_DELAY_MS = 500;
+
+    // The modified AppCompat version of the refresh effect, handling all core
+    // logic, rendering and animation.
+    private final SwipeRefreshLayout mSwipeRefreshLayout;
+
+    // The ContentViewCore with which the handler is associated. The handler
+    // will set/unset itself as the default OverscrollRefreshHandler as the
+    // association changes.
+    private ContentViewCore mContentViewCore;
+
+    // Async runnable for ending the refresh animation after the page first
+    // loads a frame. This is used to provide a reasonable minimum animation time.
+    private Runnable mStopRefreshingRunnable;
+
+    // Accessibility utterance used to indicate refresh activation.
+    private String mAccessibilityRefreshString;
+
+    /**
+     * Simple constructor to use when creating an OverscrollRefresh instance from code.
+     *
+     * @param context The associated context.
+     */
+    public SwipeRefreshHandler(Context context) {
+        mSwipeRefreshLayout = new SwipeRefreshLayout(context);
+        mSwipeRefreshLayout.setLayoutParams(
+                new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT));
+        mSwipeRefreshLayout.setColorSchemeResources(R.color.light_active_color);
+        // SwipeRefreshLayout.LARGE layouts appear broken on JellyBean.
+        mSwipeRefreshLayout.setSize(SwipeRefreshLayout.DEFAULT);
+        mSwipeRefreshLayout.setEnabled(false);
+    }
+
+    /**
+     * Pair the effect with a given ContentViewCore instance. If that instance is null,
+     * the effect will be disabled.
+     * @param contentViewCore The associated ContentViewCore instance.
+     */
+    public void setContentViewCore(final ContentViewCore contentViewCore) {
+        if (mContentViewCore == contentViewCore) return;
+
+        if (mContentViewCore != null) {
+            setEnabled(false);
+            mSwipeRefreshLayout.setOnRefreshListener(null);
+            mContentViewCore.setOverscrollRefreshHandler(null);
+        }
+
+        mContentViewCore = contentViewCore;
+
+        if (mContentViewCore == null) return;
+
+        setEnabled(true);
+        mSwipeRefreshLayout.setOnRefreshListener(new SwipeRefreshLayout.OnRefreshListener() {
+            @Override
+            public void onRefresh() {
+                if (mStopRefreshingRunnable != null) {
+                    mSwipeRefreshLayout.removeCallbacks(mStopRefreshingRunnable);
+                }
+                if (mAccessibilityRefreshString == null) {
+                    int resId = R.string.accessibility_swipe_refresh;
+                    mAccessibilityRefreshString =
+                            contentViewCore.getContext().getResources().getString(resId);
+                }
+                if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.JELLY_BEAN) {
+                    mSwipeRefreshLayout.announceForAccessibility(mAccessibilityRefreshString);
+                }
+                contentViewCore.getWebContents().getNavigationController().reload(true);
+            }
+        });
+        contentViewCore.setOverscrollRefreshHandler(this);
+    }
+
+    /**
+     * Notify the SwipeRefreshLayout that a refresh action has completed.
+     * Defer the notification by a reasonable minimum to ensure sufficient
+     * visiblity of the animation.
+     */
+    public void didStopRefreshing() {
+        if (!mSwipeRefreshLayout.isRefreshing()) return;
+        if (mStopRefreshingRunnable == null) {
+            mStopRefreshingRunnable = new Runnable() {
+                @Override
+                public void run() {
+                    mSwipeRefreshLayout.setRefreshing(false);
+                }
+            };
+        }
+        mSwipeRefreshLayout.removeCallbacks(mStopRefreshingRunnable);
+        mSwipeRefreshLayout.postDelayed(mStopRefreshingRunnable, STOP_REFRESH_ANIMATION_DELAY_MS);
+    }
+
+    @Override
+    public boolean start() {
+        attachSwipeRefreshLayoutIfNecessary();
+        return mSwipeRefreshLayout.start();
+    }
+
+    @Override
+    public void pull(float delta) {
+        TraceEvent.begin("SwipeRefreshHandler.pull");
+        mSwipeRefreshLayout.pull(delta);
+        TraceEvent.end("SwipeRefreshHandler.pull");
+    }
+
+    @Override
+    public void release(boolean allowRefresh) {
+        TraceEvent.begin("SwipeRefreshHandler.release");
+        mSwipeRefreshLayout.release(allowRefresh);
+        TraceEvent.end("SwipeRefreshHandler.release");
+    }
+
+    @Override
+    public void reset() {
+        mSwipeRefreshLayout.reset();
+        detachSwipeRefreshLayoutIfNecessary();
+    }
+
+    @Override
+    public void setEnabled(boolean enabled) {
+        mSwipeRefreshLayout.setEnabled(enabled);
+        if (!enabled) reset();
+    }
+
+    // The animation view is attached/detached on-demand to minimize overlap
+    // with composited SurfaceView content.
+    private void attachSwipeRefreshLayoutIfNecessary() {
+        if (mContentViewCore == null) return;
+        if (mSwipeRefreshLayout.getParent() == null) {
+            mContentViewCore.getContainerView().addView(mSwipeRefreshLayout);
+        }
+    }
+
+    private void detachSwipeRefreshLayoutIfNecessary() {
+        // TODO(jdduke): Also detach the effect when its animation ends.
+        if (mContentViewCore == null) return;
+        if (mSwipeRefreshLayout.getParent() != null) {
+            mContentViewCore.getContainerView().removeView(mSwipeRefreshLayout);
+        }
+    }
+}