Add new NTP layout with snippet cards and hide it behind a flag

chrome/android/java/src/org/chromium/chrome/browser/ntp/NewTabPageView.java

 // 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.ntp;
 
 import android.annotation.SuppressLint;
 import android.content.Context;
 import android.content.res.Resources;
 import android.graphics.Bitmap;
 import android.graphics.BitmapFactory;
 import android.graphics.Canvas;
 import android.graphics.Color;
 import android.graphics.Rect;
 import android.graphics.drawable.BitmapDrawable;
 import android.net.Uri;
 import android.os.Build;
 import android.support.v4.graphics.drawable.RoundedBitmapDrawable;
 import android.support.v4.graphics.drawable.RoundedBitmapDrawableFactory;
-import android.support.v7.widget.LinearLayoutManager;
 import android.support.v7.widget.RecyclerView;
 import android.text.Editable;
 import android.text.TextUtils;
 import android.text.TextWatcher;
 import android.text.method.LinkMovementMethod;
 import android.text.style.ClickableSpan;
 import android.util.AttributeSet;
 import android.view.LayoutInflater;
 import android.view.MotionEvent;
 import android.view.View;
@@ skipping 35 matching lines @@
  * The native new tab page, represented by some basic data such as title and url, and an Android
  * View that displays the page.
  */
 public class NewTabPageView extends FrameLayout
         implements MostVisitedURLsObserver, OnLayoutChangeListener {
 
     private static final int SHADOW_COLOR = 0x11000000;
     private static final long SNAP_SCROLL_DELAY_MS = 30;
     private static final String TAG = "NewTabPageView";
 
-    private ViewGroup mContentView;
+    // Note: Only one of these will be valid at a time, depending on if we are using the old NTP
+    // (NewTabScrollView) or the new NTP with cards (NewTabRecyclerView).
     private NewTabScrollView mScrollView;

[dgn, 2016/03/25 16:29:20]

Would it make sense to use composition or inheritance to abstract away the fact
that we have two different modes here? one of the members is always invalid, and
another member is being used to differentiate in which case we are. We even have
methods in here to hide that (getVerticalScroll)

+    private NewTabRecyclerView mRecyclerView;
+
+    private NewTabPageLayout mContentView;
     private LogoView mSearchProviderLogoView;
     private View mSearchBoxView;
     private TextView mSearchBoxTextView;
     private ImageView mVoiceSearchButton;
     private MostVisitedLayout mMostVisitedLayout;
     private View mMostVisitedPlaceholder;
     private View mOptOutView;
     private View mNoSearchLogoSpacer;
-    private RecyclerView mSnippetsView;
+    private NewTabPageCardsManager mCardsManager;
 
     private OnSearchBoxScrollListener mSearchBoxScrollListener;
 
     private NewTabPageManager mManager;
     private MostVisitedDesign mMostVisitedDesign;
     private MostVisitedItem[] mMostVisitedItems;
     private boolean mFirstShow = true;
     private boolean mSearchProviderHasLogo = true;
     private boolean mHasReceivedMostVisitedSites;
     private boolean mPendingSnapScroll;
+    private boolean mAreSnippetsEnabled;
 
     /**
      * The number of asynchronous tasks that need to complete before the page is done loading.
      * This starts at one to track when the view is finished attaching to the window.
      */
     private int mPendingLoadTasks = 1;
     private boolean mLoadHasCompleted;
 
     private float mUrlFocusChangePercent;
     private boolean mDisableUrlFocusChangeAnimations;
@@ skipping 143 matching lines @@
      * used in any other way.
      *
      * @param manager NewTabPageManager used to perform various actions when the user interacts
      *                with the page.
      * @param isSingleUrlBarMode Whether the NTP is in single URL bar mode.
      * @param searchProviderHasLogo Whether the search provider has a logo.
      */
     public void initialize(NewTabPageManager manager, boolean isSingleUrlBarMode,
             boolean searchProviderHasLogo, SnippetsManager snippetsManager) {
         mManager = manager;
+        ViewStub stub = (ViewStub) findViewById(R.id.new_tab_page_layout_stub);
 
-        mScrollView = (NewTabScrollView) findViewById(R.id.ntp_scrollview);
-        mScrollView.enableBottomShadow(SHADOW_COLOR);
-        mContentView = (ViewGroup) findViewById(R.id.ntp_content);
+        mAreSnippetsEnabled = ChromeFeatureList.isEnabled(ChromeFeatureList.NTP_SNIPPETS);
+
+        if (mAreSnippetsEnabled) {
+            stub.setLayoutResource(R.layout.new_tab_page_recyclerview);
+            mRecyclerView = (NewTabRecyclerView) stub.inflate();
+            mContentView = (NewTabPageLayout) LayoutInflater.from(getContext())
+                                   .inflate(R.layout.new_tab_page_layout, null);
+        } else {
+            stub.setLayoutResource(R.layout.new_tab_page_scrollview);
+            mScrollView = (NewTabScrollView) stub.inflate();
+            mScrollView.enableBottomShadow(SHADOW_COLOR);
+            mContentView = (NewTabPageLayout) findViewById(R.id.ntp_content);
+        }
 
         mMostVisitedDesign = new MostVisitedDesign(getContext());
-        mMostVisitedLayout = (MostVisitedLayout) findViewById(R.id.most_visited_layout);
+        mMostVisitedLayout =
+                (MostVisitedLayout) mContentView.findViewById(R.id.most_visited_layout);
         mMostVisitedDesign.initMostVisitedLayout(mMostVisitedLayout, searchProviderHasLogo);
 
-        mSearchProviderLogoView = (LogoView) findViewById(R.id.search_provider_logo);
-        mSearchBoxView = findViewById(R.id.search_box);
-        mNoSearchLogoSpacer = findViewById(R.id.no_search_logo_spacer);
+        mSearchProviderLogoView = (LogoView) mContentView.findViewById(R.id.search_provider_logo);
+        mSearchBoxView = mContentView.findViewById(R.id.search_box);
+        mNoSearchLogoSpacer = mContentView.findViewById(R.id.no_search_logo_spacer);
 
         mSearchBoxTextView = (TextView) mSearchBoxView.findViewById(R.id.search_box_text);
         String hintText = getResources().getString(R.string.search_or_type_url);
         if (isSingleUrlBarMode) {
             mSearchBoxTextView.setHint(hintText);
         } else {
             mSearchBoxTextView.setContentDescription(hintText);
         }
         mSearchBoxTextView.setOnClickListener(new View.OnClickListener() {
             @Override
@@ skipping 11 matching lines @@
             }
 
             @Override
             public void afterTextChanged(Editable s) {
                 if (s.length() == 0) return;
                 mManager.focusSearchBox(false, s.toString());
                 mSearchBoxTextView.setText("");
             }
         });
 
-        mVoiceSearchButton = (ImageView) findViewById(R.id.voice_search_button);
+        mVoiceSearchButton = (ImageView) mContentView.findViewById(R.id.voice_search_button);
         mVoiceSearchButton.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
                 mManager.focusSearchBox(true, null);
             }
         });
 
         // Set up the toolbar
         NewTabPageToolbar toolbar = (NewTabPageToolbar) findViewById(R.id.ntp_toolbar);
         if (manager.isToolbarEnabled()) {
@@ skipping 15 matching lines @@
                     mManager.navigateToInterests();
                 }
             });
 
             // Set up interests
             if (manager.isInterestsEnabled()) {
                 toolbar.getInterestsButton().setVisibility(View.VISIBLE);
             }
         } else {
             ((ViewGroup) toolbar.getParent()).removeView(toolbar);
-            FrameLayout.LayoutParams params =
-                    (FrameLayout.LayoutParams) mScrollView.getLayoutParams();
-            params.bottomMargin = 0;
-            mScrollView.setLayoutParams(params);
+            if (!ChromeFeatureList.isEnabled(ChromeFeatureList.NTP_SNIPPETS)) {

[newt (away), 2016/03/24 19:47:39]

better: if (mScrollView != null)

[dgn, 2016/03/28 21:33:02]

We have mAreSnippetsEnabled for that, right? Isn't it clearer to use it? We
probably want it to crash is somehow mScrollView turns out to be created with
enabledSnippets

+                // Only remove if we're using the old NTP view, the new one does not use a
+                // ScrollView
+                FrameLayout.LayoutParams params =
+                        (FrameLayout.LayoutParams) mScrollView.getLayoutParams();
+                params.bottomMargin = 0;
+                mScrollView.setLayoutParams(params);
+            }
         }
 
