SearchFragment

Artifact: androidx.leanback:leanback

View Source

Added in 1.1.0

Deprecated in 1.1.0

---

Kotlin |Java

class SearchFragment : Fragment

kotlin.Any
↳	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 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 .

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 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 types
interface SearchFragment.SearchResultProvider Search API to be provided by the application.

Public constructors
SearchFragment()

Public functions
java-static Bundle!	createArgs(args: Bundle!, query: String!)
java-static Bundle!	createArgs(args: Bundle!, query: String!, title: String!)
Unit	displayCompletions(completions: Array<CompletionInfo!>!) Displays the completions shown by the IME.
Unit	displayCompletions(completions: (Mutable)List<String!>!) 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.
java-static SearchFragment!	newInstance(query: String!) Creates a search fragment with a given search query.
Unit	onCreate(savedInstanceState: Bundle!) This function is deprecated.
View?	onCreateView(     inflater: LayoutInflater!,     container: ViewGroup?,     savedInstanceState: Bundle! ) This function is deprecated.
Unit	onDestroy() This function is deprecated.
Unit	onDestroyView() This function is deprecated.
Unit	onPause() This function is deprecated.
Unit	onRequestPermissionsResult(     requestCode: Int,     permissions: Array<String!>!,     grantResults: IntArray! ) This function is deprecated.
Unit	onResume() This function is deprecated.
Unit	onStart() This function is deprecated.
Unit	setBadgeDrawable(drawable: Drawable!) Sets the badge drawable that will be shown inside the search bar next to the title.
Unit	setOnItemViewClickedListener(listener: OnItemViewClickedListener!) Sets an item clicked listener for the results.
Unit	setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!) Sets an item selection listener for the results.
Unit	setSearchAffordanceColors(colors: SearchOrbView.Colors!) Sets background color of not-listening state search orb.
Unit	setSearchAffordanceColorsInListening(colors: SearchOrbView.Colors!) Sets background color of listening state search orb.
Unit	setSearchQuery(intent: Intent!, submit: Boolean) Sets the text of the search query based on the EXTRA_RESULTS in the given intent, and optionally submit the query.
Unit	setSearchQuery(query: String!, submit: Boolean) Sets the text of the search query and optionally submits the query.
Unit	setSearchResultProvider(     searchResultProvider: SearchFragment.SearchResultProvider! ) Sets the search provider that is responsible for returning results for the search query.
Unit	setSpeechRecognitionCallback(callback: SpeechRecognitionCallback!) This function is deprecated. Launching voice recognition activity is no longer supported.
Unit	setTitle(title: String!) Sets the title string to be be shown in an empty search bar.
Unit	startRecognition() Starts speech recognition.

Inherited Constants
From android.content.ComponentCallbacks2 const Int TRIM_MEMORY_BACKGROUND = 40 const Int TRIM_MEMORY_COMPLETE = 80 const Int TRIM_MEMORY_MODERATE = 60 const Int TRIM_MEMORY_RUNNING_CRITICAL = 15 const Int TRIM_MEMORY_RUNNING_LOW = 10 const Int TRIM_MEMORY_RUNNING_MODERATE = 5 const Int TRIM_MEMORY_UI_HIDDEN = 20

Inherited functions

