[Offline pages] Reinstating the offline icon on tablet and fixing verbose state/URL emphasis

chrome/android/java/src/org/chromium/chrome/browser/omnibox/LocationBarLayout.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.omnibox;
 
 import static org.chromium.chrome.browser.toolbar.ToolbarPhone.URL_FOCUS_CHANGE_ANIMATION_DURATION_MS;
 
 import android.Manifest;
 import android.animation.Animator;
@@ skipping 13 matching lines @@
 import android.graphics.Color;
 import android.graphics.PorterDuff;
 import android.graphics.Rect;
 import android.graphics.drawable.ColorDrawable;
 import android.graphics.drawable.Drawable;
 import android.net.Uri;
 import android.os.Parcelable;
 import android.os.SystemClock;
 import android.provider.Settings;
 import android.speech.RecognizerIntent;
+import android.support.annotation.IntDef;
 import android.text.InputType;
 import android.text.TextUtils;
 import android.util.AttributeSet;
 import android.util.Log;
 import android.util.Pair;
 import android.util.SparseArray;
 import android.view.ActionMode;
 import android.view.KeyEvent;
 import android.view.LayoutInflater;
 import android.view.Menu;
@@ skipping 48 matching lines @@
 import org.chromium.chrome.browser.widget.animation.CancelAwareAnimatorListener;
 import org.chromium.components.security_state.ConnectionSecurityLevel;
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.ui.UiUtils;
 import org.chromium.ui.base.DeviceFormFactor;
 import org.chromium.ui.base.PageTransition;
 import org.chromium.ui.base.WindowAndroid;
 import org.chromium.ui.interpolators.BakedBezierInterpolator;
 
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 
 /**
  * This class represents the location bar where the user types in URLs and
  * search terms.
  */
 public class LocationBarLayout extends FrameLayout implements OnClickListener,
         OnSuggestionsReceivedListener, LocationBar, FakeboxDelegate,
@@ skipping 44 matching lines @@
     private UrlFocusChangeListener mUrlFocusChangeListener;
 
     protected boolean mNativeInitialized;
 
     private final List<Runnable> mDeferredNativeRunnables = new ArrayList<Runnable>();
 
     // The type of the navigation button currently showing.
     private NavigationButtonType mNavigationButtonType;
 
     // The type of the security icon currently active.
-    private int mSecurityIconType;
+    private int mSecurityIconResource;
 
     private final OmniboxResultsAdapter mSuggestionListAdapter;
     private OmniboxSuggestionsList mSuggestionList;
 
     private final List<OmniboxResultItem> mSuggestionItems;
 
     /**
      * The text shown in the URL bar (user text + inline autocomplete) after the most recent set of
      * omnibox suggestions was received. When the user presses enter in the omnibox, this value is
      * compared to the URL bar text to determine whether the first suggestion is still valid.
@@ skipping 22 matching lines @@
 
     private boolean mVoiceSearchEnabled;
 
     // Set to true when the user has started typing new input in the omnibox, set to false
     // when the omnibox loses focus or becomes empty.
     private boolean mHasStartedNewOmniboxEditSession;
     // The timestamp (using SystemClock.elapsedRealtime()) at the point when the user started
     // modifying the omnibox with new input.
     private long mNewOmniboxEditSessionTimestamp = -1;
 
-    private boolean mSecurityButtonShown;
+    @LocationBarButtonType private int mLocationBarButtonType;
 
     private AnimatorSet mLocationBarIconActiveAnimator;
     private AnimatorSet mSecurityButtonShowAnimator;
     private AnimatorSet mNavigationIconShowAnimator;
 
     private OmniboxPrerender mOmniboxPrerender;
 
     private boolean mSuggestionModalShown;
     private boolean mUseDarkColors;
     private boolean mIsEmphasizingHttpsScheme;
@@ skipping 172 matching lines @@
         }
     }
 
     /**
      * Specifies the types of buttons shown to signify different types of navigation elements.
      */
     protected enum NavigationButtonType {
         PAGE,
         MAGNIFIER,
         EMPTY,
-        OFFLINE,
     }
 
