Note: {@link SearchBar} does not support the {@link #setTitle} and {@link #setSubtitle} * methods, or their corresponding xml attributes. Instead, use {@link #setHint} or {@link * #setText}, or their corresponding xml attributes, to provide a text affordance for your {@link * SearchBar}. * *
The example below shows how to use the {@link SearchBar} and {@link SearchView} together: * *
* <androidx.coordinatorlayout.widget.CoordinatorLayout * android:layout_width="match_parent" * android:layout_height="match_parent"> * * <!-- NestedScrollingChild goes here (NestedScrollView, RecyclerView, etc.). --> * <androidx.core.widget.NestedScrollView * android:layout_width="match_parent" * android:layout_height="match_parent" * app:layout_behavior="@string/searchbar_scrolling_view_behavior"> * <!-- Screen content goes here. --> * </androidx.core.widget.NestedScrollView> * * <com.google.android.material.appbar.AppBarLayout * android:layout_width="match_parent" * android:layout_height="wrap_content"> * <com.google.android.material.search.SearchBar * android:id="@+id/search_bar" * android:layout_width="match_parent" * android:layout_height="wrap_content" * android:hint="@string/searchbar_hint" /> * </com.google.android.material.appbar.AppBarLayout> * * <com.google.android.material.search.SearchView * android:layout_width="match_parent" * android:layout_height="match_parent" * android:hint="@string/searchbar_hint" * app:layout_anchor="@id/search_bar"> * <!-- Search suggestions/results go here (ScrollView, RecyclerView, etc.). --> * </com.google.android.material.search.SearchView> * </androidx.coordinatorlayout.widget.CoordinatorLayout> ** *
For more information, see the component * developer guidance and design guidelines. */ public class SearchBar extends Toolbar { private static final int DEF_STYLE_RES = R.style.Widget_Material3_SearchBar; private static final int DEFAULT_SCROLL_FLAGS = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP_MARGINS; private static final String NAMESPACE_APP = "http://schemas.android.com/apk/res-auto"; private final TextView textView; private final TextView placeholderTextView; private final FrameLayout textViewContainer; private final int backgroundColor; private boolean liftOnScroll; @Nullable private final ColorStateList liftOnScrollColor; private final boolean layoutInflated; private final boolean defaultMarginsEnabled; private final SearchBarAnimationHelper searchBarAnimationHelper; private final Drawable defaultNavigationIcon; private final boolean tintNavigationIcon; private final boolean forceDefaultNavigationOnClickListener; @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; private int maxWidth; private final boolean adaptiveMaxWidthEnabled; private final int adaptiveMaxWidthParentBreakpoint; @Nullable private ActionMenuView menuView; @Nullable private ImageButton navIconButton; // The percentage of the available width that the SearchBar should be at after the specified // breakpoint in the measure pass. private static final float ADAPTIVE_MAX_WIDTH_PERCENT_AFTER_BREAKPOINT = 0.5f; private final LiftOnScrollProgressListener liftColorListener = new LiftOnScrollProgressListener() { @Override public void onUpdate(float elevation, int appBarLayoutColor, float progress) { if (liftOnScrollColor != null) { int mixedColor = MaterialColors.layer(backgroundColor, liftOnScrollColor.getDefaultColor(), progress); backgroundShape.setFillColor(ColorStateList.valueOf(mixedColor)); } } }; public SearchBar(@NonNull Context context) { this(context, null); } public SearchBar(@NonNull Context context, @Nullable AttributeSet attrs) { this(context, attrs, R.attr.materialSearchBarStyle); } public SearchBar(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) { super(wrap(context, attrs, defStyleAttr, DEF_STYLE_RES), attrs, defStyleAttr); // Ensure we are using the correctly themed context rather than the context that was passed in. context = getContext(); validateAttributes(attrs); adaptiveMaxWidthParentBreakpoint = getResources().getDimensionPixelSize(R.dimen.m3_searchbar_parent_width_breakpoint); defaultNavigationIcon = AppCompatResources.getDrawable(context, getDefaultNavigationIconResource()); searchBarAnimationHelper = new SearchBarAnimationHelper(); TypedArray a = ThemeEnforcement.obtainStyledAttributes( context, attrs, R.styleable.SearchBar, defStyleAttr, DEF_STYLE_RES); ShapeAppearanceModel shapeAppearanceModel = ShapeAppearanceModel.builder(context, attrs, defStyleAttr, DEF_STYLE_RES).build(); backgroundColor = a.getColor(R.styleable.SearchBar_backgroundTint, 0); liftOnScrollColor = MaterialResources.getColorStateList(context, a, R.styleable.SearchBar_liftOnScrollColor); float elevation = a.getDimension(R.styleable.SearchBar_elevation, 0); defaultMarginsEnabled = a.getBoolean(R.styleable.SearchBar_defaultMarginsEnabled, true); defaultScrollFlagsEnabled = a.getBoolean(R.styleable.SearchBar_defaultScrollFlagsEnabled, true); boolean hideNavigationIcon = a.getBoolean(R.styleable.SearchBar_hideNavigationIcon, false); forceDefaultNavigationOnClickListener = a.getBoolean(R.styleable.SearchBar_forceDefaultNavigationOnClickListener, false); tintNavigationIcon = a.getBoolean(R.styleable.SearchBar_tintNavigationIcon, true); if (a.hasValue(R.styleable.SearchBar_navigationIconTint)) { navigationIconTint = a.getColor(R.styleable.SearchBar_navigationIconTint, -1); } int textAppearanceResId = a.getResourceId(R.styleable.SearchBar_android_textAppearance, -1); String text = a.getString(R.styleable.SearchBar_android_text); 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); liftOnScroll = a.getBoolean(R.styleable.SearchBar_liftOnScroll, false); maxWidth = a.getDimensionPixelSize(R.styleable.SearchBar_android_maxWidth, -1); adaptiveMaxWidthEnabled = a.getBoolean(R.styleable.SearchBar_adaptiveMaxWidthEnabled, false); a.recycle(); if (!hideNavigationIcon) { initNavigationIcon(); } setClickable(true); setFocusable(true); LayoutInflater.from(context).inflate(R.layout.mtrl_search_bar, this); layoutInflated = true; textView = findViewById(R.id.open_search_bar_text_view); placeholderTextView = findViewById(R.id.open_search_bar_placeholder_text_view); textViewContainer = findViewById(R.id.open_search_bar_text_view_container); setElevation(elevation); initTextView(textAppearanceResId, text, hint); initBackground(shapeAppearanceModel, backgroundColor, elevation, strokeWidth, strokeColor); } void setPlaceholderText(String string) { placeholderTextView.setText(string); } private void validateAttributes(@Nullable AttributeSet attributeSet) { if (attributeSet == null) { return; } if (attributeSet.getAttributeValue(NAMESPACE_APP, "title") != null) { throw new UnsupportedOperationException( "SearchBar does not support title. Use hint or text instead."); } if (attributeSet.getAttributeValue(NAMESPACE_APP, "subtitle") != null) { throw new UnsupportedOperationException( "SearchBar does not support subtitle. Use hint or text instead."); } } @Nullable private AppBarLayout getAppBarLayoutParentIfExists() { ViewParent v = getParent(); while (v != null) { if (v instanceof AppBarLayout) { return (AppBarLayout) v; } v = v.getParent(); } return null; } private void initNavigationIcon() { // If no navigation icon, set up the default one; otherwise, re-set it for tinting if needed. setNavigationIcon(getNavigationIcon() == null ? defaultNavigationIcon : getNavigationIcon()); // Make the navigation icon button decorative (not clickable/focusable) by default so that the // overall search bar handles the click. If a navigation icon click listener is set later on, // the button will be made clickable/focusable. setNavigationIconDecorative(true); } private void initTextView(@StyleRes int textAppearanceResId, String text, String hint) { if (textAppearanceResId != -1) { TextViewCompat.setTextAppearance(textView, textAppearanceResId); TextViewCompat.setTextAppearance(placeholderTextView, textAppearanceResId); } setText(text); setHint(hint); setTextCentered(textCentered); } private void initBackground( ShapeAppearanceModel shapeAppearance, @ColorInt int backgroundColor, float elevation, float strokeWidth, @ColorInt int strokeColor) { backgroundShape = new MaterialShapeDrawable(shapeAppearance); backgroundShape.initializeElevationOverlay(getContext()); backgroundShape.setElevation(elevation); if (strokeWidth >= 0) { backgroundShape.setStroke(strokeWidth, strokeColor); } int rippleColor = MaterialColors.getColor(this, androidx.appcompat.R.attr.colorControlHighlight); Drawable background; backgroundShape.setFillColor(ColorStateList.valueOf(backgroundColor)); background = new RippleDrawable(ColorStateList.valueOf(rippleColor), backgroundShape, backgroundShape); setBackground(background); } @Override public void addView(View child, int index, ViewGroup.LayoutParams params) { if (layoutInflated && centerView == null && !(child instanceof ActionMenuView)) { centerView = child; centerView.setAlpha(0); } super.addView(child, index, params); } @Override public void setElevation(float elevation) { super.setElevation(elevation); if (backgroundShape != null) { backgroundShape.setElevation(elevation); } } @Override public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { super.onInitializeAccessibilityNodeInfo(info); info.setClassName(EditText.class.getCanonicalName()); info.setEditable(isEnabled()); CharSequence text = getText(); boolean isTextEmpty = TextUtils.isEmpty(text); if (VERSION.SDK_INT >= VERSION_CODES.O) { info.setHintText(getHint()); info.setShowingHintText(isTextEmpty); } if (isTextEmpty) { text = getHint(); } info.setText(text); } @Override public void setNavigationOnClickListener(OnClickListener listener) { if (forceDefaultNavigationOnClickListener) { // Ignore the listener if forcing of the default navigation icon is enabled. return; } super.setNavigationOnClickListener(listener); setNavigationIconDecorative(listener == null); } @Override public void setNavigationIcon(@Nullable Drawable navigationIcon) { super.setNavigationIcon(maybeTintNavigationIcon(navigationIcon)); } @Nullable private Drawable maybeTintNavigationIcon(@Nullable Drawable navigationIcon) { if (!tintNavigationIcon || navigationIcon == null) { return navigationIcon; } int navigationIconColor; if (navigationIconTint != null) { navigationIconColor = navigationIconTint; } else { // Navigational icons such as the "hamburger", back arrow, etc. are supposed to be emphasized // with colorOnSurface as opposed to colorOnSurfaceVariant. Here we assume any icon that's not // the default search icon is navigational. int navigationIconColorAttr = navigationIcon == defaultNavigationIcon ? R.attr.colorOnSurfaceVariant : R.attr.colorOnSurface; navigationIconColor = MaterialColors.getColor(this, navigationIconColorAttr); } Drawable wrappedNavigationIcon = DrawableCompat.wrap(navigationIcon.mutate()); wrappedNavigationIcon.setTint(navigationIconColor); return wrappedNavigationIcon; } private void setNavigationIconDecorative(boolean decorative) { ImageButton navigationIconButton = ToolbarUtils.getNavigationIconButton(this); if (navigationIconButton == null) { return; } navigationIconButton.setClickable(!decorative); navigationIconButton.setFocusable(!decorative); Drawable navigationIconBackground = navigationIconButton.getBackground(); if (navigationIconBackground != null) { // Save original navigation icon background so we can restore it later if needed. originalNavigationIconBackground = navigationIconBackground; } // Even if the navigation icon is not clickable/focusable, a ripple will still show up when the // parent view (overall search bar) is clicked. So here we set the background to null to avoid // that, and restore the original background when the icon becomes clickable. navigationIconButton.setBackgroundDrawable( decorative ? null : originalNavigationIconBackground); setHandwritingBoundsInsets(); } @Override public void inflateMenu(@MenuRes int resId) { super.inflateMenu(resId); this.menuResId = resId; } @Override protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { int availableWidth = MeasureSpec.getSize(widthMeasureSpec); int measureMode = MeasureSpec.getMode(widthMeasureSpec); if (maxWidth >= 0 && availableWidth > maxWidth) { widthMeasureSpec = MeasureSpec.makeMeasureSpec(maxWidth, measureMode); } else if (adaptiveMaxWidthEnabled && availableWidth > adaptiveMaxWidthParentBreakpoint) { int newWidth = max( adaptiveMaxWidthParentBreakpoint, Math.round(ADAPTIVE_MAX_WIDTH_PERCENT_AFTER_BREAKPOINT * availableWidth)); widthMeasureSpec = MeasureSpec.makeMeasureSpec(newWidth, measureMode); } super.onMeasure(widthMeasureSpec, heightMeasureSpec); measureCenterView(widthMeasureSpec, heightMeasureSpec); } @Override protected void onLayout(boolean changed, int left, int top, int right, int bottom) { super.onLayout(changed, left, top, right, bottom); if (centerView != null) { layoutViewInCenter(centerView); } setHandwritingBoundsInsets(); if (textView != null) { // If the text is centered, we need to re-layout the textview in the center explicitly instead // of using View gravities because a custom center view in the Toolbar will cause the textview // to be pushed to the side. In this case, we want the textview to be still centered on top of // any center views. if (textCentered) { // Make sure textview does not overlap with any toolbar views (nav icon, menu) or // padding/insets layoutTextViewCenterAvoidToolbarViewsAndPadding(); } } } /** * Sets whether the {@link SearchBar} lifts when a parent {@link AppBarLayout} lifts on scroll. */ public void setLiftOnScroll(boolean liftOnScroll) { this.liftOnScroll = liftOnScroll; if (liftOnScroll) { addLiftOnScrollProgressListener(); } else { removeLiftOnScrollProgressListener(); } } /** * Returns whether or not the {@link SearchBar} lifts when a parent {@link AppBarLayout} lifts * on scroll. */ public boolean isLiftOnScroll() { return liftOnScroll; } private void addLiftOnScrollProgressListener() { AppBarLayout appBarLayout = getAppBarLayoutParentIfExists(); if (appBarLayout != null && liftOnScrollColor != null) { appBarLayout.addLiftOnScrollProgressListener(liftColorListener); } } private void removeLiftOnScrollProgressListener() { AppBarLayout appBarLayout = getAppBarLayoutParentIfExists(); if (appBarLayout != null) { appBarLayout.removeLiftOnScrollProgressListener(liftColorListener); } } @Override protected void onAttachedToWindow() { super.onAttachedToWindow(); MaterialShapeUtils.setParentAbsoluteElevation(this, backgroundShape); setDefaultMargins(); setOrClearDefaultScrollFlags(); if (liftOnScroll) { addLiftOnScrollProgressListener(); } } @Override protected void onDetachedFromWindow() { super.onDetachedFromWindow(); removeLiftOnScrollProgressListener(); } /** * {@link SearchBar} does not support the {@link Toolbar#setTitle} method, or its corresponding * xml attribute. Instead, use {@link #setHint} or {@link #setText}, or their corresponding xml * attributes, to provide a text affordance for your {@link SearchBar}. */ @Override public void setTitle(CharSequence title) { // Don't do anything. SearchBar can't have a title. // Note: we can't throw an exception here because setTitle() is called by setSupportActionBar(). } /** * {@link SearchBar} does not support the {@link Toolbar#setSubtitle} method, or its corresponding * xml attribute. Instead, use {@link #setHint} or {@link #setText}, or their corresponding xml * attributes, to provide a text affordance for your {@link SearchBar}. */ @Override public void setSubtitle(CharSequence subtitle) { // Don't do anything. SearchBar can't have a subtitle. // Note: we can't throw an exception here because setSubtitle() is called by // ActionBar#setDisplayShowTitleEnabled(). } private void setDefaultMargins() { if (defaultMarginsEnabled && getLayoutParams() instanceof MarginLayoutParams) { Resources resources = getResources(); int marginHorizontal = resources.getDimensionPixelSize(R.dimen.m3_searchbar_margin_horizontal); int marginVertical = resources.getDimensionPixelSize(getDefaultMarginVerticalResource()); MarginLayoutParams lp = (MarginLayoutParams) getLayoutParams(); lp.leftMargin = defaultIfZero(lp.leftMargin, marginHorizontal); lp.topMargin = defaultIfZero(lp.topMargin, marginVertical); lp.rightMargin = defaultIfZero(lp.rightMargin, marginHorizontal); lp.bottomMargin = defaultIfZero(lp.bottomMargin, marginVertical); } } /** @hide */ @DimenRes @RestrictTo(LIBRARY_GROUP) protected int getDefaultMarginVerticalResource() { return R.dimen.m3_searchbar_margin_vertical; } /** @hide */ @DrawableRes @RestrictTo(LIBRARY_GROUP) protected int getDefaultNavigationIconResource() { return R.drawable.ic_search_black_24; } private int defaultIfZero(int value, int defValue) { return value == 0 ? defValue : value; } private void setOrClearDefaultScrollFlags() { if (getLayoutParams() instanceof AppBarLayout.LayoutParams) { AppBarLayout.LayoutParams lp = (AppBarLayout.LayoutParams) getLayoutParams(); if (defaultScrollFlagsEnabled) { if (lp.getScrollFlags() == 0) { lp.setScrollFlags(DEFAULT_SCROLL_FLAGS); } } else { if (lp.getScrollFlags() == DEFAULT_SCROLL_FLAGS) { lp.setScrollFlags(0); } } } } private void measureCenterView(int widthMeasureSpec, int heightMeasureSpec) { if (centerView != null) { centerView.measure(widthMeasureSpec, heightMeasureSpec); } } @Nullable private ActionMenuView findOrGetMenuView() { if (menuView == null) { menuView = ToolbarUtils.getActionMenuView(this); } return menuView; } @Nullable private ImageButton findOrGetNavView() { if (navIconButton == null) { navIconButton = ToolbarUtils.getNavigationIconButton(this); } return navIconButton; } private void layoutTextViewCenterAvoidToolbarViewsAndPadding() { int textViewContainerLeft = getMeasuredWidth() / 2 - textViewContainer.getMeasuredWidth() / 2; int textViewContainerRight = textViewContainerLeft + textViewContainer.getMeasuredWidth(); int textViewContainerTop = getMeasuredHeight() / 2 - textViewContainer.getMeasuredHeight() / 2; int textViewContainerBottom = textViewContainerTop + textViewContainer.getMeasuredHeight(); boolean isRtl = getLayoutDirection() == LAYOUT_DIRECTION_RTL; View menuView = findOrGetMenuView(); View navIconButton = findOrGetNavView(); int textViewLeft = textViewContainer.getMeasuredWidth() / 2 - textView.getMeasuredWidth() / 2; int textViewRight = textViewLeft + textView.getMeasuredWidth(); // left and right refer to the textview's left and right coordinates within the searchbar int left = textViewLeft + textViewContainerLeft; int right = textViewContainerLeft + textViewRight; View leftView = isRtl ? menuView : navIconButton; View rightView = isRtl ? navIconButton : menuView; int leftShift = 0; int rightShift = 0; if (leftView != null) { leftShift = max(leftView.getRight() - left, 0); } left += leftShift; right += leftShift; if (rightView != null) { rightShift = max(right - rightView.getLeft(), 0); } left -= rightShift; right -= rightShift; // Make sure to not lay out the view inside the SearchBar padding. paddingLeftAdded and // paddingRightAdded will never be non-zero at the same time, as Toolbar.measure has already // measured the children accounting for padding. int paddingLeftShift = max(getPaddingLeft() - left, getContentInsetLeft() - left); int paddingRightShift = max( right - (getMeasuredWidth() - getPaddingRight()), right - (getMeasuredWidth() - getContentInsetRight())); paddingLeftShift = max(paddingLeftShift, 0); paddingRightShift = max(paddingRightShift, 0); int totalShift = leftShift - rightShift + paddingLeftShift - paddingRightShift; // Center the textViewContainer and shift over textViewContainer by the amount that textView // needs to be shifted over; this shifts both the container and the textView, which is necessary so the textView doesn't get // laid outside of the container. textViewContainer.layout( textViewContainerLeft + totalShift, textViewContainerTop, textViewContainerRight + totalShift, textViewContainerBottom); } /** * Lays out the given view in the center of the {@link SearchBar}. * * @param view The view to layout in the center. */ private void layoutViewInCenter(View view) { if (view == null) { return; } int viewWidth = view.getMeasuredWidth(); int left = getMeasuredWidth() / 2 - viewWidth / 2; int right = left + viewWidth; int viewHeight = view.getMeasuredHeight(); int top = getMeasuredHeight() / 2 - viewHeight / 2; int bottom = top + viewHeight; layoutChild( view, left, top, right, bottom); } private void layoutChild(View child, int left, int top, int right, int bottom) { if (getLayoutDirection() == View.LAYOUT_DIRECTION_RTL) { child.layout(getMeasuredWidth() - right, top, getMeasuredWidth() - left, bottom); } else { child.layout(left, top, right, bottom); } } private void setHandwritingBoundsInsets() { if (VERSION.SDK_INT < VERSION_CODES.UPSIDE_DOWN_CAKE) { return; } boolean isRtl = getLayoutDirection() == View.LAYOUT_DIRECTION_RTL; // If the navigation icon is non-decorative, exclude it from the handwriting bounds. int startInset = 0; View navigationIconButton = ToolbarUtils.getNavigationIconButton(this); if (navigationIconButton != null && navigationIconButton.isClickable()) { startInset = isRtl ? (getWidth() - navigationIconButton.getLeft()) : navigationIconButton.getRight(); } // Exclude the menu items from the handwriting bounds. int endInset = 0; View actionMenuView = ToolbarUtils.getActionMenuView(this); if (actionMenuView != null) { endInset = isRtl ? actionMenuView.getRight() : (getWidth() - actionMenuView.getLeft()); } setHandwritingBoundsOffsets( -(isRtl ? endInset : startInset), 0, -(isRtl ? startInset : endInset), 0); } /** Returns the optional centered child view of this {@link SearchBar} */ @Nullable public View getCenterView() { return centerView; } /** Sets the center view as a child. Pass in null for {@code view} to remove the center view. */ public void setCenterView(@Nullable View view) { if (centerView != null) { removeView(centerView); centerView = null; } if (view != null) { addView(view); } } TextView getPlaceholderTextView() { return placeholderTextView; } /** Returns the main {@link TextView} which can be used for hint and search text. */ @NonNull public TextView getTextView() { return textView; } /** Returns the text of main {@link TextView}, which usually represents the search text. */ @NonNull // TextView.getText() never returns null after initialization. public CharSequence getText() { return textView.getText(); } /** Sets the text of main {@link TextView}. */ public void setText(@Nullable CharSequence text) { textView.setText(text); placeholderTextView.setText(text); } /** Sets the text of main {@link TextView}. */ public void setText(@StringRes int textResId) { textView.setText(textResId); placeholderTextView.setText(textResId); } /** Whether or not to center the text within the TextView. */ public void setTextCentered(boolean textCentered) { this.textCentered = textCentered; if (textView == null) { return; } FrameLayout.LayoutParams lp = (FrameLayout.LayoutParams) textView.getLayoutParams(); if (textCentered) { lp.gravity = Gravity.CENTER_HORIZONTAL; textView.setGravity(Gravity.CENTER_HORIZONTAL); } else { lp.gravity = Gravity.NO_GRAVITY; textView.setGravity(Gravity.NO_GRAVITY); } textView.setLayoutParams(lp); placeholderTextView.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(""); placeholderTextView.setText(""); } /** Returns the hint of main {@link TextView}. */ @Nullable public CharSequence getHint() { return textView.getHint(); } /** Sets the hint of main {@link TextView}. */ public void setHint(@Nullable CharSequence hint) { textView.setHint(hint); } /** Sets the hint of main {@link TextView}. */ public void setHint(@StringRes int hintResId) { textView.setHint(hintResId); } /** Returns the color of the {@link SearchBar} outline stroke. */ @ColorInt public int getStrokeColor() { return backgroundShape.getStrokeColor().getDefaultColor(); } /** Sets the color of the {@link SearchBar} outline stroke. */ public void setStrokeColor(@ColorInt int strokeColor) { if (getStrokeColor() != strokeColor) { backgroundShape.setStrokeColor(ColorStateList.valueOf(strokeColor)); } } /** Returns the width in pixels of the {@link SearchBar} outline stroke. */ @Dimension public float getStrokeWidth() { return backgroundShape.getStrokeWidth(); } /** Sets the width in pixels of the {@link SearchBar} outline stroke. */ public void setStrokeWidth(@Dimension float strokeWidth) { if (getStrokeWidth() != strokeWidth) { backgroundShape.setStrokeWidth(strokeWidth); } } /** Returns the size in pixels of the {@link SearchBar} corners. */ public float getCornerSize() { // Assume all corner sizes are the same. return backgroundShape.getTopLeftCornerResolvedSize(); } /** * Returns whether the default {@link AppBarLayout} scroll flags are enabled. See {@link * SearchBar#DEFAULT_SCROLL_FLAGS}. */ public boolean isDefaultScrollFlagsEnabled() { return defaultScrollFlagsEnabled; } /** * Sets whether the default {@link AppBarLayout} scroll flags are enabled. See {@link * SearchBar#DEFAULT_SCROLL_FLAGS}. */ public void setDefaultScrollFlagsEnabled(boolean defaultScrollFlagsEnabled) { this.defaultScrollFlagsEnabled = defaultScrollFlagsEnabled; setOrClearDefaultScrollFlags(); } /** * Starts the on load animation which transitions from the center view to the hint {@link * TextView}. */ public void startOnLoadAnimation() { // Use a post() to make sure the SearchBar's menu is inflated before the animation starts. post(() -> searchBarAnimationHelper.startOnLoadAnimation(this)); } /** * Stops the on load animation which transitions from the center view to the hint {@link * TextView}. */ public void stopOnLoadAnimation() { searchBarAnimationHelper.stopOnLoadAnimation(this); } /** Returns whether the fade in part is enabled for the on load animation. */ public boolean isOnLoadAnimationFadeInEnabled() { return searchBarAnimationHelper.isOnLoadAnimationFadeInEnabled(); } /** Sets whether the fade in part is enabled for the on load animation. */ public void setOnLoadAnimationFadeInEnabled(boolean onLoadAnimationFadeInEnabled) { searchBarAnimationHelper.setOnLoadAnimationFadeInEnabled(onLoadAnimationFadeInEnabled); } /** * Registers a callback for the On Load Animation, started and stopped via {@link * #startOnLoadAnimation()} and {@link #stopOnLoadAnimation()}. */ public void addOnLoadAnimationCallback( @NonNull OnLoadAnimationCallback onLoadAnimationCallback) { searchBarAnimationHelper.addOnLoadAnimationCallback(onLoadAnimationCallback); } /** * Unregisters a callback for the On Load Animation, started and stopped via {@link * #startOnLoadAnimation()} and {@link #stopOnLoadAnimation()}. */ public boolean removeOnLoadAnimationCallback( @NonNull OnLoadAnimationCallback onLoadAnimationCallback) { return searchBarAnimationHelper.removeOnLoadAnimationCallback(onLoadAnimationCallback); } /** Returns whether the expand animation is running. */ public boolean isExpanding() { return searchBarAnimationHelper.isExpanding(); } /** See {@link SearchBar#expand(View, AppBarLayout, boolean)}. */ @CanIgnoreReturnValue public boolean expand(@NonNull View expandedView) { return expand(expandedView, /* appBarLayout= */ null); } /** See {@link SearchBar#expand(View, AppBarLayout, boolean)}. */ @CanIgnoreReturnValue public boolean expand(@NonNull View expandedView, @Nullable AppBarLayout appBarLayout) { return expand(expandedView, appBarLayout, /* skipAnimation= */ false); } /** * Starts an expand animation, if it's not already started, which transitions from the {@link * SearchBar} to the {@code expandedView}, e.g., a contextual {@link Toolbar}. * *
Note: If you are using an {@link AppBarLayout} in conjunction with the {@link SearchBar}, * you may pass in a reference to your {@link AppBarLayout} so that its visibility and offset can * be taken into account for the animation. * * @return whether or not the expand animation was started */ @CanIgnoreReturnValue public boolean expand( @NonNull View expandedView, @Nullable AppBarLayout appBarLayout, boolean skipAnimation) { // Start the expand if the expanded view is not already showing or in the process of expanding, // or if the expanded view is collapsing since the final state should be expanded. if ((expandedView.getVisibility() != View.VISIBLE && !isExpanding()) || isCollapsing()) { searchBarAnimationHelper.startExpandAnimation( this, expandedView, appBarLayout, skipAnimation); return true; } return false; } /** * Adds a listener for the expand animation started via {@link #expand(View)} and {@link * #expand(View, AppBarLayout)}. */ public void addExpandAnimationListener(@NonNull AnimatorListenerAdapter listener) { searchBarAnimationHelper.addExpandAnimationListener(listener); } /** * Removes a listener for the expand animation started via {@link #expand(View)} and {@link * #expand(View, AppBarLayout)}. * * @return true if a listener was removed as a result of this call */ public boolean removeExpandAnimationListener(@NonNull AnimatorListenerAdapter listener) { return searchBarAnimationHelper.removeExpandAnimationListener(listener); } /** Returns whether the collapse animation is running. */ public boolean isCollapsing() { return searchBarAnimationHelper.isCollapsing(); } /** See {@link SearchBar#collapse(View, AppBarLayout, boolean)}. */ @CanIgnoreReturnValue public boolean collapse(@NonNull View expandedView) { return collapse(expandedView, /* appBarLayout= */ null); } /** See {@link SearchBar#collapse(View, AppBarLayout, boolean)}. */ @CanIgnoreReturnValue public boolean collapse(@NonNull View expandedView, @Nullable AppBarLayout appBarLayout) { return collapse(expandedView, /* appBarLayout= */ appBarLayout, /* skipAnimation= */ false); } /** * Starts a collapse animation, if it's not already started, which transitions from the {@code * expandedView}, e.g., a contextual {@link Toolbar}, to the {@link SearchBar}. * *
Note: If you are using an {@link AppBarLayout} in conjunction with the {@link SearchBar},
* you may pass in a reference to your {@link AppBarLayout} so that its visibility and offset can
* be taken into account for the animation.
*
* @return whether or not the collapse animation was started
*/
@CanIgnoreReturnValue
public boolean collapse(
@NonNull View expandedView, @Nullable AppBarLayout appBarLayout, boolean skipAnimation) {
// Start the collapse if the expanded view is showing and not in the process of collapsing, or
// if the expanded view is expanding since the final state should be collapsed.
if ((expandedView.getVisibility() == View.VISIBLE && !isCollapsing()) || isExpanding()) {
searchBarAnimationHelper.startCollapseAnimation(
this, expandedView, appBarLayout, skipAnimation);
return true;
}
return false;
}
/**
* Adds a listener for the collapse animation started via {@link #collapse(View)} and {@link
* #collapse(View, AppBarLayout)}.
*/
public void addCollapseAnimationListener(@NonNull AnimatorListenerAdapter listener) {
searchBarAnimationHelper.addCollapseAnimationListener(listener);
}
/**
* Removes a listener for the collapse animation started via {@link #collapse(View)} and {@link
* #collapse(View, AppBarLayout)}.
*
* @return true if a listener was removed as a result of this call
*/
public boolean removeCollapseAnimationListener(@NonNull AnimatorListenerAdapter listener) {
return searchBarAnimationHelper.removeCollapseAnimationListener(listener);
}
int getMenuResId() {
return menuResId;
}
float getCompatElevation() {
return backgroundShape != null ? backgroundShape.getElevation() : getElevation();
}
/** Sets the max width of SearchBar in pixels. **/
public void setMaxWidth(@Px int maxWidth) {
if (this.maxWidth != maxWidth) {
this.maxWidth = maxWidth;
requestLayout();
}
}
/** Get the max width of SearchBar in pixels. **/
@Px
public int getMaxWidth() {
return maxWidth;
}
/** Behavior that sets up the scroll-away mode for an {@link SearchBar}. */
public static class ScrollingViewBehavior extends AppBarLayout.ScrollingViewBehavior {
private boolean initialized = false;
public ScrollingViewBehavior() {}
public ScrollingViewBehavior(@NonNull Context context, @Nullable AttributeSet attrs) {
super(context, attrs);
}
@Override
public boolean onDependentViewChanged(
@NonNull CoordinatorLayout parent, @NonNull View child, @NonNull View dependency) {
boolean changed = super.onDependentViewChanged(parent, child, dependency);
if (!initialized && dependency instanceof AppBarLayout) {
initialized = true;
AppBarLayout appBarLayout = (AppBarLayout) dependency;
// Necessary to enable keyboard navigation across searchbar and other elements due to
// toolbar being a keyboard navigation cluster from API 26+
appBarLayout.setTouchscreenBlocksFocus(false);
setAppBarLayoutTransparent(appBarLayout);
}
return changed;
}
private void setAppBarLayoutTransparent(AppBarLayout appBarLayout) {
appBarLayout.setBackgroundColor(Color.TRANSPARENT);
// Remove AppBarLayout elevation shadow
if (Build.VERSION.SDK_INT == VERSION_CODES.LOLLIPOP) {
// Workaround for elevation crash that only happens on Android 5.0
// Similar to https://stackoverflow.com/q/40928788
appBarLayout.setOutlineProvider(null);
} else {
appBarLayout.setTargetElevation(0);
}
}
@Override
protected boolean shouldHeaderOverlapScrollingChild() {
return true;
}
}
/**
* Callback for the animation started and stopped via {@link #startOnLoadAnimation()} and {@link
* #stopOnLoadAnimation()}.
*/
public abstract static class OnLoadAnimationCallback {
public void onAnimationStart() {}
public void onAnimationEnd() {}
}
@Override
@NonNull
protected Parcelable onSaveInstanceState() {
SavedState savedState = new SavedState(super.onSaveInstanceState());
CharSequence text = getText();
savedState.text = text == null ? null : text.toString();
return savedState;
}
@Override
protected void onRestoreInstanceState(Parcelable state) {
if (!(state instanceof SavedState)) {
super.onRestoreInstanceState(state);
return;
}
SavedState savedState = (SavedState) state;
super.onRestoreInstanceState(savedState.getSuperState());
setText(savedState.text);
}
static class SavedState extends AbsSavedState {
String text;
public SavedState(Parcel source) {
this(source, null);
}
public SavedState(Parcel source, @Nullable ClassLoader classLoader) {
super(source, classLoader);
text = source.readString();
}
public SavedState(Parcelable superState) {
super(superState);
}
public static final Parcelable.Creator