From android.app.Fragment Unit dump(     prefix: String!,     fd: FileDescriptor!,     writer: PrintWriter!,     args: Array<String!>! ) This function is deprecated. Boolean equals(o: Any!) This function is deprecated. Activity! getActivity() This function is deprecated. Boolean getAllowEnterTransitionOverlap() This function is deprecated. Boolean getAllowReturnTransitionOverlap() This function is deprecated. Bundle! getArguments() This function is deprecated. FragmentManager! getChildFragmentManager() This function is deprecated. Context! getContext() This function is deprecated. Transition! getEnterTransition() This function is deprecated. Transition! getExitTransition() This function is deprecated. FragmentManager! getFragmentManager() This function is deprecated. Any! getHost() This function is deprecated. Int getId() This function is deprecated. LayoutInflater! getLayoutInflater() This function is deprecated. LoaderManager! getLoaderManager() This function is deprecated. Fragment! getParentFragment() This function is deprecated. Transition! getReenterTransition() This function is deprecated. Resources! getResources() This function is deprecated. Boolean getRetainInstance() This function is deprecated. Transition! getReturnTransition() This function is deprecated. Transition! getSharedElementEnterTransition() This function is deprecated. Transition! getSharedElementReturnTransition() This function is deprecated. String! getString(resId: Int) This function is deprecated. String! getTag() This function is deprecated. Fragment! getTargetFragment() This function is deprecated. Int getTargetRequestCode() This function is deprecated. CharSequence! getText(resId: Int) This function is deprecated. Boolean getUserVisibleHint() This function is deprecated. View! getView() This function is deprecated. Int hashCode() This function is deprecated. java-static Fragment! instantiate(context: Context!, fname: String!) This function is deprecated. Boolean isAdded() This function is deprecated. Boolean isDetached() This function is deprecated. Boolean isHidden() This function is deprecated. Boolean isInLayout() This function is deprecated. Boolean isRemoving() This function is deprecated. Boolean isResumed() This function is deprecated. Boolean isStateSaved() This function is deprecated. Boolean isVisible() This function is deprecated. Unit onActivityCreated(savedInstanceState: Bundle!) This function is deprecated. Unit onActivityResult(requestCode: Int, resultCode: Int, data: Intent!) This function is deprecated. Unit onAttach(context: Context!) This function is deprecated. Unit onAttachFragment(childFragment: Fragment!) This function is deprecated. Unit onConfigurationChanged(newConfig: Configuration!) This function is deprecated. Boolean onContextItemSelected(item: MenuItem!) This function is deprecated. Animator! onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int) This function is deprecated. Unit onCreateContextMenu(     menu: ContextMenu!,     v: View!,     menuInfo: ContextMenu.ContextMenuInfo! ) This function is deprecated. Unit onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!) This function is deprecated. Unit onDestroyOptionsMenu() This function is deprecated. Unit onDetach() This function is deprecated. LayoutInflater! onGetLayoutInflater(savedInstanceState: Bundle!) This function is deprecated. Unit onHiddenChanged(hidden: Boolean) This function is deprecated. Unit onInflate(attrs: AttributeSet!, savedInstanceState: Bundle!) This function is deprecated. Unit onLowMemory() This function is deprecated. Unit onMultiWindowModeChanged(     isInMultiWindowMode: Boolean,     newConfig: Configuration! ) This function is deprecated. Boolean onOptionsItemSelected(item: MenuItem!) This function is deprecated. Unit onOptionsMenuClosed(menu: Menu!) This function is deprecated. Unit onPictureInPictureModeChanged(     isInPictureInPictureMode: Boolean,     newConfig: Configuration! ) This function is deprecated. Unit onPrepareOptionsMenu(menu: Menu!) This function is deprecated. Unit onSaveInstanceState(outState: Bundle!) This function is deprecated. Unit onStop() This function is deprecated. Unit onTrimMemory(level: Int) This function is deprecated. Unit onViewCreated(view: View!, savedInstanceState: Bundle!) This function is deprecated. Unit onViewStateRestored(savedInstanceState: Bundle!) This function is deprecated. Unit postponeEnterTransition() This function is deprecated. Unit registerForContextMenu(view: View!) This function is deprecated. Unit requestPermissions(permissions: Array<String!>!, requestCode: Int) This function is deprecated. Unit setAllowEnterTransitionOverlap(allow: Boolean) This function is deprecated. Unit setAllowReturnTransitionOverlap(allow: Boolean) This function is deprecated. Unit setArguments(args: Bundle!) This function is deprecated. Unit setEnterSharedElementCallback(callback: SharedElementCallback!) This function is deprecated. Unit setEnterTransition(transition: Transition!) This function is deprecated. Unit setExitSharedElementCallback(callback: SharedElementCallback!) This function is deprecated. Unit setExitTransition(transition: Transition!) This function is deprecated. Unit setHasOptionsMenu(hasMenu: Boolean) This function is deprecated. Unit setInitialSavedState(state: Fragment.SavedState!) This function is deprecated. Unit setMenuVisibility(menuVisible: Boolean) This function is deprecated. Unit setReenterTransition(transition: Transition!) This function is deprecated. Unit setRetainInstance(retain: Boolean) This function is deprecated. Unit setReturnTransition(transition: Transition!) This function is deprecated. Unit setSharedElementEnterTransition(transition: Transition!) This function is deprecated. Unit setSharedElementReturnTransition(transition: Transition!) This function is deprecated. Unit setTargetFragment(fragment: Fragment!, requestCode: Int) This function is deprecated. Unit setUserVisibleHint(isVisibleToUser: Boolean) This function is deprecated. Boolean shouldShowRequestPermissionRationale(permission: String!) This function is deprecated. Unit startActivity(intent: Intent!) This function is deprecated. Unit startActivityForResult(intent: Intent!, requestCode: Int) This function is deprecated. Unit startIntentSenderForResult(     intent: IntentSender!,     requestCode: Int,     fillInIntent: Intent!,     flagsMask: Int,     flagsValues: Int,     extraFlags: Int,     options: Bundle! ) This function is deprecated. Unit startPostponedEnterTransition() This function is deprecated. String! toString() This function is deprecated. Unit unregisterForContextMenu(view: View!) This function is deprecated.

Public constructors

SearchFragment

Added in 1.1.0

