📰 Add visibility change triggers for bottom sheet content

chrome/android/java/src/org/chromium/chrome/browser/suggestions/SuggestionsBottomSheetContent.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.suggestions;
 
 import android.annotation.SuppressLint;
 import android.support.v7.widget.RecyclerView;
 import android.support.v7.widget.RecyclerView.OnScrollListener;
 import android.view.LayoutInflater;
 import android.view.MotionEvent;
 import android.view.View;
 
 import org.chromium.base.ApiCompatibilityUtils;
+import org.chromium.base.metrics.RecordUserAction;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeActivity;
 import org.chromium.chrome.browser.NativePageHost;
 import org.chromium.chrome.browser.ntp.ContextMenuManager;
 import org.chromium.chrome.browser.ntp.ContextMenuManager.TouchEnabledDelegate;
 import org.chromium.chrome.browser.ntp.cards.NewTabPageAdapter;
 import org.chromium.chrome.browser.ntp.snippets.SnippetsBridge;
 import org.chromium.chrome.browser.ntp.snippets.SuggestionsSource;
 import org.chromium.chrome.browser.offlinepages.OfflinePageBridge;
 import org.chromium.chrome.browser.omnibox.LocationBar;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.snackbar.SnackbarManager;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.chrome.browser.widget.FadingShadow;
 import org.chromium.chrome.browser.widget.FadingShadowView;
 import org.chromium.chrome.browser.widget.bottomsheet.BottomSheet;
 import org.chromium.chrome.browser.widget.bottomsheet.BottomSheetContentController;
 import org.chromium.chrome.browser.widget.bottomsheet.BottomSheetObserver;
-import org.chromium.chrome.browser.widget.bottomsheet.EmptyBottomSheetObserver;
+import org.chromium.chrome.browser.widget.bottomsheet.SheetContentStateChangeObserver;
 import org.chromium.chrome.browser.widget.displaystyle.UiConfig;
 
 /**
  * Provides content to be displayed inside of the Home tab of bottom sheet.
  */
 public class SuggestionsBottomSheetContent implements BottomSheet.BottomSheetContent {
     private static SuggestionsSource sSuggestionsSourceForTesting;
     private static SuggestionsEventReporter sEventReporterForTesting;
 
     private final View mView;
@@ skipping 34 matching lines @@
             }
         });
 
         UiConfig uiConfig = new UiConfig(mRecyclerView);
 
         final NewTabPageAdapter adapter = new NewTabPageAdapter(mSuggestionsUiDelegate,
                 /* aboveTheFoldView = */ null, uiConfig, OfflinePageBridge.getForProfile(profile),
                 mContextMenuManager, mTileGroupDelegate);
         mRecyclerView.init(uiConfig, mContextMenuManager, adapter);
 
-        mBottomSheetObserver = new EmptyBottomSheetObserver() {
+        mBottomSheet = activity.getBottomSheet();
+        mBottomSheetObserver = new SheetContentStateChangeObserver(this, mBottomSheet) {
             @Override
-            public void onSheetOpened() {
+            public void onContentShown() {
+                SuggestionsMetrics.recordSurfaceVisible();
+                mSuggestionsUiDelegate.getEventReporter().onSurfaceOpened();
+
                 mRecyclerView.scrollToPosition(0);
 
                 adapter.refreshSuggestions();
-                mSuggestionsUiDelegate.getEventReporter().onSurfaceOpened();
-                SuggestionsMetrics.recordSurfaceVisible();
             }
 
             @Override
-            public void onSheetClosed() {
+            public void onContentHidden() {
                 SuggestionsMetrics.recordSurfaceHidden();
             }
 
+            @Override
+            public void onContentStateChanged(int sheetState) {
+                if (sheetState == BottomSheet.SHEET_STATE_HALF) {
+                    RecordUserAction.record("Suggestions.SurfaceHalfVisible");
+                } else if (sheetState == BottomSheet.SHEET_STATE_FULL) {
+                    RecordUserAction.record("Suggestions.SurfaceFullyVisible");
+                }
+            }
+
+            @Override
+            public void onSheetBackgrounded() {
+                onContentHidden();
+            }
+
+            @Override
+            public void onSheetForegrounded() {
+                SuggestionsMetrics.recordSurfaceVisible();
+                onContentStateChanged(getCurrentState());
+            }
         };
-        mBottomSheet = activity.getBottomSheet();
         mBottomSheet.addObserver(mBottomSheetObserver);
 
-        if (mBottomSheet.isSheetOpen()) {
-            adapter.refreshSuggestions();
-            mSuggestionsUiDelegate.getEventReporter().onSurfaceOpened();
-            SuggestionsMetrics.recordSurfaceVisible();
-        }
-
         mShadowView = (FadingShadowView) mView.findViewById(R.id.shadow);
         mShadowView.init(
                 ApiCompatibilityUtils.getColor(mView.getResources(), R.color.toolbar_shadow_color),
                 FadingShadow.POSITION_TOP);
 
         mRecyclerView.addOnScrollListener(new OnScrollListener() {
             @Override
             public void onScrolled(RecyclerView recyclerView, int dx, int dy) {
                 boolean shadowVisible = mRecyclerView.canScrollVertically(-1);
                 mShadowView.setVisibility(shadowVisible ? View.VISIBLE : View.GONE);
@@ skipping 74 matching lines @@
             eventReporter = sEventReporterForTesting;
         }
 
         SuggestionsUiDelegateImpl delegate = new SuggestionsUiDelegateImpl(
                 suggestionsSource, eventReporter, navigationDelegate, profile, host);
         if (snippetsBridge != null) delegate.addDestructionObserver(snippetsBridge);
 
         return delegate;
     }
 }