commit 728cd1f19fdcb7c80d77fb05720746878af99b40
author Gabriel Peal <gabriel@tonal.com> Sat Apr 17 20:03:03 2021 -0700
committer Gabriel Peal <gabriel@tonal.com> Sat Apr 17 20:03:03 2021 -0700
tree c8fabf2e0273a641533d8726321c22e3db75cf2b
parent e8edca26669f7a861ef785bcbc90b4591f45f6a0

Made TextDelegate.getText public and updates its docs

lottie/src/main/java/com/airbnb/lottie/TextDelegate.java

diff --git a/lottie/src/main/java/com/airbnb/lottie/TextDelegate.java b/lottie/src/main/java/com/airbnb/lottie/TextDelegate.java
index f352c0a..1ae5a6c 100644
--- a/lottie/src/main/java/com/airbnb/lottie/TextDelegate.java
+++ b/lottie/src/main/java/com/airbnb/lottie/TextDelegate.java
@@ -1,16 +1,18 @@
 package com.airbnb.lottie;
 
 import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
 import androidx.annotation.VisibleForTesting;
 
 import java.util.HashMap;
 import java.util.Map;
 
 /**
- * Extend this class to replace animation text with custom text. This can be useful to handle
- * translations.
+ * To replace static text in an animation at runtime, create an instance of this class and call {@link #setText(String, String)} to
+ * replace the hard coded animation text (input) with the text of your choosing (output).
  * <p>
- * The only method you should have to override is {@link #getText(String)}.
+ * Alternatively, extend this class and override {@link #getText(String)} and if the text hasn't already been set
+ * by {@link #setText(String, String)} then it will call {@link #getText(String)}.
  */
 public class TextDelegate {
 
@@ -43,7 +45,7 @@
    * Override this to replace the animation text with something dynamic. This can be used for
    * translations or custom data.
    */
-  private String getText(String input) {
+  public String getText(String input) {
     return input;
   }
 
@@ -72,13 +74,14 @@
   }
 
   /**
-   * Invalidates all cached strings
+   * Invalidates all cached strings.
    */
   public void invalidateAllText() {
     stringMap.clear();
     invalidate();
   }
 
+  @RestrictTo(RestrictTo.Scope.LIBRARY)
   public final String getTextInternal(String input) {
     if (cacheText && stringMap.containsKey(input)) {
       return stringMap.get(input);

sample/src/androidTest/java/com/airbnb/lottie/samples/LottieTest.kt

diff --git a/sample/src/androidTest/java/com/airbnb/lottie/samples/LottieTest.kt b/sample/src/androidTest/java/com/airbnb/lottie/samples/LottieTest.kt
index 1fd3424..9d1b1b3 100644
--- a/sample/src/androidTest/java/com/airbnb/lottie/samples/LottieTest.kt
+++ b/sample/src/androidTest/java/com/airbnb/lottie/samples/LottieTest.kt
@@ -860,6 +860,18 @@
             textDelegate.setText("NAME", "Hello World")
         }
 
+        withAnimationView("Tests/DynamicText.json", "Dynamic Text", "Hello World with getText") { animationView ->
+            val textDelegate = object : TextDelegate(animationView) {
+                override fun getText(input: String): String {
+                    return when (input) {
+                        "NAME" -> "Hello World"
+                        else -> input
+                    }
+                }
+            }
+            animationView.setTextDelegate(textDelegate)
+        }
+
         withAnimationView("Tests/DynamicText.json", "Dynamic Text", "Emoji") { animationView ->
             val textDelegate = TextDelegate(animationView)
             animationView.setTextDelegate(textDelegate)