Summary: Nested Classes | Inherited Constants | Ctors | Methods | Inherited Methods

SearchFragment

Kotlin |Java

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
From interface android.content.ComponentCallbacks2 int TRIM_MEMORY_BACKGROUND int TRIM_MEMORY_COMPLETE int TRIM_MEMORY_MODERATE int TRIM_MEMORY_RUNNING_CRITICAL int TRIM_MEMORY_RUNNING_LOW int TRIM_MEMORY_RUNNING_MODERATE int TRIM_MEMORY_UI_HIDDEN

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	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 RecognizerIntent.EXTRA_RESULTS in the given intent, and optionally submit the query.
void	setSearchResultProvider(SearchFragment.SearchResultProvider searchResultProvider) Sets the search provider that is responsible for returning results for the search query.
void	setSpeechRecognitionCallback(SpeechRecognitionCallback callback) This method is deprecated. Launching voice recognition activity is no longer supported. App should declare android.permission.RECORD_AUDIO in AndroidManifest file.
void	setTitle(String title) Sets the title string to be be shown in an empty search bar.
void	startRecognition() Starts speech recognition.

Inherited methods
From class android.app.Fragment void dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3) final boolean equals(Object arg0) final Activity getActivity() boolean getAllowEnterTransitionOverlap() boolean getAllowReturnTransitionOverlap() final Bundle getArguments() final FragmentManager getChildFragmentManager() Context getContext() Transition getEnterTransition() Transition getExitTransition() final FragmentManager getFragmentManager() final Object getHost() final int getId() final LayoutInflater getLayoutInflater() LoaderManager getLoaderManager() final Fragment getParentFragment() Transition getReenterTransition() final Resources getResources() final boolean getRetainInstance() Transition getReturnTransition() Transition getSharedElementEnterTransition() Transition getSharedElementReturnTransition() final String getString(int arg0, Object... arg1) final String getString(int arg0) final String getTag() final Fragment getTargetFragment() final int getTargetRequestCode() final CharSequence getText(int arg0) boolean getUserVisibleHint() View getView() final int hashCode() static Fragment instantiate(Context arg0, String arg1) static Fragment instantiate(Context arg0, String arg1, Bundle arg2) final boolean isAdded() final boolean isDetached() final boolean isHidden() final boolean isInLayout() final boolean isRemoving() final boolean isResumed() final boolean isStateSaved() final boolean isVisible() void onActivityCreated(Bundle arg0) void onActivityResult(int arg0, int arg1, Intent arg2) void onAttach(Activity arg0) void onAttach(Context arg0) void onAttachFragment(Fragment arg0) void onConfigurationChanged(Configuration arg0) boolean onContextItemSelected(MenuItem arg0) void onCreate(Bundle arg0) Animator onCreateAnimator(int arg0, boolean arg1, int arg2) void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2) void onCreateOptionsMenu(Menu arg0, MenuInflater arg1) View onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2) void onDestroy() void onDestroyOptionsMenu() void onDestroyView() void onDetach() LayoutInflater onGetLayoutInflater(Bundle arg0) void onHiddenChanged(boolean arg0) void onInflate(AttributeSet arg0, Bundle arg1) void onInflate(Activity arg0, AttributeSet arg1, Bundle arg2) void onInflate(Context arg0, AttributeSet arg1, Bundle arg2) void onLowMemory() void onMultiWindowModeChanged(boolean arg0) void onMultiWindowModeChanged(boolean arg0, Configuration arg1) boolean onOptionsItemSelected(MenuItem arg0) void onOptionsMenuClosed(Menu arg0) void onPause() void onPictureInPictureModeChanged(boolean arg0, Configuration arg1) void onPictureInPictureModeChanged(boolean arg0) void onPrepareOptionsMenu(Menu arg0) void onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2) void onResume() void onSaveInstanceState(Bundle arg0) void onStart() void onStop() void onTrimMemory(int arg0) void onViewCreated(View arg0, Bundle arg1) void onViewStateRestored(Bundle arg0) void postponeEnterTransition() void registerForContextMenu(View arg0) final void requestPermissions(String[] arg0, int arg1) void setAllowEnterTransitionOverlap(boolean arg0) void setAllowReturnTransitionOverlap(boolean arg0) void setArguments(Bundle arg0) void setEnterSharedElementCallback(SharedElementCallback arg0) void setEnterTransition(Transition arg0) void setExitSharedElementCallback(SharedElementCallback arg0) void setExitTransition(Transition arg0) void setHasOptionsMenu(boolean arg0) void setInitialSavedState(Fragment.SavedState arg0) void setMenuVisibility(boolean arg0) void setReenterTransition(Transition arg0) void setRetainInstance(boolean arg0) void setReturnTransition(Transition arg0) void setSharedElementEnterTransition(Transition arg0) void setSharedElementReturnTransition(Transition arg0) void setTargetFragment(Fragment arg0, int arg1) void setUserVisibleHint(boolean arg0) boolean shouldShowRequestPermissionRationale(String arg0) void startActivity(Intent arg0) void startActivity(Intent arg0, Bundle arg1) void startActivityForResult(Intent arg0, int arg1) void startActivityForResult(Intent arg0, int arg1, Bundle arg2) void startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6) void startPostponedEnterTransition() String toString() void unregisterForContextMenu(View arg0)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.content.ComponentCallbacks2 abstract void onTrimMemory(int arg0)
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()

