Code cleanup for Translate Compact Infobar.

chrome/android/java/src/org/chromium/chrome/browser/infobar/TranslateCompactInfoBar.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.infobar;
 
 import android.support.design.widget.TabLayout;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.View.OnClickListener;
+import android.view.View.OnLayoutChangeListener;
 import android.widget.LinearLayout;
 
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.base.metrics.RecordHistogram;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.infobar.translate.TranslateMenu;
 import org.chromium.chrome.browser.infobar.translate.TranslateMenuHelper;
 import org.chromium.chrome.browser.infobar.translate.TranslateTabLayout;
 import org.chromium.chrome.browser.snackbar.Snackbar;
 import org.chromium.chrome.browser.snackbar.SnackbarManager.SnackbarController;
 import org.chromium.chrome.browser.widget.TintedImageButton;
 import org.chromium.ui.widget.Toast;
 
 /**
  * Java version of the compact translate infobar.
  */
-class TranslateCompactInfoBar extends InfoBar implements TabLayout.OnTabSelectedListener,
-                                                         TranslateMenuHelper.TranslateMenuListener,
-                                                         View.OnLayoutChangeListener {
+class TranslateCompactInfoBar extends InfoBar
+        implements TabLayout.OnTabSelectedListener, TranslateMenuHelper.TranslateMenuListener {
     public static final int TRANSLATING_INFOBAR = 1;
 
     private static final int SOURCE_TAB_INDEX = 0;
     private static final int TARGET_TAB_INDEX = 1;
 
     // Action ID for Snackbar.
     // Actions performed by clicking on on the overflow menu.
     public static final int ACTION_OVERFLOW_ALWAYS_TRANSLATE = 0;
     public static final int ACTION_OVERFLOW_NEVER_SITE = 1;
     public static final int ACTION_OVERFLOW_NEVER_LANGUAGE = 2;
@@ skipping 55 matching lines @@
     private static final int INFOBAR_SNACKBAR_AUTO_NEVER_IMPRESSION = 22;
     private static final int INFOBAR_SNACKBAR_CANCEL_AUTO_ALWAYS = 23;
     private static final int INFOBAR_SNACKBAR_CANCEL_AUTO_NEVER = 24;
     private static final int INFOBAR_HISTOGRAM_BOUNDARY = 25;
 
     // Need 2 instances of TranslateMenuHelper to prevent a race condition bug which happens when
     // showing language menu after dismissing overflow menu.
     private TranslateMenuHelper mOverflowMenuHelper;
     private TranslateMenuHelper mLanguageMenuHelper;
     private TintedImageButton mMenuButton;
-    private boolean mUserInteracted;
+
+    private boolean mMenuExpanded;
 
     /** The controller for translate UI snackbars. */
     class TranslateSnackbarController implements SnackbarController {
         private final int mActionId;
 
         public TranslateSnackbarController(int actionId) {
             mActionId = actionId;
         }
 
         @Override
@@ skipping 10 matching lines @@
                 case ACTION_AUTO_ALWAYS_TRANSLATE:
                     recordInfobarAction(INFOBAR_SNACKBAR_CANCEL_AUTO_ALWAYS);
                     return;
                 case ACTION_OVERFLOW_NEVER_LANGUAGE:
                     recordInfobarAction(INFOBAR_SNACKBAR_CANCEL_NEVER);
                     return;
                 case ACTION_AUTO_NEVER_LANGUAGE:
                     recordInfobarAction(INFOBAR_SNACKBAR_CANCEL_AUTO_NEVER);
                     // This snackbar is triggered automatically after a close button click.  Need to
                     // dismiss the infobar even if the user cancels the "Never Translate".
-                    performCloseButtonActionWithoutDeniedCheck();
+                    closeInfobar(false);
                     return;
                 case ACTION_OVERFLOW_NEVER_SITE:
                     recordInfobarAction(INFOBAR_SNACKBAR_CANCEL_NEVER_SITE);
                     return;
                 default:
                     assert false : "Unsupported Menu Item Id, when handling snackbar action";
                     return;
             }
         }
     };
