[Internal] Restore binary compatibility (ViewOverlay)

Author: pubiqq

lib/java/com/google/android/material/internal/ViewOverlayImpl.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2016 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.material.internal;
+
+import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP;
+
+import android.graphics.drawable.Drawable;
+import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
+
+/**
+ * Backward-compatible implementation of {@link android.view.ViewOverlay} for API < 18.
+ * TODO(b/144937975): Remove and use the official version from androidx when it's available.
+ *
+ * @deprecated Use {@link android.view.ViewOverlay} instead.
+ * @hide
+ */
+@Deprecated
+@RestrictTo(LIBRARY_GROUP)
+public interface ViewOverlayImpl {
+
+  /**
+   * Adds a Drawable to the overlay. The bounds of the drawable should be relative to the host view.
+   * Any drawable added to the overlay should be removed when it is no longer needed or no longer
+   * visible.
+   *
+   * @param drawable The Drawable to be added to the overlay. This drawable will be drawn when the
+   *     view redraws its overlay.
+   * @see #remove(Drawable)
+   */
+  void add(@NonNull Drawable drawable);
+
+  /**
+   * Removes the specified Drawable from the overlay.
+   *
+   * @param drawable The Drawable to be removed from the overlay.
+   * @see #add(Drawable)
+   */
+  void remove(@NonNull Drawable drawable);
+}

lib/java/com/google/android/material/internal/ViewUtils.java

@@ -27,12 +27,12 @@
 import android.content.res.TypedArray;
 import android.graphics.PorterDuff;
 import android.graphics.Rect;
+import android.graphics.drawable.Drawable;
 import android.util.AttributeSet;
 import android.util.TypedValue;
 import android.view.View;
 import android.view.View.OnAttachStateChangeListener;
 import android.view.ViewGroup;
-import android.view.ViewOverlay;
 import android.view.ViewParent;
 import android.view.ViewTreeObserver;
 import android.view.ViewTreeObserver.OnGlobalLayoutListener;
@@ -361,6 +361,32 @@ public static float getParentAbsoluteElevation(@NonNull View view) {
     return absoluteElevation;
   }
 
+  /**
+   * Backward-compatible {@link View#getOverlay()} for API < 18.
+   * TODO(b/144937975): Remove and use the official version from androidx when it's available.
+   *
+   * @deprecated Use {@link View#getOverlay()} instead.
+   */
+  @Deprecated
+  @Nullable
+  public static ViewOverlayImpl getOverlay(@Nullable View view) {
+    if (view == null) {
+      return null;
+    }
+
+    return new ViewOverlayImpl() {
+      @Override
+      public void add(@NonNull Drawable drawable) {
+        view.getOverlay().add(drawable);
+      }
+
+      @Override
+      public void remove(@NonNull Drawable drawable) {
+        view.getOverlay().remove(drawable);
+      }
+    };
+  }
+
   /** Returns the content view that is the parent of the provided view. */
   @Nullable
   public static ViewGroup getContentView(@Nullable View view) {
@@ -387,11 +413,14 @@ public static ViewGroup getContentView(@Nullable View view) {
 
   /**
    * Returns the content view overlay that can be used to add drawables on top of all other views.
+   *
+   * @deprecated Use {@link View#getOverlay()} on the result of {@link
+   *     ViewUtils#getContentView(View)} instead.
    */
+  @Deprecated
   @Nullable
-  public static ViewOverlay getContentViewOverlay(@NonNull View view) {
-    ViewGroup contentView = getContentView(view);
-    return contentView != null ? contentView.getOverlay() : null;
+  public static ViewOverlayImpl getContentViewOverlay(@NonNull View view) {
+    return getOverlay(getContentView(view));
   }
 
   public static void addOnGlobalLayoutListener(

lib/java/com/google/android/material/slider/BaseSlider.java

@@ -2408,7 +2408,7 @@ protected void onVisibilityChanged(@NonNull View changedView, int visibility) {
     // When the visibility is set to VISIBLE, onDraw() is called again which adds or removes labels
     // according to the setting.
     if (visibility != VISIBLE) {
-      ViewOverlay contentViewOverlay = ViewUtils.getContentViewOverlay(this);
+      final ViewOverlay contentViewOverlay = getContentViewOverlay();
       if (contentViewOverlay == null) {
         return;
       }
@@ -2418,6 +2418,16 @@ protected void onVisibilityChanged(@NonNull View changedView, int visibility) {
     }
   }
 
+  @Nullable
+  private ViewOverlay getContentViewOverlay() {
+    final View contentView = ViewUtils.getContentView(this);
+    if (contentView == null) {
+      return null;
+    }
+
+    return contentView.getOverlay();
+  }
+
   @Override
   public void setEnabled(boolean enabled) {
     super.setEnabled(enabled);
@@ -2493,11 +2503,13 @@ protected void onDetachedFromWindow() {
   }
 
   private void detachLabelFromContentView(TooltipDrawable label) {
-    ViewOverlay contentViewOverlay = ViewUtils.getContentViewOverlay(this);
-    if (contentViewOverlay != null) {
-      contentViewOverlay.remove(label);
-      label.detachView(ViewUtils.getContentView(this));
+    final View contentView = ViewUtils.getContentView(this);
+    if (contentView == null) {
+      return;
     }
+
+    contentView.getOverlay().remove(label);
+    label.detachView(contentView);
   }
 
   @Override
@@ -3550,7 +3562,11 @@ private void ensureLabelsRemoved() {
             @Override
             public void onAnimationEnd(Animator animation) {
               super.onAnimationEnd(animation);
-              ViewOverlay contentViewOverlay = ViewUtils.getContentViewOverlay(BaseSlider.this);
+              final ViewOverlay contentViewOverlay = getContentViewOverlay();
+              if (contentViewOverlay == null) {
+                return;
+              }
+
               for (TooltipDrawable label : labels) {
                 contentViewOverlay.remove(label);
               }
@@ -3603,7 +3619,12 @@ private String formatValue(float value) {
   private void setValueForLabel(TooltipDrawable label, float value) {
     label.setText(formatValue(value));
     positionLabel(label, value);
-    ViewUtils.getContentViewOverlay(this).add(label);
+    final ViewOverlay contentViewOverlay = getContentViewOverlay();
+    if (contentViewOverlay == null) {
+      return;
+    }
+
+    contentViewOverlay.add(label);
   }
 
   private void positionLabel(TooltipDrawable label, float value) {