SearchFragment

public class SearchFragment
extends Fragment

java.lang.Object
   ↳ android.app.Fragment
     ↳ androidx.leanback.app.SearchFragment


This class is deprecated.
use SearchSupportFragment

A fragment to handle searches. An application will supply an implementation of the SearchFragment.SearchResultProvider interface to handle the search and return an ObjectAdapter containing the results. The results are rendered into a RowsFragment, in the same way that they are in a BrowseFragment.

A SpeechRecognizer object will be created for which your application will need to declare android.permission.RECORD_AUDIO in AndroidManifest file. If app's target version is >= 23 and the device version is >= 23, a permission dialog will show first time using speech recognition. 0 will be used as requestCode in requestPermissions() call. setSpeechRecognitionCallback(SpeechRecognitionCallback) is deprecated.

Speech recognition is automatically started when fragment is created, but not when fragment is restored from an instance state. Activity may manually call startRecognition(), typically in onNewIntent().

Summary

Nested classes

interface SearchFragment.SearchResultProvider

Search API to be provided by the application. 

Inherited constants

Public constructors

SearchFragment()

Public methods

static Bundle createArgs(Bundle args, String query, String title)
static Bundle createArgs(Bundle args, String query)
void displayCompletions(CompletionInfo[] completions)

Displays the completions shown by the IME.

void displayCompletions(List<String> completions)

Displays the completions shown by the IME.

Drawable getBadgeDrawable()

Returns the badge drawable in the search bar.

Intent getRecognizerIntent()

Returns an intent that can be used to request speech recognition.

RowsFragment getRowsFragment()

Returns RowsFragment that shows result rows.

String getTitle()

Returns the title set in the search bar.

static SearchFragment newInstance(String query)

Creates a search fragment with a given search query.

void onCreate(Bundle savedInstanceState)
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void onDestroy()
void onDestroyView()
void onPause()
void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)
void onResume()
void onStart()
void setBadgeDrawable(Drawable drawable)

Sets the badge drawable that will be shown inside the search bar next to the title.

void setOnItemViewClickedListener(OnItemViewClickedListener listener)

Sets an item clicked listener for the results.

void setOnItemViewSelectedListener(OnItemViewSelectedListener listener)

Sets an item selection listener for the results.

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 setSearchQuery(String query, boolean submit)

Sets the text of the search query and optionally submits the query.

void setSearchQuery(Intent intent, boolean submit)

Sets the text of the search query based on the