Deprecated in 1.1.0

SearchFragment()

Public functions

createArgs

Added in 1.1.0

Deprecated in 1.1.0

java-static fun createArgs(args: Bundle!, query: String!): Bundle!

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

createArgs

Added in 1.1.0

Deprecated in 1.1.0

java-static fun createArgs(args: Bundle!, query: String!, title: String!): Bundle!

displayCompletions

Added in 1.1.0

Deprecated in 1.1.0

fun displayCompletions(completions: Array<CompletionInfo!>!): Unit

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: Array<CompletionInfo!>!	A list of completions to show in the IME. Setting to null or empty will clear the list.

displayCompletions

Added in 1.1.0

Deprecated in 1.1.0

fun displayCompletions(completions: (Mutable)List<String!>!): Unit

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: (Mutable)List<String!>!	A list of completions to show in the IME. Setting to null or empty will clear the list.

getBadgeDrawable

Added in 1.1.0

Deprecated in 1.1.0

fun getBadgeDrawable(): Drawable!

Returns the badge drawable in the search bar.

getRecognizerIntent

Added in 1.1.0

Deprecated in 1.1.0

fun getRecognizerIntent(): Intent!

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

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

For handling the intent returned from the service, see setSearchQuery.

getRowsFragment

Added in 1.1.0

Deprecated in 1.1.0

fun getRowsFragment(): RowsFragment!

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

Returns
RowsFragment!	RowsFragment that shows result rows.

getTitle

Added in 1.1.0

Deprecated in 1.1.0

fun getTitle(): String!

Returns the title set in the search bar.

newInstance

Added in 1.1.0

Deprecated in 1.1.0

java-static fun newInstance(query: String!): SearchFragment!

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

Added in 1.1.0

Deprecated in 1.1.0

fun onCreate(savedInstanceState: Bundle!): Unit

This function is deprecated.

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

fun onCreateView(
    inflater: LayoutInflater!,
    container: ViewGroup?,
    savedInstanceState: Bundle!
): View?

This function is deprecated.

onDestroy

Added in 1.1.0

Deprecated in 1.1.0

fun onDestroy(): Unit

This function is deprecated.

onDestroyView

Added in 1.1.0

Deprecated in 1.1.0

fun onDestroyView(): Unit

This function is deprecated.

onPause

Added in 1.1.0

Deprecated in 1.1.0

fun onPause(): Unit

This function is deprecated.

onRequestPermissionsResult

Added in 1.1.0

Deprecated in 1.1.0

fun onRequestPermissionsResult(
    requestCode: Int,
    permissions: Array<String!>!,
    grantResults: IntArray!
): Unit

This function is deprecated.

onResume

Added in 1.1.0

Deprecated in 1.1.0

fun onResume(): Unit

This function is deprecated.

onStart

Added in 1.1.0

Deprecated in 1.1.0

fun onStart(): Unit

This function is deprecated.

setBadgeDrawable

Added in 1.1.0

Deprecated in 1.1.0

fun setBadgeDrawable(drawable: Drawable!): Unit

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

setOnItemViewClickedListener

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewClickedListener(listener: OnItemViewClickedListener!): Unit

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

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewSelectedListener(listener: OnItemViewSelectedListener!): Unit

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

Added in 1.1.0

Deprecated in 1.1.0

fun setSearchAffordanceColors(colors: SearchOrbView.Colors!): Unit

Sets background color of not-listening state search orb.

Parameters
colors: SearchOrbView.Colors!	SearchOrbView.Colors.

setSearchAffordanceColorsInListening

Added in 1.1.0

Deprecated in 1.1.0

fun setSearchAffordanceColorsInListening(colors: SearchOrbView.Colors!): Unit

Sets background color of listening state search orb.

Parameters
colors: SearchOrbView.Colors!	SearchOrbView.Colors.

setSearchQuery

Added in 1.1.0

Deprecated in 1.1.0

fun setSearchQuery(intent: Intent!, submit: Boolean): Unit

Sets the text of the search query based on the 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.

setSearchQuery

Added in 1.1.0

Deprecated in 1.1.0

fun setSearchQuery(query: String!, submit: Boolean): Unit

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.

setSearchResultProvider

Added in 1.1.0

Deprecated in 1.1.0

fun setSearchResultProvider(
    searchResultProvider: SearchFragment.SearchResultProvider!
): Unit

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

setSpeechRecognitionCallback

Added in 1.1.0

Deprecated in 1.1.0

fun setSpeechRecognitionCallback(callback: SpeechRecognitionCallback!): Unit

This function 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.

setTitle

Added in 1.1.0

Deprecated in 1.1.0

fun setTitle(title: String!): Unit

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".

startRecognition

Added in 1.1.0

Deprecated in 1.1.0

fun startRecognition(): Unit

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.