[Searchbar] Add textCentered attribute

PiperOrigin-RevId: 733486317

Author: imhappi

catalog/java/io/material/catalog/search/res/layout/cat_search_appbar_icons_fragment.xml

@@ -50,8 +50,9 @@
         android:layout_marginVertical="4dp"
         android:layout_gravity="center_vertical"
         app:defaultMarginsEnabled="false"
+        app:textCentered="true"
         app:hideNavigationIcon="true"
-        android:hint="@string/cat_searchbar_hint"/>
+        android:hint="@string/cat_searchbar_short_hint"/>
       <ImageView
         android:layout_width="48dp"
         android:layout_height="48dp"
@@ -83,7 +84,7 @@
     android:id="@+id/cat_search_view"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
-    android:hint="@string/cat_searchbar_hint"
+    android:hint="@string/cat_searchbar_short_hint"
     app:layout_anchor="@id/cat_search_bar">
 
     <!-- Content goes here (ScrollView, RecyclerView, etc.). -->

catalog/java/io/material/catalog/search/res/values/strings.xml

@@ -92,5 +92,6 @@
           description="Description about a home icon button.[CHAR_LIMIT=NONE]">Home</string>
   <string name="cat_searchbar_cast_icon_description"
           description="Description about a cast icon button.[CHAR_LIMIT=NONE]">Cast</string>
-
+  <string name="cat_searchbar_short_hint"
+      description="Search bar short hint text to open search view [CHAR_LIMIT=40]">Search product</string>
 </resources>

docs/components/Search.md

@@ -105,6 +105,7 @@ Element                      | Attribute                   | Related method(s)
 **Search text appearance**   | `android:textAppearance`    | `setTextAppearance`<br/>`getTextAppearance` | `@style/TextAppearance.Material3.SearchBar`
 **Search text**              | `android:text`              | `setText`<br/>`getText`                     | `null`
 **Search hint**              | `android:hint`              | `setHint`<br/>`getHint`                     | `null`
+**Search text centered**     | `app:textCentered`          | `setTextCentered`<br/>`getTextCentered`     | `false`
 **Color**                    | `app:backgroundTint`        | --                                          | `?attr/colorSurfaceContainerHigh`
 **Flag for default margins** | `app:defaultMarginsEnabled` | --                                          | `true`
 **Flag for navigation icon** | `app:hideNavigationIcon`    | --                                          | `false`

lib/java/com/google/android/material/search/SearchBar.java

@@ -20,6 +20,7 @@
 
 import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP;
 import static com.google.android.material.theme.overlay.MaterialThemeOverlay.wrap;
+import static java.lang.Math.max;
 
 import android.animation.AnimatorListenerAdapter;
 import android.content.Context;
@@ -40,6 +41,7 @@
 import androidx.appcompat.widget.Toolbar;
 import android.text.TextUtils;
 import android.util.AttributeSet;
+import android.view.Gravity;
 import android.view.LayoutInflater;
 import android.view.Menu;
 import android.view.View;
