added in version 22.1.0
belongs to Maven artifact


public class SearchBar
extends RelativeLayout

   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.RelativeLayout

A search widget containing a search orb and a text entry view.

Note: When SpeechRecognitionCallback is not used, i.e. using SpeechRecognizer, your application will need to declare android.permission.RECORD_AUDIO in manifest file. If your application target >= 23 and the device is running >= 23, it needs implement SearchBar.SearchBarPermissionListener where requests runtime permission.


Nested classes

interface SearchBar.SearchBarListener

Interface for receiving notification of search query changes. 

interface SearchBar.SearchBarPermissionListener

Interface that handles runtime permissions requests. 

Inherited constants

From class android.widget.RelativeLayout
From class android.view.ViewGroup
From class android.view.View

Inherited fields

From class android.view.View

Public constructors

SearchBar(Context context)
SearchBar(Context context, AttributeSet attrs)
SearchBar(Context context, AttributeSet attrs, int defStyle)

Public methods

void displayCompletions(CompletionInfo[] completions)

Updates the completion list shown by the IME

void displayCompletions(List<String> completions)

Updates the completion list shown by the IME

Drawable getBadgeDrawable()

Returns the badge drawable

CharSequence getHint()

Returns the current search bar hint text.

String getTitle()

Returns the current title

boolean isRecognizing()

Returns true if is not running Recognizer, false otherwise.

void setBadgeDrawable(Drawable drawable)

Sets the badge drawable showing inside the search bar.

void setNextFocusDownId(int viewId)
void setPermissionListener(SearchBar.SearchBarPermissionListener listener)

Sets listener that handles runtime permission requests.

void setSearchAffordanceColors(SearchOrbView.Colors colors)

Sets background color of not-listening state search orb.

void setSearchAffordanceColorsInListening(SearchOrbView.Colors colors)

Sets background color of listening state search orb.

void setSearchBarListener(SearchBar.SearchBarListener listener)

Sets a listener for when the term search changes

void setSearchQuery(String query)

Sets the search query

void setSpeechRecognitionCallback(SpeechRecognitionCallback request)

This method was deprecated in API level 27.1.0. Launching voice recognition activity is no longer supported. App should declare android.permission.RECORD_AUDIO in AndroidManifest file. See details in SearchSupportFragment.

void setSpeechRecognizer(SpeechRecognizer recognizer)

Sets the speech recognizer to be used when doing voice search.

void setTitle(String title)

Sets the title text used in the hint shown in the search bar.

void startRecognition()
void stopRecognition()

Stops the speech recognition, if already started.

Protected methods

void onAttachedToWindow()
void onDetachedFromWindow()
void onFinishInflate()

Inherited methods

From class android.widget.RelativeLayout