[CleanUp][TextField] Centralize icon view state handling logic

Note that there are a slight behavior changes - when a new end icon mode is set, the state will always be reset, if applicable. This should be logically more consistent and correct than the current behavior.

PiperOrigin-RevId: 449027939

Author: drchen

lib/java/com/google/android/material/textfield/ClearTextEndIconDelegate.java

@@ -48,8 +48,7 @@ class ClearTextEndIconDelegate extends EndIconDelegate {
     if (text != null) {
       text.clear();
     }
-
-    endLayout.refreshEndIconDrawableState();
+    refreshIconState();
   };
 
   private final OnFocusChangeListener onFocusChangeListener =
@@ -64,7 +63,6 @@ class ClearTextEndIconDelegate extends EndIconDelegate {
 
   @Override
   void setUp() {
-    endLayout.setEndIconCheckable(false);
     initAnimators();
   }
 

lib/java/com/google/android/material/textfield/DropdownMenuEndIconDelegate.java

@@ -63,15 +63,18 @@ class DropdownMenuEndIconDelegate extends EndIconDelegate {
   private final OnClickListener onIconClickListener = view -> showHideDropdown();
 
   private final OnFocusChangeListener onEditTextFocusChangeListener = (view, hasFocus) -> {
-    endLayout.setEndIconActivated(hasFocus);
+    editTextHasFocus = hasFocus;
+    refreshIconState();
     if (!hasFocus) {
       setEndIconChecked(false);
       dropdownPopupDirty = false;
     }
   };
 
-  private boolean dropdownPopupDirty = false;
-  private boolean isEndIconChecked = false;
+  private boolean editTextHasFocus;
+
+  private boolean dropdownPopupDirty;
+  private boolean isEndIconChecked;
   private long dropdownPopupActivatedAt = Long.MAX_VALUE;
   @Nullable private AccessibilityManager accessibilityManager;
   private ValueAnimator fadeOutAnim;
@@ -122,6 +125,26 @@ int getIconContentDescriptionResId() {
     return R.string.exposed_dropdown_menu_content_description;
   }
 
+  @Override
+  boolean isIconCheckable() {
+    return true;
+  }
+
+  @Override
+  boolean isIconChecked() {
+    return isEndIconChecked;
+  }
+
+  @Override
+  boolean isIconActivable() {
+    return true;
+  }
+
+  @Override
+  boolean isIconActivated() {
+    return editTextHasFocus;
+  }
+
   @Override
   boolean shouldTintIconOnError() {
     return true;
@@ -141,7 +164,6 @@ OnClickListener getOnIconClickListener() {
   public void onEditTextAttached(@Nullable EditText editText) {
     this.autoCompleteTextView = castAutoCompleteTextViewOrThrow(editText);
     setUpDropdownShowHideBehavior();
-    textInputLayout.setEndIconCheckable(true);
     textInputLayout.setErrorIconDrawable(null);
     if (!isEditable(editText) && accessibilityManager.isTouchExplorationEnabled()) {
       ViewCompat.setImportantForAccessibility(endIconView, IMPORTANT_FOR_ACCESSIBILITY_NO);
@@ -207,7 +229,7 @@ private void showHideDropdown() {
         setEndIconChecked(!isEndIconChecked);
       } else {
         isEndIconChecked = !isEndIconChecked;
-        endIconView.toggle();
+        refreshIconState();
       }
       if (isEndIconChecked) {
         autoCompleteTextView.requestFocus();
@@ -279,7 +301,7 @@ private void initAnimators() {
         new AnimatorListenerAdapter() {
           @Override
           public void onAnimationEnd(Animator animation) {
-            endIconView.setChecked(isEndIconChecked);
+            refreshIconState();
             fadeInAnim.start();
           }
         });

lib/java/com/google/android/material/textfield/EndCompoundLayout.java

@@ -332,6 +332,7 @@ void setEndIconMode(@EndIconMode int endIconMode) {
     EndIconDelegate delegate = getEndIconDelegate();
     setEndIconDrawable(getIconResId(delegate));
     setEndIconContentDescription(delegate.getIconContentDescriptionResId());
+    setEndIconCheckable(delegate.isIconCheckable());
     if (delegate.isBoxBackgroundModeSupported(textInputLayout.getBoxBackgroundMode())) {
       delegate.setUp();
     } else {
@@ -347,6 +348,29 @@ void setEndIconMode(@EndIconMode int endIconMode) {
       setOnFocusChangeListenersIfNeeded(delegate);
     }
     applyIconTint(textInputLayout, endIconView, endIconTintList, endIconTintMode);
+    refreshIconState(/* force= */ true);
+  }
+
+  void refreshIconState(boolean force) {
+    boolean stateChanged = false;
+    EndIconDelegate delegate = getEndIconDelegate();
+    if (delegate.isIconCheckable()) {
+      boolean wasChecked = endIconView.isChecked();
+      if (wasChecked != delegate.isIconChecked()) {
+        endIconView.setChecked(!wasChecked);
+        stateChanged = true;
+      }
+    }
+    if (delegate.isIconActivable()) {
+      boolean wasActivated = endIconView.isActivated();
+      if (wasActivated != delegate.isIconActivated()) {
+        setEndIconActivated(!wasActivated);
+        stateChanged = true;
+      }
+    }
+    if (force || stateChanged) {
+      refreshEndIconDrawableState();
+    }
   }
 
   private int getIconResId(EndIconDelegate delegate) {

lib/java/com/google/android/material/textfield/EndIconDelegate.java

@@ -70,6 +70,40 @@ int getIconContentDescriptionResId() {
     return 0;
   }
 
+  /**
+   * Returns true if the end icon should be checkable.
+   *
+   * @see TextInputLayout#setEndIconCheckable(boolean)
+   */
+  boolean isIconCheckable() {
+    return false;
+  }
+
+  /**
+   * Returns true if the end icon should be checked. You will need to override
+   * {@link #isIconCheckable()} to make this method work.
+   */
+  boolean isIconChecked() {
+    return false;
+  }
+
+  /**
+   * Returns true if the end icon should be activable.
+   */
+  boolean isIconActivable() {
+    return false;
+  }
+
+  /**
+   * Returns true if the end icon should be activated. You will need to override
+   * {@link #isIconActivable()} to make this method work.
+   *
+   * @see TextInputLayout#setEndIconActivated(boolean)
+   */
+  boolean isIconActivated() {
+    return false;
+  }
+
   /**
    * Whether the end icon should be tinted with the error color when the {@link TextInputLayout} is
    * in error mode.
@@ -147,4 +181,8 @@ void onInitializeAccessibilityNodeInfo(View host, @NonNull AccessibilityNodeInfo
    * accessibility event.
    */
   void onPopulateAccessibilityEvent(View host, @NonNull AccessibilityEvent event) {}
+
+  final void refreshIconState() {
+    endLayout.refreshIconState(/* force= */ false);
+  }
 }

lib/java/com/google/android/material/textfield/PasswordToggleEndIconDelegate.java

@@ -49,8 +49,7 @@ class PasswordToggleEndIconDelegate extends EndIconDelegate {
     if (selection >= 0) {
       editText.setSelection(selection);
     }
-
-    endLayout.refreshEndIconDrawableState();
+    refreshIconState();
   };
 
   PasswordToggleEndIconDelegate(
@@ -63,8 +62,6 @@ class PasswordToggleEndIconDelegate extends EndIconDelegate {
 
   @Override
   void setUp() {
-    endLayout.setEndIconVisible(true);
-    endLayout.setEndIconCheckable(true);
     if (isInputTypePassword(editText)) {
       // By default set the input to be disguised.
       editText.setTransformationMethod(PasswordTransformationMethod.getInstance());
@@ -91,6 +88,17 @@ int getIconContentDescriptionResId() {
     return R.string.password_toggle_content_description;
   }
 
+  @Override
+  boolean isIconCheckable() {
+    return true;
+  }
+
+  @Override
+  boolean isIconChecked() {
+    // Make sure the password toggle state always matches the EditText's transformation method.
+    return !hasPasswordTransformation();
+  }
+
   @Override
   OnClickListener getOnIconClickListener() {
     return onIconClickListener;
@@ -99,14 +107,12 @@ OnClickListener getOnIconClickListener() {
   @Override
   void onEditTextAttached(@Nullable EditText editText) {
     this.editText = editText;
-    endIconView.setChecked(!hasPasswordTransformation());
+    refreshIconState();
   }
 
   @Override
   void beforeEditTextChanged(CharSequence s, int start, int count, int after) {
-    // Make sure the password toggle state always matches the EditText's transformation
-    // method.
-    endIconView.setChecked(!hasPasswordTransformation());
+    refreshIconState();
   }
 
   private boolean hasPasswordTransformation() {