+    /** Specifies which button should be shown in location bar, if any. */
+    @Retention(RetentionPolicy.SOURCE)
+    @IntDef({BUTTON_TYPE_NONE, BUTTON_TYPE_SECURITY_ICON, BUTTON_TYPE_NAVIGATION_ICON})
+    public @interface LocationBarButtonType {}
+    /** No button should be shown. */
+    public static final int BUTTON_TYPE_NONE = 0;
+    /** Security button should be shown (includes offline icon). */
+    public static final int BUTTON_TYPE_SECURITY_ICON = 1;
+    /** Navigation button should be shown. */
+    public static final int BUTTON_TYPE_NAVIGATION_ICON = 2;
+
     /**
      * @param outRect Populated with a {@link Rect} that represents the {@link Tab} specific content
      *                of this {@link LocationBar}.
      */
     public void getContentRect(Rect outRect) {
         outRect.set(getPaddingLeft(), getPaddingTop(), getWidth() - getPaddingRight(),
                 getHeight() - getPaddingBottom());
     }
 
     /**
@@ skipping 203 matching lines @@
             }
         }
     }
 
     public LocationBarLayout(Context context, AttributeSet attrs) {
         super(context, attrs);
 
         LayoutInflater.from(context).inflate(R.layout.location_bar, this, true);
         mNavigationButton = (ImageView) findViewById(R.id.navigation_button);
         assert mNavigationButton != null : "Missing navigation type view.";
+
         mNavigationButtonType = DeviceFormFactor.isTablet(context)
                 ? NavigationButtonType.PAGE : NavigationButtonType.EMPTY;
 
         mSecurityButton = (TintedImageButton) findViewById(R.id.security_button);
-        mSecurityIconType = ConnectionSecurityLevel.NONE;
+        mSecurityIconResource = 0;
 
         mVerboseStatusTextView = (TextView) findViewById(R.id.location_bar_verbose_status);
 
         mDeleteButton = (TintedImageButton) findViewById(R.id.delete_button);
 
         mUrlBar = (UrlBar) findViewById(R.id.url_bar);
         // The HTC Sense IME will attempt to autocomplete words in the Omnibox when Prediction is
         // enabled.  We want to disable this feature and rely on the Omnibox's implementation.
         // Their IME does not respect ~TYPE_TEXT_FLAG_AUTO_COMPLETE nor any of the other InputType
         // options I tried, but setting the filter variation prevents it.  Sadly, it also removes
@@ skipping 11 matching lines @@
         mSuggestionListAdapter = new OmniboxResultsAdapter(getContext(), this, mSuggestionItems);
 
         mMicButton = (TintedImageButton) findViewById(R.id.mic_button);
     }
 
     @Override
     protected void onFinishInflate() {
         super.onFinishInflate();
 
         mUrlBar.setCursorVisible(false);
-        mNavigationButton.setVisibility(VISIBLE);
-        mSecurityButton.setVisibility(INVISIBLE);
+
+        mLocationBarButtonType = getLocationBarButtonToShow();
+        mNavigationButton.setVisibility(
+                mLocationBarButtonType == BUTTON_TYPE_NAVIGATION_ICON ? VISIBLE : INVISIBLE);
+        mSecurityButton.setVisibility(
+                mLocationBarButtonType == BUTTON_TYPE_SECURITY_ICON ? VISIBLE : INVISIBLE);
 
         setLayoutTransition(null);
 
         AnimatorListenerAdapter iconChangeAnimatorListener = new AnimatorListenerAdapter() {
             @Override
             public void onAnimationEnd(Animator animation) {
                 if (animation == mSecurityButtonShowAnimator) {
                     mNavigationButton.setVisibility(INVISIBLE);
                 } else if (animation == mNavigationIconShowAnimator) {
                     mSecurityButton.setVisibility(INVISIBLE);
@@ skipping 182 matching lines @@
     public void setAutocompleteProfile(Profile profile) {
         // This will only be called once at least one tab exists, and the tab model is told to
         // update its state. During Chrome initialization the tab model update happens after the
         // call to onNativeLibraryReady, so this assert will not fire.
         assert mNativeInitialized :
                 "Setting Autocomplete Profile before native side initialized";
         mAutocomplete.setProfile(profile);
         mOmniboxPrerender.initializeForProfile(profile);
     }
 
-    private void changeLocationBarIcon(boolean showSecurityButton) {
+    @LocationBarButtonType private int getLocationBarButtonToShow() {
+        boolean isOffline = getCurrentTab() != null && getCurrentTab().isOfflinePage();
+        boolean isTablet = DeviceFormFactor.isTablet(getContext());
+
+        if (mUrlHasFocus) {
+            return isTablet ? BUTTON_TYPE_NAVIGATION_ICON : BUTTON_TYPE_NONE;
+        }
+
+        return getSecurityIconResource(getSecurityLevel(), !isTablet, isOffline) != 0
+                ? BUTTON_TYPE_SECURITY_ICON
+                : BUTTON_TYPE_NONE;
+    }
+
+    private void changeLocationBarIcon() {
         if (mLocationBarIconActiveAnimator != null && mLocationBarIconActiveAnimator.isRunning()) {
             mLocationBarIconActiveAnimator.cancel();
         }
-        View viewToBeShown = showSecurityButton ? mSecurityButton : mNavigationButton;
+
+        mLocationBarButtonType = getLocationBarButtonToShow();
+
+        View viewToBeShown = null;
+        switch (mLocationBarButtonType) {
+            case BUTTON_TYPE_SECURITY_ICON:
+                viewToBeShown = mSecurityButton;
+                mLocationBarIconActiveAnimator = mSecurityButtonShowAnimator;
+                break;
+            case BUTTON_TYPE_NAVIGATION_ICON:
+                viewToBeShown = mNavigationButton;
+                mLocationBarIconActiveAnimator = mNavigationIconShowAnimator;
+                break;
+            case BUTTON_TYPE_NONE:
+                mLocationBarIconActiveAnimator = null;
+                return;
+        }
+
         if (viewToBeShown.getVisibility() == VISIBLE && viewToBeShown.getAlpha() == 1) {
             return;
         }
-        if (showSecurityButton) {
-            mLocationBarIconActiveAnimator = mSecurityButtonShowAnimator;
-        } else {
-            mLocationBarIconActiveAnimator = mNavigationIconShowAnimator;
-        }
         if (shouldAnimateIconChanges()) {
             mLocationBarIconActiveAnimator.setDuration(URL_FOCUS_CHANGE_ANIMATION_DURATION_MS);
         } else {
             mLocationBarIconActiveAnimator.setDuration(0);
         }
         mLocationBarIconActiveAnimator.start();
     }
 
     @Override
     public void setUrlBarFocus(boolean shouldBeFocused) {
@@ skipping 77 matching lines @@
                 setUrlToPageUrl();
                 emphasizeUrl();
             }
         }
 
         if (getToolbarDataProvider().isUsingBrandColor()) {
             updateVisualsForState();
             if (mUrlHasFocus) mUrlBar.selectAll();
         }
 
-        changeLocationBarIcon(
-                (!DeviceFormFactor.isTablet(getContext()) || !hasFocus) && isSecurityButtonShown());
+        changeLocationBarIcon();
         mUrlBar.setCursorVisible(hasFocus);
 
         if (!mUrlFocusedWithoutAnimations) handleUrlFocusAnimation(hasFocus);
 
         if (hasFocus && currentTab != null && !currentTab.isIncognito()) {
             if (mNativeInitialized
                     && TemplateUrlService.getInstance().isDefaultSearchEngineGoogle()) {
                 GeolocationHeader.primeLocationForGeoHeader(getContext());
             } else {
                 mDeferredNativeRunnables.add(new Runnable() {
@@ skipping 209 matching lines @@
     }
 
     // Updates the navigation button based on the URL string
     private void updateNavigationButton() {
         boolean isTablet = DeviceFormFactor.isTablet(getContext());
         NavigationButtonType type = NavigationButtonType.EMPTY;
         if (isTablet && !mSuggestionItems.isEmpty()) {
             // If there are suggestions showing, show the icon for the default suggestion.
             type = suggestionTypeToNavigationButtonType(
                     mSuggestionItems.get(0).getSuggestion());
-        } else if (!mUrlHasFocus && getCurrentTab() != null && getCurrentTab().isOfflinePage()) {
-            type = NavigationButtonType.OFFLINE;
         } else if (isTablet) {
             type = NavigationButtonType.PAGE;
         }
 
         if (type != mNavigationButtonType) setNavigationButtonType(type);
     }
 
     private int getSecurityLevel() {
         if (getCurrentTab() == null) return ConnectionSecurityLevel.NONE;
         return getCurrentTab().getSecurityLevel();
     }
 
     /**
      * Determines the icon that should be displayed for the current security level.
      * @param securityLevel The security level for which the resource will be returned.
      * @param isSmallDevice Whether the device form factor is small (like a phone) or large
      * (like a tablet).
      * @return The resource ID of the icon that should be displayed, 0 if no icon should show.
      */