@@ skipping 22 matching lines @@
         return true;
     }
 
     @Override
     protected void createCompactLayoutContent(InfoBarCompactLayout parent) {
         LinearLayout content =
                 (LinearLayout) LayoutInflater.from(getContext())
                         .inflate(R.layout.infobar_translate_compact_content, parent, false);
 
         mTabLayout = (TranslateTabLayout) content.findViewById(R.id.translate_infobar_tabs);
-        mTabLayout.addOnLayoutChangeListener(this);
         mTabLayout.addTabs(mOptions.sourceLanguageName(), mOptions.targetLanguageName());
 
         // Set translating status in the beginning for pages translated automatically.
         if (mInitialStep == TRANSLATING_INFOBAR) {
             mTabLayout.getTabAt(TARGET_TAB_INDEX).select();
             mTabLayout.showProgressBarOnTab(TARGET_TAB_INDEX);
-            mUserInteracted = true;
         }
 
         mTabLayout.addOnTabSelectedListener(this);
 
+        // Dismiss all menus when there is layout changed. (which will cause menu misplacement.)
+        mTabLayout.addOnLayoutChangeListener(new OnLayoutChangeListener() {
+            @Override
+            public void onLayoutChange(View v, int left, int top, int right, int bottom,
+                    int oldLeft, int oldTop, int oldRight, int oldBottom) {
+                dismissMenus();
+            }
+        });
+
         mMenuButton = (TintedImageButton) content.findViewById(R.id.translate_infobar_menu_button);
         mMenuButton.setOnClickListener(new OnClickListener() {
             @Override
             public void onClick(View v) {
                 recordInfobarAction(INFOBAR_OPTIONS);
                 initMenuHelper(TranslateMenu.MENU_OVERFLOW);
                 mOverflowMenuHelper.show(TranslateMenu.MENU_OVERFLOW);
+                mMenuExpanded = true;
             }
         });
 
         parent.addContent(content, 1.0f);
     }
 
     private void initMenuHelper(int menuType) {
         switch (menuType) {
             case TranslateMenu.MENU_OVERFLOW:
                 if (mOverflowMenuHelper == null) {
@@ skipping 11 matching lines @@
             default:
                 assert false : "Unsupported Menu Item Id";
         }
     }
 
     private void startTranslating(int tabPosition) {
         if (TARGET_TAB_INDEX == tabPosition) {
             // Already on the target tab.
             mTabLayout.showProgressBarOnTab(TARGET_TAB_INDEX);
             onButtonClicked(ActionType.TRANSLATE);
-            mUserInteracted = true;
         } else {
             mTabLayout.getTabAt(TARGET_TAB_INDEX).select();
         }
     }
 
     @CalledByNative
     private void onPageTranslated(int errorType) {
         incrementAndRecordTranslationsPerPageCount();
         if (mTabLayout != null) {
             mTabLayout.hideProgressBar();
@@ skipping 14 matching lines @@
         mNativeTranslateInfoBarPtr = nativePtr;
     }
 
     @CalledByNative
     private void setAutoAlwaysTranslate() {
         createAndShowSnackbar(getContext().getString(R.string.translate_snackbar_always_translate,
                                       mOptions.sourceLanguageName(), mOptions.targetLanguageName()),
                 Snackbar.UMA_TRANSLATE_ALWAYS, ACTION_AUTO_ALWAYS_TRANSLATE);
     }
 
-    private void setAutoNeverTranslate() {
-        createAndShowSnackbar(getContext().getString(R.string.translate_snackbar_language_never,
-                                      mOptions.sourceLanguageName()),
-                Snackbar.UMA_TRANSLATE_NEVER, ACTION_AUTO_NEVER_LANGUAGE);
-    }
-
     @Override
     protected void onNativeDestroyed() {
         mNativeTranslateInfoBarPtr = 0;
         super.onNativeDestroyed();
     }
 
-    @Override
-    public void onCloseButtonClicked() {
-        // If mUserInteracted is false, it is regarded as a translation denied.
-        if (!mUserInteracted) {
-            recordInfobarAction(INFOBAR_DECLINE);
-            // This will increment the denied count.
-            onButtonClicked(ActionType.CANCEL);
-
-            // Check if it should trigger the auto "never translate".
-            if (!mOptions.neverTranslateLanguageState()
-                    && nativeShouldAutoNeverTranslate(mNativeTranslateInfoBarPtr)) {
-                setAutoNeverTranslate();
-                // Postpone the infobar dismiss until the snackbar finished showing.  Otherwise, the
-                // reference to the native infobar is killed and there is no way for the snackbar to
-                // perform the action.
-                return;
-            }
+    private void closeInfobar(boolean explicitly) {
+        // Check if we should trigger the auto "never translate" if infobar is closed explicitly.
+        if (explicitly
+                && nativeShouldAutoNeverTranslate(mNativeTranslateInfoBarPtr, mMenuExpanded)) {
+            createAndShowSnackbar(getContext().getString(R.string.translate_snackbar_language_never,
+                                          mOptions.sourceLanguageName()),
+                    Snackbar.UMA_TRANSLATE_NEVER, ACTION_AUTO_NEVER_LANGUAGE);
+            // Postpone the infobar dismiss until the snackbar finished showing.  Otherwise, the
+            // reference to the native infobar is killed and there is no way for the snackbar to
+            // perform the action.
+            return;
         }
         recordInfobarAction(INFOBAR_CLOSE);
         // This line will dismiss this infobar.
-        performCloseButtonActionWithoutDeniedCheck();
-    }
-
-    private void performCloseButtonActionWithoutDeniedCheck() {
         super.onCloseButtonClicked();
     }
 
     @Override
+    public void onCloseButtonClicked() {
+        closeInfobar(true);
+    }
+
+    @Override
     public void onTabSelected(TabLayout.Tab tab) {
         switch (tab.getPosition()) {
             case SOURCE_TAB_INDEX:
                 incrementAndRecordTranslationsPerPageCount();
                 recordInfobarAction(INFOBAR_REVERT);
                 onButtonClicked(ActionType.TRANSLATE_SHOW_ORIGINAL);
                 return;
             case TARGET_TAB_INDEX:
                 recordInfobarAction(INFOBAR_TRANSLATE);
                 recordInfobarLanguageData(
                         INFOBAR_HISTOGRAM_TRANSLATE_LANGUAGE, mOptions.targetLanguageCode());
                 startTranslating(TARGET_TAB_INDEX);
                 return;
             default:
                 assert false : "Unexpected Tab Index";
         }
     }
 
     @Override
     public void onTabUnselected(TabLayout.Tab tab) {}
 
     @Override
     public void onTabReselected(TabLayout.Tab tab) {}
 
     @Override
     public void onOverflowMenuItemClicked(int itemId) {
-        mUserInteracted = true;
         switch (itemId) {
             case TranslateMenu.ID_OVERFLOW_MORE_LANGUAGE:
                 recordInfobarAction(INFOBAR_MORE_LANGUAGES);
                 initMenuHelper(TranslateMenu.MENU_TARGET_LANGUAGE);
                 mLanguageMenuHelper.show(TranslateMenu.MENU_TARGET_LANGUAGE);
                 return;
             case TranslateMenu.ID_OVERFLOW_ALWAYS_TRANSLATE:
                 // Only show snackbar when "Always Translate" is enabled.
                 if (!mOptions.alwaysTranslateLanguageState()) {
                     recordInfobarAction(INFOBAR_ALWAYS_TRANSLATE);
@@ skipping 54 matching lines @@
             recordInfobarLanguageData(
                     INFOBAR_HISTOGRAM_PAGE_NOT_IN_LANGUAGE, mOptions.sourceLanguageCode());
             nativeApplyStringTranslateOption(
                     mNativeTranslateInfoBarPtr, TranslateOption.SOURCE_CODE, code);
             // Adjust UI.
             mTabLayout.replaceTabTitle(SOURCE_TAB_INDEX, mOptions.getRepresentationFromCode(code));
             startTranslating(mTabLayout.getSelectedTabPosition());
         }
     }
 
-    @Override
-    public void onLayoutChange(View v, int left, int top, int right, int bottom, int oldLeft,
-            int oldTop, int oldRight, int oldBottom) {
-        // Dismiss all menus when there is layout changed. (which will cause menu misplacement.)
-        dismissMenus();
-    }
-
     // Dismiss all overflow menus that remains open.
     // This is called when infobar started hiding or layout changed.
     private void dismissMenus() {
         if (mOverflowMenuHelper != null) mOverflowMenuHelper.dismiss();
         if (mLanguageMenuHelper != null) mLanguageMenuHelper.dismiss();
     }
 
     @Override
     protected void onStartedHiding() {
         dismissMenus();
@@ skipping 85 matching lines @@
 
     private void incrementAndRecordTranslationsPerPageCount() {
         RecordHistogram.recordCountHistogram(
                 INFOBAR_HISTOGRAM_TRANSLATION_COUNT, ++mTotalTranslationCount);
     }
 
     private native void nativeApplyStringTranslateOption(
             long nativeTranslateCompactInfoBar, int option, String value);
     private native void nativeApplyBoolTranslateOption(
             long nativeTranslateCompactInfoBar, int option, boolean value);
-    private native boolean nativeShouldAutoNeverTranslate(long nativeTranslateCompactInfoBar);
+    private native boolean nativeShouldAutoNeverTranslate(
+            long nativeTranslateCompactInfoBar, boolean menuExpanded);
 }