[Home] Record some user actions for the Chrome Home BottomSheet

chrome/android/java/src/org/chromium/chrome/browser/widget/bottomsheet/BottomSheet.java

 // Copyright 2017 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.widget.bottomsheet;
 
 import android.animation.Animator;
 import android.animation.AnimatorListenerAdapter;
 import android.animation.ValueAnimator;
 import android.content.Context;
@@ skipping 15 matching lines @@
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.NativePageHost;
 import org.chromium.chrome.browser.TabLoadStatus;
 import org.chromium.chrome.browser.fullscreen.ChromeFullscreenManager;
 import org.chromium.chrome.browser.ntp.NativePageFactory;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.TabModel;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.chrome.browser.util.MathUtils;
 import org.chromium.chrome.browser.widget.FadingBackgroundView;
+import org.chromium.chrome.browser.widget.bottomsheet.BottomSheetContentController.ContentType;
 import org.chromium.content_public.browser.LoadUrlParams;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 
 /**
  * This class defines the bottom sheet that has multiple states and a persistently showing toolbar.
  * Namely, the states are:
  * - PEEK: Only the toolbar is visible at the bottom of the screen.
  * - HALF: The sheet is expanded to consume around half of the screen.
@@ skipping 98 matching lines @@
 
     /**
      * The default toolbar view. This is shown when the current bottom sheet content doesn't have
      * its own toolbar and when the bottom sheet is closed.
      */
     private View mDefaultToolbarView;
 
     /** The last non-default toolbar view that was attached to mToolbarHolder. */
     private View mLastToolbarView;
 
+    /** Whether the sheet is currently open. */
+    private boolean mIsSheetOpen;
+
     /**
      * An interface defining content that can be displayed inside of the bottom sheet for Chrome
      * Home.
      */
     public interface BottomSheetContent {
         /**
          * Gets the {@link View} that holds the content to be displayed in the Chrome Home bottom
          * sheet.
          * @return The content view.
          */
@@ skipping 11 matching lines @@
 
         /**
          * @return The vertical scroll offset of the content view.
          */
         int getVerticalScrollOffset();
 
         /**
          * Called to destroy the BottomSheetContent when it is no longer in use.
          */
         void destroy();
+
+        /**
+         * @return The {@link BottomSheetContentController.ContentType} for this content.
+         */
+        @ContentType
+        int getType();
     }
 
     /**
      * This class is responsible for detecting swipe and scroll events on the bottom sheet or
      * ignoring them when appropriate.
      */
     private class BottomSheetSwipeDetector extends GestureDetector.SimpleOnGestureListener {
         @Override
         public boolean onDown(MotionEvent e) {
             return true;
@@ skipping 69 matching lines @@
      * @param context An Android context.
      * @param atts The XML attributes.
      */
     public BottomSheet(Context context, AttributeSet atts) {
         super(context, atts);
 
         mVelocityTracker = VelocityTracker.obtain();
 
         mGestureDetector = new GestureDetector(context, new BottomSheetSwipeDetector());
         mGestureDetector.setIsLongpressEnabled(false);
+
+        BottomSheetMetrics metrics = new BottomSheetMetrics();
+        addObserver(metrics);

[gone, 2017/03/20 21:04:52]

maybe just make it addObserver(new BottomSheetMetrics())?

[Theresa, 2017/03/20 21:22:52]

Done.

     }
 
     @Override
     public boolean onInterceptTouchEvent(MotionEvent e) {
         if (!canMoveSheet()) return false;
 
         // The incoming motion event may have been adjusted by the view sending it down. Create a
         // motion event with the raw (x, y) coordinates of the original so the gesture detector
         // functions properly.
         mGestureDetector.onTouchEvent(createRawMotionEvent(e));
@@ skipping 214 matching lines @@
             mLastToolbarView = null;
         }
 
         if (mSheetContent.getToolbarView() != null) {
             mLastToolbarView = mSheetContent.getToolbarView();
             mToolbarHolder.addView(mSheetContent.getToolbarView());
             mDefaultToolbarView.setVisibility(View.GONE);
         } else {
             mDefaultToolbarView.setVisibility(View.VISIBLE);
         }
+
+        for (BottomSheetObserver o : mObservers) {
+            o.onSheetContentChanged(mSheetContent);
+        }
     }
 
     /**
      * Determines if a touch event is inside the toolbar. This assumes the toolbar is the full
      * width of the screen and that the toolbar is at the top of the bottom sheet.
      * @param e The motion event to test.
      * @return True if the event occured in the toolbar region.
      */
     private boolean isTouchEventInToolbar(MotionEvent e) {
         if (mControlContainer == null) return false;
 
         mControlContainer.getLocationInWindow(mLocationArray);
 
         return e.getRawY() < mLocationArray[1] + mToolbarHeight;
     }
 
     /**
      * A notification that the sheet is exiting the peek state into one that shows content.
      */
     private void onSheetOpened() {
+        if (mIsSheetOpen) return;
+
+        mIsSheetOpen = true;
         for (BottomSheetObserver o : mObservers) o.onSheetOpened();
     }
 
     /**
      * A notification that the sheet has returned to the peeking state.
      */
     private void onSheetClosed() {
+        if (!mIsSheetOpen) return;
+
+        mIsSheetOpen = false;
         for (BottomSheetObserver o : mObservers) o.onSheetClosed();
     }
 
     /**
      * Creates an unadjusted version of a MotionEvent.
      * @param e The original event.
      * @return The unadjusted version of the event.
      */
     private MotionEvent createRawMotionEvent(MotionEvent e) {
         MotionEvent rawEvent = MotionEvent.obtain(e);
@@ skipping 176 matching lines @@
         }
     }
 
     /**
      * Moves the sheet to the provided state.
      * @param state The state to move the panel to.
      * @param animate If true, the sheet will animate to the provided state, otherwise it will
      *                move there instantly.
      */
     public void setSheetState(@SheetState int state, boolean animate) {
+        boolean stateChanged = state != mCurrentState;
         mCurrentState = state;
 
         if (animate) {
             createSettleAnimation(state);
         } else {
             setSheetOffsetFromBottom(getSheetHeightForState(state));
         }
+
+        if (!stateChanged) return;
+
+        for (BottomSheetObserver o : mObservers) {
+            o.onSheetStateChanged(mCurrentState);
+        }
     }
 
     /**
      * @return The current state of the bottom sheet. If the sheet is animating, this will be the
      *         state the sheet is animating to.
      */
     public int getSheetState() {
         return mCurrentState;
     }
 
@@ skipping 78 matching lines @@
     @Override
     public void onFadingViewVisibilityChanged(boolean visible) {}
 
     private boolean canMoveSheet() {
         boolean isInOverviewMode = mTabModelSelector != null
                 && (mTabModelSelector.getCurrentTab() == null
                            || mTabModelSelector.getCurrentTab().getActivity().isInOverviewMode());
         return !isToolbarAndroidViewHidden() && !isInOverviewMode;
     }
 }