lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

belongs to Maven artifact androidx.leanback:leanback:1.0.0-alpha3

SearchBar

public class SearchBar
extends RelativeLayout

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.RelativeLayout
         ↳ androidx.leanback.widget.SearchBar


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.

Summary

Nested classes

interface SearchBar.SearchBarListener

Interface for receiving notification of search query changes. 

interface SearchBar.SearchBarPermissionListener

Interface that handles runtime permissions requests. 

Inherited constants

Inherited fields

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 is deprecated. 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

Public constructors

SearchBar

public SearchBar (Context context)

Parameters
context Context

SearchBar

public SearchBar (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

SearchBar

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

Parameters
context Context

attrs AttributeSet

defStyle int

Public methods

displayCompletions

public void displayCompletions (CompletionInfo[] completions)

Updates the completion list shown by the IME

Parameters
completions CompletionInfo: list of completions shown in the IME, can be null or empty to clear them

displayCompletions

public void displayCompletions (List<String> completions)

Updates the completion list shown by the IME

Parameters
completions List: list of completions shown in the IME, can be null or empty to clear them

getBadgeDrawable

public Drawable getBadgeDrawable ()

Returns the badge drawable

Returns
Drawable

getHint

public CharSequence getHint ()

Returns the current search bar hint text.

Returns
CharSequence

getTitle

public String getTitle ()

Returns the current title

Returns
String

isRecognizing

public boolean isRecognizing ()

Returns true if is not running Recognizer, false otherwise.

Returns
boolean True if is not running Recognizer, false otherwise.

setBadgeDrawable

public void setBadgeDrawable (Drawable drawable)

Sets the badge drawable showing inside the search bar.

Parameters
drawable Drawable: The drawable to be used in the search bar.

setNextFocusDownId

public void setNextFocusDownId (int viewId)

Parameters
viewId int

setPermissionListener

public void setPermissionListener (SearchBar.SearchBarPermissionListener listener)

Sets listener that handles runtime permission requests.

Parameters
listener SearchBar.SearchBarPermissionListener: Listener that handles runtime permission requests.

setSearchAffordanceColors

public void setSearchAffordanceColors (SearchOrbView.Colors colors)

Sets background color of not-listening state search orb.

Parameters
colors SearchOrbView.Colors: SearchOrbView.Colors.

setSearchAffordanceColorsInListening

public void setSearchAffordanceColorsInListening (SearchOrbView.Colors colors)

Sets background color of listening state search orb.

Parameters
colors SearchOrbView.Colors: SearchOrbView.Colors.

setSearchBarListener

public void setSearchBarListener (SearchBar.SearchBarListener listener)

Sets a listener for when the term search changes

setSearchQuery

public void setSearchQuery (String query)

Sets the search query

Parameters
query String: the search query to use

setSpeechRecognitionCallback

public void setSpeechRecognitionCallback (SpeechRecognitionCallback request)

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

Sets the speech recognition callback.

Parameters
request SpeechRecognitionCallback

setSpeechRecognizer

public void setSpeechRecognizer (SpeechRecognizer recognizer)

Sets the speech recognizer to be used when doing voice search. The Activity/Fragment is in charge of creating and destroying the recognizer with its own lifecycle.

Parameters
recognizer SpeechRecognizer: a SpeechRecognizer

setTitle

public void setTitle (String title)

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

Parameters
title String: The hint to use.

startRecognition

public void startRecognition ()

stopRecognition

public void stopRecognition ()

Stops the speech recognition, if already started.

Protected methods

onAttachedToWindow

protected void onAttachedToWindow ()

onDetachedFromWindow

protected void onDetachedFromWindow ()

onFinishInflate

protected void onFinishInflate ()