@@ -138,12 +140,15 @@ public class SearchBar extends Toolbar {
   private final Drawable defaultNavigationIcon;
   private final boolean tintNavigationIcon;
   private final boolean forceDefaultNavigationOnClickListener;
+  private final int minimumTextMarginStart;
+  private int currentTextMarginStart;
   @Nullable private View centerView;
   @Nullable private Integer navigationIconTint;
   @Nullable private Drawable originalNavigationIconBackground;
   private int menuResId = -1;
   private boolean defaultScrollFlagsEnabled;
   private MaterialShapeDrawable backgroundShape;
+  private boolean textCentered;
 
   public SearchBar(@NonNull Context context) {
     this(context, null);
@@ -159,6 +164,9 @@ public SearchBar(@NonNull Context context, @Nullable AttributeSet attrs, int def
     context = getContext();
     validateAttributes(attrs);
 
+    minimumTextMarginStart =
+        getResources()
+            .getDimensionPixelSize(R.dimen.m3_searchbar_text_margin_start_no_navigation_icon);
     defaultNavigationIcon =
         AppCompatResources.getDrawable(context, getDefaultNavigationIconResource());
     searchBarAnimationHelper = new SearchBarAnimationHelper();
@@ -185,6 +193,7 @@ public SearchBar(@NonNull Context context, @Nullable AttributeSet attrs, int def
     String hint = a.getString(R.styleable.SearchBar_android_hint);
     float strokeWidth = a.getDimension(R.styleable.SearchBar_strokeWidth, -1);
     int strokeColor = a.getColor(R.styleable.SearchBar_strokeColor, Color.TRANSPARENT);
+    textCentered = a.getBoolean(R.styleable.SearchBar_textCentered, false);
 
     a.recycle();
 
@@ -234,10 +243,7 @@ private void initTextView(@StyleRes int textAppearanceResId, String text, String
     }
     setText(text);
     setHint(hint);
-    if (getNavigationIcon() == null) {
-      ((MarginLayoutParams) textView.getLayoutParams()).setMarginStart(getResources()
-          .getDimensionPixelSize(R.dimen.m3_searchbar_text_margin_start_no_navigation_icon));
-    }
+    setTextCentered(textCentered);
   }
 
   private void initBackground(
@@ -388,6 +394,36 @@ protected void onLayout(boolean changed, int left, int top, int right, int botto
 
     layoutCenterView();
     setHandwritingBoundsInsets();
+    // If after laying out, there's not enough space between the textview and the start of
+    // the searchbar, we add a margin.
+    if (textView != null) {
+      Toolbar.LayoutParams lp = (LayoutParams) textView.getLayoutParams();
+      int currentMargin = lp.getMarginStart();
+      int newMargin = getNewMargin(currentMargin);
+      if (currentMargin != newMargin) {
+        lp.setMarginStart(newMargin);
+        currentTextMarginStart = newMargin;
+        textView.setLayoutParams(lp);
+      }
+    }
+  }
+
+  private int getNewMargin(int currentMargin) {
+    // The start position of the textview with respect to its parent, the searchbar.
+    int textViewStart =
+        getLayoutDirection() == LAYOUT_DIRECTION_RTL
+            ? getMeasuredWidth() - textView.getRight()
+            : textView.getLeft();
+    int additionalMarginStart = max(minimumTextMarginStart - textViewStart, 0);
+    // If we are already including the margin in the textview start, and it is necessary to be added
+    // (ie. keeping the desired distance between the textview and the start), we should keep
+    // the margin.
+    if (currentTextMarginStart != 0
+        && currentMargin == currentTextMarginStart
+        && (textViewStart - currentMargin) < minimumTextMarginStart) {
+      additionalMarginStart = currentMargin;
+    }
+    return additionalMarginStart;
   }
 
   @Override
@@ -564,6 +600,26 @@ public void setText(@StringRes int textResId) {
     textView.setText(textResId);
   }
 
+  /** Whether or not to center the text. */
+  public void setTextCentered(boolean textCentered) {
+    this.textCentered = textCentered;
+    if (textView == null) {
+      return;
+    }
+    Toolbar.LayoutParams lp = (LayoutParams) textView.getLayoutParams();
+    if (textCentered) {
+      lp.gravity = Gravity.CENTER_HORIZONTAL;
+    } else {
+      lp.gravity = Gravity.NO_GRAVITY;
+    }
+    textView.setLayoutParams(lp);
+  }
+
+  /** Whether or not the text is centered. */
+  public boolean getTextCentered() {
+    return textCentered;
+  }
+
   /** Clears the text of main {@link TextView}. */
   public void clearText() {
     textView.setText("");

lib/java/com/google/android/material/search/res-public/values/public.xml

@@ -27,6 +27,7 @@
   <public name="hideNavigationIcon" type="attr"/>
   <public name="forceDefaultNavigationOnClickListener" type="attr"/>
   <public name="tintNavigationIcon" type="attr"/>
+  <public name="textCentered" type="attr"/>
   <public name="Widget.Material3.SearchBar" type="style"/>
   <public name="Widget.Material3.SearchBar.Outlined" type="style"/>
   <public name="Widget.Material3.SearchView" type="style"/>

lib/java/com/google/android/material/search/res/values/attrs.xml

@@ -64,6 +64,9 @@
     <attr name="strokeColor"/>
     <!-- Width of the SearchBar outline stroke. -->
     <attr name="strokeWidth"/>
+    <!-- Whether the text corresponding to the `android:text` attribute or `android:hint` attribute
+         should be centered horizontally within the searchbar. Default is false.-->
+    <attr name="textCentered" format="boolean"/>
   </declare-styleable>
 
   <declare-styleable name="SearchView">