[CollapsingToolbarLayout] Added title line spacing and hyphenation frequency setters

PiperOrigin-RevId: 371920600

Author: dsn5ft

lib/java/com/google/android/material/appbar/CollapsingToolbarLayout.java

@@ -47,6 +47,7 @@
 import android.widget.FrameLayout;
 import androidx.annotation.ColorInt;
 import androidx.annotation.DrawableRes;
+import androidx.annotation.FloatRange;
 import androidx.annotation.IntDef;
 import androidx.annotation.IntRange;
 import androidx.annotation.NonNull;
@@ -1239,6 +1240,57 @@ public int getLineCount() {
     return collapsingTextHelper.getLineCount();
   }
 
+  /**
+   * Sets the line spacing addition of the title text. See {@link
+   * android.widget.TextView#setLineSpacing(float, float)}. Experimental Feature.
+   */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public void setLineSpacingAdd(float spacingAdd) {
+    collapsingTextHelper.setLineSpacingAdd(spacingAdd);
+  }
+
+  /** Gets the line spacing addition of the title text, or -1 if not set. Experimental Feature. */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public float getLineSpacingAdd() {
+    return collapsingTextHelper.getLineSpacingAdd();
+  }
+
+  /**
+   * Sets the line spacing multiplier of the title text. See {@link
+   * android.widget.TextView#setLineSpacing(float, float)}. Experimental Feature.
+   */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public void setLineSpacingMultiplier(@FloatRange(from = 0.0) float spacingMultiplier) {
+    collapsingTextHelper.setLineSpacingMultiplier(spacingMultiplier);
+  }
+
+  /** Gets the line spacing multiplier of the title text, or -1 if not set. Experimental Feature. */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public float getLineSpacingMultiplier() {
+    return collapsingTextHelper.getLineSpacingMultiplier();
+  }
+
+  /**
+   * Sets the hyphenation frequency of the title text. See {@link
+   * android.widget.TextView#setHyphenationFrequency(int)}. Experimental Feature.
+   */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public void setHyphenationFrequency(int hyphenationFrequency) {
+    collapsingTextHelper.setHyphenationFrequency(hyphenationFrequency);
+  }
+
+  /** Gets the hyphenation frequency of the title text, or -1 if not set. Experimental Feature. */
+  @RestrictTo(LIBRARY_GROUP)
+  @RequiresApi(VERSION_CODES.M)
+  public int getHyphenationFrequency() {
+    return collapsingTextHelper.getHyphenationFrequency();
+  }
+
   /**
    * Set the amount of visible height in pixels used to define when to trigger a scrim visibility
    * change.

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

@@ -46,6 +46,7 @@
 import androidx.annotation.FloatRange;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
 import androidx.annotation.RestrictTo;
 import androidx.core.math.MathUtils;
 import androidx.core.text.TextDirectionHeuristicsCompat;
@@ -153,6 +154,9 @@ public final class CollapsingTextHelper {
   private float expandedFirstLineDrawX;
   private CharSequence textToDrawCollapsed;
   private int maxLines = 1;
+  private float lineSpacingAdd = StaticLayoutBuilderCompat.DEFAULT_LINE_SPACING_ADD;
+  private float lineSpacingMultiplier = StaticLayoutBuilderCompat.DEFAULT_LINE_SPACING_MULTIPLIER;
+  private int hyphenationFrequency = StaticLayoutBuilderCompat.DEFAULT_HYPHENATION_FREQUENCY;
 
   public CollapsingTextHelper(View view) {
     this.view = view;
@@ -944,6 +948,8 @@ private StaticLayout createStaticLayout(int maxLines, float availableWidth, bool
               .setAlignment(ALIGN_NORMAL)
               .setIncludePad(false)
               .setMaxLines(maxLines)
+              .setLineSpacing(lineSpacingAdd, lineSpacingMultiplier)
+              .setHyphenationFrequency(hyphenationFrequency)
               .build();
     } catch (StaticLayoutBuilderCompatException e) {
       Log.e(TAG, e.getCause().getMessage(), e);
@@ -1026,6 +1032,36 @@ public int getLineCount() {
     return textLayout != null ? textLayout.getLineCount() : 0;
   }
 
+  @RequiresApi(VERSION_CODES.M)
+  public void setLineSpacingAdd(float spacingAdd) {
+    this.lineSpacingAdd = spacingAdd;
+  }
+
+  @RequiresApi(VERSION_CODES.M)
+  public float getLineSpacingAdd() {
+    return textLayout.getSpacingAdd();
+  }
+
+  @RequiresApi(VERSION_CODES.M)
+  public void setLineSpacingMultiplier(@FloatRange(from = 0.0) float spacingMultiplier) {
+    this.lineSpacingMultiplier = spacingMultiplier;
+  }
+
+  @RequiresApi(VERSION_CODES.M)
+  public float getLineSpacingMultiplier() {
+    return textLayout.getSpacingMultiplier();
+  }
+
+  @RequiresApi(VERSION_CODES.M)
+  public void setHyphenationFrequency(int hyphenationFrequency) {
+    this.hyphenationFrequency = hyphenationFrequency;
+  }
+
+  @RequiresApi(VERSION_CODES.M)
+  public int getHyphenationFrequency() {
+    return hyphenationFrequency;
+  }
+
   /**
    * Returns true if {@code value} is 'close' to it's closest decimal value. Close is currently
    * defined as it's difference being < 0.001.

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

@@ -19,6 +19,7 @@
 import static androidx.core.util.Preconditions.checkNotNull;
 
 import android.os.Build;
+import android.os.Build.VERSION;
 import android.os.Build.VERSION_CODES;
 import android.text.Layout;
 import android.text.Layout.Alignment;
@@ -52,6 +53,13 @@
 @RestrictTo(Scope.LIBRARY_GROUP)
 final class StaticLayoutBuilderCompat {
 
+  static final int DEFAULT_HYPHENATION_FREQUENCY =
+      VERSION.SDK_INT >= VERSION_CODES.M ? StaticLayout.HYPHENATION_FREQUENCY_NORMAL : 0;
+
+  // Default line spacing values to match android.text.Layout constants.
+  static final float DEFAULT_LINE_SPACING_ADD = 0.0f;
+  static final float DEFAULT_LINE_SPACING_MULTIPLIER = 1.0f;
+
   private static final String TEXT_DIR_CLASS = "android.text.TextDirectionHeuristic";
   private static final String TEXT_DIRS_CLASS = "android.text.TextDirectionHeuristics";
   private static final String TEXT_DIR_CLASS_LTR = "LTR";
@@ -70,6 +78,9 @@ final class StaticLayoutBuilderCompat {
 
   private Alignment alignment;
   private int maxLines;
+  private float lineSpacingAdd;
+  private float lineSpacingMultiplier;
+  private int hyphenationFrequency;
   private boolean includePad;
   private boolean isRtl;
   @Nullable private TextUtils.TruncateAt ellipsize;
@@ -82,6 +93,9 @@ private StaticLayoutBuilderCompat(CharSequence source, TextPaint paint, int widt
     this.end = source.length();
     this.alignment = Alignment.ALIGN_NORMAL;
     this.maxLines = Integer.MAX_VALUE;
+    this.lineSpacingAdd = DEFAULT_LINE_SPACING_ADD;
+    this.lineSpacingMultiplier = DEFAULT_LINE_SPACING_MULTIPLIER;
+    this.hyphenationFrequency = DEFAULT_HYPHENATION_FREQUENCY;
     this.includePad = true;
     this.ellipsize = null;
   }
@@ -163,6 +177,34 @@ public StaticLayoutBuilderCompat setMaxLines(@IntRange(from = 0) int maxLines) {
     return this;
   }
 
+  /**
+   * Set the line spacing addition and multiplier frequency. Only available on API level 23+.
+   *
+   * @param spacingAdd Line spacing addition for the resulting {@link StaticLayout}
+   * @param lineSpacingMultiplier Line spacing multiplier for the resulting {@link StaticLayout}
+   * @return this builder, useful for chaining
+   * @see android.widget.TextView#setLineSpacing(float, float)
+   */
+  @NonNull
+  public StaticLayoutBuilderCompat setLineSpacing(float spacingAdd, float lineSpacingMultiplier) {
+    this.lineSpacingAdd = spacingAdd;
+    this.lineSpacingMultiplier = lineSpacingMultiplier;
+    return this;
+  }
+
+  /**
+   * Set the hyphenation frequency. Only available on API level 23+.
+   *
+   * @param hyphenationFrequency Hyphenation frequency for the resulting {@link StaticLayout}
+   * @return this builder, useful for chaining
+   * @see android.widget.TextView#setHyphenationFrequency(int)
+   */
+  @NonNull
+  public StaticLayoutBuilderCompat setHyphenationFrequency(int hyphenationFrequency) {
+    this.hyphenationFrequency = hyphenationFrequency;
+    return this;
+  }
+
   /**
    * Set ellipsizing on the layout. Causes words that are longer than the view is wide, or exceeding
    * the number of lines (see #setMaxLines).
@@ -210,8 +252,12 @@ public StaticLayout build() throws StaticLayoutBuilderCompatException {
         builder.setEllipsize(ellipsize);
       }
       builder.setMaxLines(maxLines);
+      if (lineSpacingAdd != DEFAULT_LINE_SPACING_ADD
+          || lineSpacingMultiplier != DEFAULT_LINE_SPACING_MULTIPLIER) {
+        builder.setLineSpacing(lineSpacingAdd, lineSpacingMultiplier);
+      }
       if (maxLines > 1) {
-        builder.setHyphenationFrequency(StaticLayout.HYPHENATION_FREQUENCY_NORMAL);
+        builder.setHyphenationFrequency(hyphenationFrequency);
       }
       return builder.build();
     }