-    public static int getSecurityIconResource(int securityLevel, boolean isSmallDevice) {
+    public static int getSecurityIconResource(
+            int securityLevel, boolean isSmallDevice, boolean isOfflinePage) {
+        // Both conditions should be met, because isOfflinePage might take longer to be cleared.
+        if (securityLevel == ConnectionSecurityLevel.NONE && isOfflinePage) {
+            return R.drawable.offline_pin;
+        }
         switch (securityLevel) {
             case ConnectionSecurityLevel.NONE:
             case ConnectionSecurityLevel.HTTP_SHOW_WARNING:
                 return isSmallDevice ? 0 : R.drawable.omnibox_info;
             case ConnectionSecurityLevel.SECURITY_WARNING:
                 return R.drawable.omnibox_info;
             case ConnectionSecurityLevel.DANGEROUS:
                 return R.drawable.omnibox_https_invalid;
             case ConnectionSecurityLevel.SECURE:
             case ConnectionSecurityLevel.EV_SECURE:
@@ skipping 38 matching lines @@
         assert list != null : "Missing ColorStateList for Security Button.";
         return list;
     }
 
     /**
      * Updates the security icon displayed in the LocationBar.
      */
     @Override
     public void updateSecurityIcon(int securityLevel) {
         boolean isSmallDevice = !DeviceFormFactor.isTablet(getContext());
-        int id = getSecurityIconResource(securityLevel, isSmallDevice);
+        boolean isOfflinePage = getCurrentTab() != null && getCurrentTab().isOfflinePage();
+        int id = getSecurityIconResource(securityLevel, isSmallDevice, isOfflinePage);
         if (id == 0) {
             mSecurityButton.setImageDrawable(null);
         } else {
             // ImageView#setImageResource is no-op if given resource is the current one.
             mSecurityButton.setImageResource(id);
             mSecurityButton.setTint(getColorStateList(securityLevel, getToolbarDataProvider(),
                     getResources(), ColorUtils.shouldUseOpaqueTextboxBackground(
                             getToolbarDataProvider().getPrimaryColor())));
         }
 
+        updateVerboseStatusVisibility();
+
         boolean shouldEmphasizeHttpsScheme = shouldEmphasizeHttpsScheme();
-        if (mSecurityIconType == securityLevel
+        if (mSecurityIconResource == id
                 && mIsEmphasizingHttpsScheme == shouldEmphasizeHttpsScheme) {
             return;
         }
-        mSecurityIconType = securityLevel;
+        mSecurityIconResource = id;
 
-        updateSecurityButton(!(securityLevel == ConnectionSecurityLevel.NONE && isSmallDevice));
+        changeLocationBarIcon();
+        updateLocationBarIconContainerVisibility();
         // Since we emphasize the scheme of the URL based on the security type, we need to
         // refresh the emphasis.
         mUrlBar.deEmphasizeUrl();
         emphasizeUrl();
-        mIsEmphasizingHttpsScheme = shouldEmphasizeHttpsScheme;
+        mIsEmphasizingHttpsScheme = shouldEmphasizeHttpsScheme();

[Ted C, 2016/10/24 17:19:45]

why this change?  we calculate shouldEmphasizeHttpsScheme above and were using
it previously.  Does something that happens after the early return cause this to
be changed from that value?  If so, we should document that as it is not
immediately clear.

[fgorski, 2016/10/24 22:34:14]

No I think I was experimenting with removing the calculation above and then only
do it here. This was left in unintentionally. 

     }
 
     private void emphasizeUrl() {
         mUrlBar.emphasizeUrl();
     }
 
     @Override
     public boolean shouldEmphasizeHttpsScheme() {
         ToolbarDataProvider provider = getToolbarDataProvider();
         if (provider.isUsingBrandColor() || provider.isIncognito()) return false;
         return true;
     }
 
     /**
-     * Updates the display of the security button.
-     * @param enabled Whether the security button should be displayed.
-     */
-    private void updateSecurityButton(boolean enabled) {
-        changeLocationBarIcon(enabled
-                && (!DeviceFormFactor.isTablet(getContext()) || !mUrlHasFocus));
-        mSecurityButtonShown = enabled;
-        updateLocationBarIconContainerVisibility();
-    }
-
-    /**
      * @return Whether the security button is currently being displayed.
      */
     @VisibleForTesting
     public boolean isSecurityButtonShown() {
-        return mSecurityButtonShown;
+        return mLocationBarButtonType == BUTTON_TYPE_SECURITY_ICON;
     }
 
     /**
      * Sets the type of the current navigation type and updates the UI to match it.
      * @param buttonType The type of navigation button to be shown.
      */
     private void setNavigationButtonType(NavigationButtonType buttonType) {
+        if (!DeviceFormFactor.isTablet(getContext())) return;
         switch (buttonType) {
             case PAGE:
                 Drawable page = ApiCompatibilityUtils.getDrawable(
                         getResources(), R.drawable.ic_omnibox_page);
                 page.setColorFilter(mUseDarkColors
                         ? ApiCompatibilityUtils.getColor(getResources(), R.color.light_normal_color)
                         : Color.WHITE, PorterDuff.Mode.SRC_IN);
                 mNavigationButton.setImageDrawable(page);
                 break;
             case MAGNIFIER:
                 mNavigationButton.setImageResource(R.drawable.ic_omnibox_magnifier);
                 break;
             case EMPTY:
                 mNavigationButton.setImageDrawable(null);
                 break;
-            case OFFLINE:
-                Drawable bolt = ApiCompatibilityUtils.getDrawable(
-                        getResources(), R.drawable.offline_pin);
-                bolt.mutate().setColorFilter(
-                        ApiCompatibilityUtils.getColor(getResources(), mUseDarkColors
-                                ? R.color.locationbar_status_color
-                                : R.color.locationbar_status_color_light), PorterDuff.Mode.SRC_IN);
-                mNavigationButton.setImageDrawable(bolt);
-                break;
             default:
                 assert false;
         }
 
         if (mNavigationButton.getVisibility() != VISIBLE) {
             mNavigationButton.setVisibility(VISIBLE);
         }
         mNavigationButtonType = buttonType;
 
-        updateVerboseStatusVisibility();
         updateLocationBarIconContainerVisibility();
     }
 
     /**
      * Update visibility of the verbose status based on the button type and focus state of the
      * omnibox.
      */
     private void updateVerboseStatusVisibility() {
-        boolean verboseStatusVisible =
-                mNavigationButtonType == NavigationButtonType.OFFLINE && !mUrlHasFocus;
+        // Because is offline page is cleared a bit slower, we also ensure that connection security
+        // level is NONE.
+        boolean verboseStatusVisible = !mUrlHasFocus && getCurrentTab() != null
+                && getCurrentTab().isOfflinePage()
+                && getSecurityLevel() == ConnectionSecurityLevel.NONE;
 
         int verboseStatusVisibility = verboseStatusVisible ? VISIBLE : GONE;
 
         mVerboseStatusTextView.setTextColor(ApiCompatibilityUtils.getColor(getResources(),
                 mUseDarkColors ? R.color.locationbar_status_color
                         : R.color.locationbar_status_color_light));
         mVerboseStatusTextView.setVisibility(verboseStatusVisibility);
 
         View separator = findViewById(R.id.location_bar_verbose_status_separator);
         separator.setBackgroundColor(ApiCompatibilityUtils.getColor(getResources(), mUseDarkColors
                 ? R.color.locationbar_status_separator_color
                 : R.color.locationbar_status_separator_color_light));
         separator.setVisibility(verboseStatusVisibility);
 
         findViewById(R.id.location_bar_verbose_status_extra_space)
                 .setVisibility(verboseStatusVisibility);
     }
 
     /**
      * Update the visibility of the location bar icon container based on the state of the
      * security and navigation icons.
      */
     protected void updateLocationBarIconContainerVisibility() {
-        boolean showContainer =
-                mSecurityButtonShown || mNavigationButtonType != NavigationButtonType.EMPTY;
-        findViewById(R.id.location_bar_icon).setVisibility(showContainer ? VISIBLE : GONE);
+        @LocationBarButtonType
+        int buttonToShow = getLocationBarButtonToShow();
+        findViewById(R.id.location_bar_icon)
+                .setVisibility(buttonToShow != BUTTON_TYPE_NONE ? VISIBLE : GONE);
     }
 
     /**
      * Updates the layout params for the location bar start aligned views.
      */
     protected void updateLayoutParams() {
         int startMargin = 0;
         int urlContainerChildIndex = -1;
         for (int i = 0; i < getChildCount(); i++) {
             View childView = getChildAt(i);
@@ skipping 1037 matching lines @@
     public View getContainerView() {
         return this;
     }
 
     @Override
     public void setTitleToPageTitle() { }
 
     @Override
     public void setShowTitle(boolean showTitle) { }
 }