-        initializeSearchBoxScrollHandling();
         addOnLayoutChangeListener(this);
         setSearchProviderHasLogo(searchProviderHasLogo);
 
         mPendingLoadTasks++;
         mManager.setMostVisitedURLsObserver(this,
                 mMostVisitedDesign.getNumberOfTiles(searchProviderHasLogo));
 
         if (mManager.shouldShowOptOutPromo()) showOptOutPromo();
 
         // Set up snippets
-        if (ChromeFeatureList.isEnabled(ChromeFeatureList.NTP_SNIPPETS)) {
-            mSnippetsView = (RecyclerView) findViewById(R.id.snippets_card_list);
-            mSnippetsView.setVisibility(View.VISIBLE);
+        if (mAreSnippetsEnabled) {
+            mCardsManager = new NewTabPageCardsManager(snippetsManager, mContentView);
+            mRecyclerView.setAdapter(mCardsManager);
+
             RecordHistogram.recordEnumeratedHistogram(SnippetsManager.SNIPPETS_STATE_HISTOGRAM,
                     SnippetsManager.SNIPPETS_SHOWN, SnippetsManager.NUM_SNIPPETS_ACTIONS);
-            mSnippetsView.setLayoutManager(new LinearLayoutManager(getContext()));
-            mSnippetsView.addOnScrollListener(new RecyclerView.OnScrollListener() {
+            mRecyclerView.addOnScrollListener(new RecyclerView.OnScrollListener() {
                 private boolean mScrolledOnce = false;
                 @Override
                 public void onScrollStateChanged(RecyclerView recyclerView, int newState) {
                     if (newState != RecyclerView.SCROLL_STATE_DRAGGING) return;
                     RecordUserAction.record("MobileNTP.Snippets.Scrolled");
                     if (mScrolledOnce) return;
                     mScrolledOnce = true;
                     RecordHistogram.recordEnumeratedHistogram(
                             SnippetsManager.SNIPPETS_STATE_HISTOGRAM,
                             SnippetsManager.SNIPPETS_SCROLLED,
                             SnippetsManager.NUM_SNIPPETS_ACTIONS);
                 }
             });
-            snippetsManager.setSnippetsView(mSnippetsView);
+            initializeSearchBoxRecyclerViewScrollHandling();
+        } else {
+            initializeSearchBoxScrollHandling();
         }
     }
 
     private int getTabsMovedIllustration() {
         switch (Build.MANUFACTURER.toLowerCase(Locale.US)) {
             case "samsung":
                 if (DocumentModeManager.isDeviceTabbedModeByDefault()) return 0;
                 return R.drawable.tabs_moved_samsung;
             case "htc":
                 return R.drawable.tabs_moved_htc;
@@ skipping 50 matching lines @@
         });
         mManager.optOutPromoShown();
     }
 
     private void updateSearchBoxOnScroll() {
         if (mDisableUrlFocusChangeAnimations) return;
 
         float percentage = 0;
         // During startup the view may not be fully initialized, so we only calculate the current
         // percentage if some basic view properties are sane.
-        if (mScrollView.getHeight() != 0 && mSearchBoxView.getTop() != 0) {
-            int scrollY = mScrollView.getScrollY();
-            percentage = Math.max(
-                    0f, Math.min(1f, scrollY / (float) mSearchBoxView.getTop()));
+        if (mAreSnippetsEnabled) {

[newt (away), 2016/03/24 19:47:39]

lines 468-478 need more de-duplication. The only difference between the two part
is "mRecyclerView.getHeight()" and "mScrollView.getHeight()"; extract that
difference and remove the duplication.

[dgn, 2016/03/28 21:33:02]

Done.

+            if (mRecyclerView.getHeight() != 0 && mSearchBoxView.getTop() != 0) {
+                int scrollY = getVerticalScroll();
+                percentage = Math.max(0f, Math.min(1f, scrollY / (float) mSearchBoxView.getTop()));
+            }
+        } else {
+            if (mScrollView.getHeight() != 0 && mSearchBoxView.getTop() != 0) {
+                int scrollY = getVerticalScroll();
+                percentage = Math.max(0f, Math.min(1f, scrollY / (float) mSearchBoxView.getTop()));
+            }
         }
 
         updateVisualsForToolbarTransition(percentage);
 
         if (mSearchBoxScrollListener != null) {
             mSearchBoxScrollListener.onNtpScrollChanged(percentage);
         }
     }
 
+    private void initializeSearchBoxRecyclerViewScrollHandling() {
+        mRecyclerView.addOnScrollListener(new RecyclerView.OnScrollListener() {
+            @Override
+            public void onScrolled(RecyclerView recyclerView, int dx, int dy) {
+                updateSearchBoxOnScroll();
+            }
+        });
+    }
+
     private void initializeSearchBoxScrollHandling() {
         final Runnable mSnapScrollRunnable = new Runnable() {
             @Override
             public void run() {
                 if (!mPendingSnapScroll) return;
                 int scrollY = mScrollView.getScrollY();
                 int dividerTop = mMostVisitedLayout.getTop() - mContentView.getPaddingTop();
                 if (scrollY > 0 && scrollY < dividerTop) {
                     mScrollView.smoothScrollTo(0, scrollY < (dividerTop / 2) ? 0 : dividerTop);
                 }
@@ skipping 152 matching lines @@
     float getUrlFocusChangeAnimationPercent() {
         return mUrlFocusChangePercent;
     }
 
     /**
      * Unconditionally sets the percentage the URL is focused during an animation, without updating
      * mUrlFocusChangePercent.
      * @see #setUrlFocusChangeAnimationPercent
      */
     private void setUrlFocusChangeAnimationPercentInternal(float percent) {
-        mContentView.setTranslationY(percent * (-mMostVisitedLayout.getTop()
-                + mScrollView.getScrollY() + mContentView.getPaddingTop()));
+        int scrollOffset = mAreSnippetsEnabled ? mRecyclerView.computeVerticalScrollOffset()
+                                               : mScrollView.getScrollY();
+        mContentView.setTranslationY(percent
+                * (-mMostVisitedLayout.getTop() + scrollOffset + mContentView.getPaddingTop()));
         updateVisualsForToolbarTransition(percent);
     }
 
     private void updateVisualsForToolbarTransition(float transitionPercentage) {
         // Complete the full alpha transition in the first 40% of the animation.
         float searchUiAlpha =
                 transitionPercentage >= 0.4f ? 0f : (0.4f - transitionPercentage) * 2.5f;
         // Ensure there are no rounding issues when the animation percent is 0.
         if (transitionPercentage == 0f) searchUiAlpha = 1f;
 
@@ skipping 15 matching lines @@
     void getSearchBoxBounds(Rect originalBounds, Rect transformedBounds) {
         int searchBoxX = (int) mSearchBoxView.getX();
         int searchBoxY = (int) mSearchBoxView.getY();
         originalBounds.set(
                 searchBoxX + mSearchBoxView.getPaddingLeft(),
                 searchBoxY + mSearchBoxView.getPaddingTop(),
                 searchBoxX + mSearchBoxView.getWidth() - mSearchBoxView.getPaddingRight(),
                 searchBoxY + mSearchBoxView.getHeight() - mSearchBoxView.getPaddingBottom());
 
         transformedBounds.set(originalBounds);
+
         View view = (View) mSearchBoxView.getParent();
         while (view != null) {
-            transformedBounds.offset(-view.getScrollX(), -view.getScrollY());
+            if (view instanceof RecyclerView) {
+                transformedBounds.offset(-((RecyclerView) view).computeHorizontalScrollOffset(),
+                        -((RecyclerView) view).computeVerticalScrollOffset());
+            } else {
+                transformedBounds.offset(-view.getScrollX(), -view.getScrollY());
+            }
             if (view == this) break;
             transformedBounds.offset((int) view.getX(), (int) view.getY());
             view = (View) view.getParent();
         }
     }
 
     /**
      * Sets the listener for search box scroll changes.
      * @param listener The listener to be notified on changes.
      */
@@ skipping 34 matching lines @@
     @Override
     protected void onWindowVisibilityChanged(int visibility) {
         super.onWindowVisibilityChanged(visibility);
 
         if (visibility == VISIBLE) {
             updateVoiceSearchButtonVisibility();
         }
     }
 
     @Override
     protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {

[newt (away), 2016/03/24 19:47:39]

This method should be deleted and the remainder of the logic in it should also
be moved to NewTabPageLayout. In particular, mContentView.setMostVisitedWidth()
should not exist; that's the subtle timing dependency that I mentioned should be
removed.

[dgn, 2016/03/28 21:33:02]

Done. I'm not familiar with the layout mechanisms though. In which cases do we
run into those timing dependencies? I'd expect the measurements to happen on the
UI thread only and not have race conditions...

         super.onMeasure(widthMeasureSpec, heightMeasureSpec);
 
         // Make the search box and logo the same width as the most visited tiles.
         if (mMostVisitedLayout.getVisibility() != GONE) {
-            int mostVisitedWidth = MeasureSpec.makeMeasureSpec(mMostVisitedLayout.getMeasuredWidth()
-                    - mMostVisitedDesign.getMostVisitedLayoutBleed(), MeasureSpec.EXACTLY);
-            int searchBoxHeight = MeasureSpec.makeMeasureSpec(
-                    mSearchBoxView.getMeasuredHeight(), MeasureSpec.EXACTLY);
-            int logoHeight = MeasureSpec.makeMeasureSpec(
-                    mSearchProviderLogoView.getMeasuredHeight(), MeasureSpec.EXACTLY);
-            mSearchBoxView.measure(mostVisitedWidth, searchBoxHeight);
-            mSearchProviderLogoView.measure(mostVisitedWidth, logoHeight);
+            mContentView.setMostVisitedWidth(mMostVisitedLayout.getMeasuredWidth()
+                    - mMostVisitedDesign.getMostVisitedLayoutBleed());
         }

[May, 2016/03/24 07:21:20]

To whoever takes over this CL: This needs an else {
mContentView.setMostVisitedWidth(0); }

[dgn, 2016/03/25 16:29:20]

Done.

     }
 
     /**
      * @see org.chromium.chrome.browser.compositor.layouts.content.
      *         InvalidationAwareThumbnailProvider#shouldCaptureThumbnail()
      */
     boolean shouldCaptureThumbnail() {
         if (getWidth() == 0 || getHeight() == 0) return false;
 
-        return mSnapshotMostVisitedChanged
-                || getWidth() != mSnapshotWidth
-                || getHeight() != mSnapshotHeight
-                || mScrollView.getScrollY() != mSnapshotScrollY;
+        return mSnapshotMostVisitedChanged || getWidth() != mSnapshotWidth
+                || getHeight() != mSnapshotHeight || getVerticalScroll() != mSnapshotScrollY;
     }
 
     /**
      * @see org.chromium.chrome.browser.compositor.layouts.content.
      *         InvalidationAwareThumbnailProvider#captureThumbnail(Canvas)
      */
     void captureThumbnail(Canvas canvas) {
         mSearchProviderLogoView.endFadeAnimation();
         ViewUtils.captureBitmap(this, canvas);
         mSnapshotWidth = getWidth();
         mSnapshotHeight = getHeight();
-        mSnapshotScrollY = mScrollView.getScrollY();
+        mSnapshotScrollY = getVerticalScroll();
         mSnapshotMostVisitedChanged = false;
     }
 
     // OnLayoutChangeListener overrides
 
     @Override
     public void onLayoutChange(View v, int left, int top, int right, int bottom,
             int oldLeft, int oldTop, int oldRight, int oldBottom) {
         int oldWidth = oldRight - oldLeft;
         int newWidth = right - left;
@@ skipping 243 matching lines @@
             for (MostVisitedItem item : mMostVisitedItems) {
                 if (item.getUrl().equals(url)) {
                     LargeIconCallback iconCallback = new LargeIconCallbackImpl(
                             item, (MostVisitedItemView) item.getView(), false);
                     mManager.getLargeIconForUrl(url, mMinIconSize, iconCallback);
                     break;
                 }
             }
         }
     }
+
+    private int getVerticalScroll() {
+        if (mAreSnippetsEnabled) {
+            return mRecyclerView.computeVerticalScrollOffset();
+        } else {
+            return mScrollView.getScrollY();
+        }
+    }
 }