[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 164 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 String to use when recording user metrics related to this content.
+         */
+        String getMetricsName();
     }
 
     /**
      * 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);
+
+        new BottomSheetMetrics(this);
     }
 
     @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;
@@ skipping 203 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);

[mdjones, 2017/03/17 18:17:26]

Admittedly the sheet state concept in this class isn't very robust. Where this
is doesn't necessarily mean the sheet is in the provided state (specifically if
"animate" is true). We should probably trigger this event in onAnimationEnd in
createSettleAnimation and conditionally block this one.

[Theresa, 2017/03/17 20:26:30]

As discussed offline, waiting until onAnimationEnd and not logging if the
animation is canceled may cause states to be skipped e.g. animation to go full
state gets interrupted and user finishes dragging up to full state. This can be
fixed if we represent the current state separately from the target state.

+        }
     }
 
     /**
      * @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;
     }
 }