Public constructors

SearchFragment

public SearchFragment ()

Public methods

createArgs

public static Bundle createArgs (Bundle args, 
                String query, 
                String title)

Parameters
args	Bundle
query	String
title	String

Returns
Bundle

createArgs

public static Bundle createArgs (Bundle args, 
                String query)

Parameters
args	Bundle: Bundle to use for the arguments, if null a new Bundle will be created.
query	String

Returns
Bundle

displayCompletions

public void displayCompletions (CompletionInfo[] completions)

Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.

Parameters
completions	CompletionInfo: A list of completions to show in the IME. Setting to null or empty will clear the list.

displayCompletions

public void displayCompletions (List<String> completions)

Displays the completions shown by the IME. An application may provide a list of query completions that the system will show in the IME.

Parameters
completions	List: A list of completions to show in the IME. Setting to null or empty will clear the list.

getBadgeDrawable

public Drawable getBadgeDrawable ()

Returns the badge drawable in the search bar.

Returns
Drawable

getRecognizerIntent

public Intent getRecognizerIntent ()

Returns an intent that can be used to request speech recognition. Built from the base RecognizerIntent.ACTION_RECOGNIZE_SPEECH plus extras:

• RecognizerIntent.EXTRA_LANGUAGE_MODEL set to RecognizerIntent.LANGUAGE_MODEL_FREE_FORM
• RecognizerIntent.EXTRA_PARTIAL_RESULTS set to true
• RecognizerIntent.EXTRA_PROMPT set to the search bar hint text

For handling the intent returned from the service, see setSearchQuery(Intent, boolean).

Returns
Intent

getRowsFragment

public RowsFragment getRowsFragment ()

Returns RowsFragment that shows result rows. RowsFragment is initialized after SearchFragment.onCreateView().

Returns
RowsFragment	RowsFragment that shows result rows.

getTitle

public String getTitle ()

Returns the title set in the search bar.

Returns
String

newInstance

public static SearchFragment newInstance (String query)

Creates a search fragment with a given search query.

You should only use this if you need to start the search fragment with a pre-filled query.

Parameters
query	String: The search query to begin with.

Returns
SearchFragment	A new SearchFragment.

onCreate

public void onCreate (Bundle savedInstanceState)

Parameters
savedInstanceState	Bundle

onCreateView

public View onCreateView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

Parameters
inflater	LayoutInflater
container	ViewGroup
savedInstanceState	Bundle

Returns
View

onDestroy

public void onDestroy ()

onPause

public void onPause ()

onRequestPermissionsResult

public void onRequestPermissionsResult (int requestCode, 
                String[] permissions, 
                int[] grantResults)

Parameters
requestCode	int
permissions	String
grantResults	int

onResume

public void onResume ()

onStart

public void onStart ()

setBadgeDrawable

public void setBadgeDrawable (Drawable drawable)

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

Parameters
drawable	Drawable

setOnItemViewClickedListener

public void setOnItemViewClickedListener (OnItemViewClickedListener listener)

Sets an item clicked listener for the results.

Parameters
listener	OnItemViewClickedListener: The item clicked listener to be invoked when an item in the search results is clicked.

setOnItemViewSelectedListener

public void setOnItemViewSelectedListener (OnItemViewSelectedListener listener)

Sets an item selection listener for the results.

Parameters
listener	OnItemViewSelectedListener: The item selection listener to be invoked when an item in the search results is selected.

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.

setSearchQuery

public void setSearchQuery (String query, 
                boolean submit)

Sets the text of the search query and optionally submits the query. Either onQueryTextChange or onQueryTextSubmit will be called on the provider if it is set.

Parameters
query	String: The search query to set.
submit	boolean: Whether to submit the query.

setSearchQuery

public void setSearchQuery (Intent intent, 
                boolean submit)

Sets the text of the search query based on the RecognizerIntent.EXTRA_RESULTS in the given intent, and optionally submit the query. If more than one result is present in the results list, the first will be used.

Parameters
intent	Intent: Intent received from a speech recognition service.
submit	boolean: Whether to submit the query.

setSearchResultProvider

public void setSearchResultProvider (SearchFragment.SearchResultProvider searchResultProvider)

Sets the search provider that is responsible for returning results for the search query.

Parameters
searchResultProvider	SearchFragment.SearchResultProvider

setSpeechRecognitionCallback

public void setSpeechRecognitionCallback (SpeechRecognitionCallback callback)

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

Sets this callback to have the fragment pass speech recognition requests to the activity rather than using a SpeechRecognizer object.

Parameters
callback	SpeechRecognitionCallback

setTitle

public void setTitle (String title)

Sets the title string to be be shown in an empty search bar. The title may be placed in a call-to-action, such as "Search title" or "Speak to search title".

Parameters
title	String

startRecognition

public void startRecognition ()

Starts speech recognition. Typical use case is that activity receives onNewIntent() call when user clicks a MIC button. Note that SearchFragment automatically starts speech recognition at first time created, there is no need to call startRecognition() when fragment is created.