From 18b1d3bde4b2437cdeeacd3544274a8f8e80ed81 Mon Sep 17 00:00:00 2001
From: Joanne Chung <joannechung@google.com>
Date: Wed, 14 Apr 2021 23:24:42 +0800
Subject: Refine the ViewTranslationCallback usage.

Currently, TextView uses its default implementation even developers
uses setViewTranslationCallback() to set their customized
ViewTranslationCallback, we should only set default TextView
implementation if developers don't set it.

The onViewTranslationResponse() will call getViewTranslationCallback
instead of getting TextView default implementation directly. This can
make sure we can get the expected ViewTranslationCallback.

Bug: 183467275
Test: manual
Test: atest CtsTranslationTestCases

Change-Id: I41417140f8985aec6c80f1bca3cfba804727d5df
---
 core/java/android/view/View.java | 40 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)

(limited to 'core/java/android/view/View.java')

diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java
index acc0fc178d6e..6b5d585cc44c 100644
--- a/core/java/android/view/View.java
+++ b/core/java/android/view/View.java
@@ -3514,6 +3514,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
      *                     11           PFLAG4_SCROLL_CAPTURE_HINT_MASK
      *                    1             PFLAG4_ALLOW_CLICK_WHEN_DISABLED
      *                   1              PFLAG4_DETACHED
+     *                  1               PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE
      * |-------|-------|-------|-------|
      */
 
@@ -3580,6 +3581,11 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
      */
     private static final int PFLAG4_DETACHED = 0x000002000;
 
+    /**
+     * Indicates that the view has transient state because the system is translating it.
+     */
+    private static final int PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE = 0x000004000;
+
     /* End of masks for mPrivateFlags4 */
 
     /** @hide */
@@ -12265,6 +12271,30 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
         }
     }
 
+    /**
+     * Set the view is tracking translation transient state. This flag is used to check if the view
+     * need to call setHasTransientState(false) to reset transient state that set when starting
+     * translation.
+     *
+     * @param hasTranslationTransientState true if this view has translation transient state
+     * @hide
+     */
+    public void setHasTranslationTransientState(boolean hasTranslationTransientState) {
+        if (hasTranslationTransientState) {
+            mPrivateFlags4 |= PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE;
+        } else {
+            mPrivateFlags4 &= ~PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE;
+        }
+    }
+
+    /**
+     * @hide
+     */
+    public boolean hasTranslationTransientState() {
+        return (mPrivateFlags4 & PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE)
+                == PFLAG4_HAS_TRANSLATION_TRANSIENT_STATE;
+    }
+
     /**
      * Returns true if this view is currently attached to a window.
      */
@@ -30834,6 +30864,9 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
     }
 
     /**
+     * Returns a {@link ViewTranslationCallback} that is used to display the translated information
+     * or {@code null} if this View doesn't support translation.
+     *
      * @hide
      */
     @Nullable
@@ -30920,7 +30953,8 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
      * view or calls {@link View#onVirtualViewTranslationResponses} for view contains virtual
      * children to build {@link ViewTranslationRequest} if the view should be translated.
      * The view is marked as having {@link #setHasTransientState(boolean) transient state} so that
-     * recycling of views doesn't prevent the system from attaching the response to it.</p>
+     * recycling of views doesn't prevent the system from attaching the response to it. Therefore,
+     * if overriding this method, you should set or reset the transient state. </p>
      *
      * @param viewIds a map for the view's {@link AutofillId} and its virtual child ids or
      * {@code null} if the view doesn't have virtual child that should be translated. The virtual
@@ -30970,10 +31004,8 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
                     Log.v(CONTENT_CAPTURE_LOG_TAG, "Calling setHasTransientState(true) for "
                             + getAutofillId());
                 }
-                // TODO: Add a default ViewTranslationCallback for View that resets this in
-                // onClearTranslation(). Also update the javadoc for this method to mention
-                // that.
                 setHasTransientState(true);
+                setHasTranslationTransientState(true);
             }
         }
     }
-- 
cgit v1.2.3