[Home] Add lifecycle events and some tests

chrome/android/java/src/org/chromium/chrome/browser/widget/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;
 
 import android.animation.Animator;
 import android.animation.AnimatorListenerAdapter;
 import android.animation.ValueAnimator;
 import android.content.Context;
@@ skipping 318 matching lines @@
      * @return Whether or not the toolbar Android View is hidden due to being scrolled off-screen.
      */
     private boolean isToolbarAndroidViewHidden() {
         return mFullscreenManager == null || mFullscreenManager.getBottomControlOffset() > 0;
     }
 
     /**
      * Adds layout change listeners to the views that the bottom sheet depends on. Namely the
      * heights of the root view and control container are important as they are used in many of the
      * calculations in this class.
-     * @param activity An activity for loading native pages.
      * @param root The container of the bottom sheet.
      * @param controlContainer The container for the toolbar.
      */
     public void init(View root, View controlContainer) {
         mControlContainer = controlContainer;
         mToolbarHeight = mControlContainer.getHeight();
 
         mBottomSheetContentContainer = (FrameLayout) findViewById(R.id.bottom_sheet_content);
 
         mCurrentState = SHEET_STATE_PEEK;
@@ skipping 36 matching lines @@
         mPlaceholder = new View(getContext());
         LayoutParams placeHolderParams =
                 new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT);
         mPlaceholder.setBackgroundColor(
                 ApiCompatibilityUtils.getColor(getResources(), android.R.color.white));
         mBottomSheetContentContainer.addView(mPlaceholder, placeHolderParams);
     }
 
     @Override
     public int loadUrl(LoadUrlParams params) {
+        for (BottomSheetObserver o : mObservers) o.onLoadUrl(params.getUrl());
+
         // Native page URLs in this context do not need to communicate with the tab.
         if (NativePageFactory.isNativePageUrl(params.getUrl(), isIncognito())) {
             return TabLoadStatus.PAGE_LOAD_FAILED;
         }
 
         // In all non-native cases, minimize the sheet.
         setSheetState(SHEET_STATE_PEEK, true);
 
         assert mTabModelSelector != null;
 
@@ skipping 34 matching lines @@
         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 onExitPeekState() {
+    private void onSheetOpened() {
         if (mSuggestionsContent == null) {
             mSuggestionsContent = new SuggestionsBottomSheetContent(
                     mTabModelSelector.getCurrentTab().getActivity(), this, mTabModelSelector);
         }
 
         showContent(mSuggestionsContent);
+
+        for (BottomSheetObserver o : mObservers) o.onSheetOpened();
     }
 
     /**
+     * A notification that the sheet has returned to the peeking state.
+     */
+    private void onSheetClosed() {
+        for (BottomSheetObserver o : mObservers) o.onSheetClosed();
+    }
+
+    /**
      * Show content in the bottom sheet's content area.
      * @param content The {@link BottomSheetContent} to show.
      */
     private void showContent(BottomSheetContent content) {
         // If the desired content is already showing, do nothing.
         if (mSheetContent == content) return;
 
         if (mSheetContent != null) {
             mBottomSheetContentContainer.removeView(mSheetContent.getScrollingContentView());
             mSheetContent = null;
@@ skipping 121 matching lines @@
         return mContainerHeight - getTranslationY();
     }
 
     /**
      * Sets the sheet's offset relative to the bottom of the screen.
      * @param offset The offset that the sheet should be.
      */
     private void setSheetOffsetFromBottom(float offset) {
         if (MathUtils.areFloatsEqual(getSheetOffsetFromBottom(), getMinOffset())
                 && offset > getMinOffset()) {
-            onExitPeekState();
+            onSheetOpened();
+        }
+
+        if (MathUtils.areFloatsEqual(offset, getMinOffset())

[dgn, 2017/02/20 11:37:14]

nit: else if to make it more easily spottable that onSheetOpened() and
onSheetClosed are mutually exclusive?

That being said, I'm not sure they currently are, since areFloatsEqual()  uses
an epsilon and the > operator doesn't take it into account.

[mdjones, 2017/02/21 17:19:10]

Done. One option to make this more clear is setting the exact height at the
target state after the animation ends. The problem is that float == float is
still going to make presubmit angry and we would have to add code to make sure
the event runs a single time. I think we are going to hit the overlap case
rarely if ever and if we do, we can take another look at this.

+                && getSheetOffsetFromBottom() > getMinOffset()) {
+            onSheetClosed();
         }
 
         setTranslationY(mContainerHeight - offset);
         sendUpdatePeekToHalfEvent();
     }
 
     /**
+     * This is the same as {@link #setSheetOffsetFromBottom(float)} but exclusively for testing.
+     * @param offset The offset to set the sheet to.
+     */
+    @VisibleForTesting
+    public void setSheetOffsetFromBottomForTesting(float offset) {
+        setSheetOffsetFromBottom(offset);
+    }
+
+    /**
      * @return The ratio of the height of the screen that the peeking state is.
      */
-    private float getPeekRatio() {
+    @VisibleForTesting
+    public float getPeekRatio() {
         return mStateRatios[0];
     }
 
     /**
      * @return The ratio of the height of the screen that the half expanded state is.
      */
-    private float getHalfRatio() {
+    @VisibleForTesting
+    public float getHalfRatio() {
         return mStateRatios[1];
     }
 
     /**
      * @return The ratio of the height of the screen that the fully expanded state is.
      */
-    private float getFullRatio() {
+    @VisibleForTesting
+    public float getFullRatio() {
         return mStateRatios[2];
     }
 
     /**
+     * @return The height of the container that the bottom sheet exists in.
+     */
+    @VisibleForTesting
+    public float getSheetContainerHeight() {
+        return mContainerHeight;
+    }
+
+    /**
      * Sends a notification if the sheet is transitioning from the peeking to half expanded state.
      * This method only sends events when the sheet is between the peeking and half states.
      */
     private void sendUpdatePeekToHalfEvent() {
         float screenRatio =
                 mContainerHeight > 0 ? getSheetOffsetFromBottom() / mContainerHeight : 0;
 
         // This ratio is relative to the peek and half positions of the sheet rather than the height
         // of the screen.
         float peekHalfRatio = MathUtils.clamp(
                 (screenRatio - getPeekRatio()) / (getHalfRatio() - getPeekRatio()), 0, 1);
 
         // If the ratio is close enough to zero, just set it to zero.
         if (MathUtils.areFloatsEqual(peekHalfRatio, 0f)) peekHalfRatio = 0f;
 
-        for (BottomSheetObserver o : mObservers) {
-            if (mLastPeekToHalfRatioSent < 1f || peekHalfRatio < 1f) {
-                mLastPeekToHalfRatioSent = peekHalfRatio;
+        if (mLastPeekToHalfRatioSent < 1f || peekHalfRatio < 1f) {
+            mLastPeekToHalfRatioSent = peekHalfRatio;
+            for (BottomSheetObserver o : mObservers) {
                 o.onTransitionPeekToHalf(peekHalfRatio);
             }
         }
     }
 
     /**
      * 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.
@@ skipping 90 matching lines @@
     }
 
     @Override
     public void onFadingViewClick() {
         setSheetState(SHEET_STATE_PEEK, true);
     }
 
     @Override
     public void onFadingViewHidden() {}
 }