Most visited

Recently visited

Results for

SearchFragment

public class SearchFragment
extends Fragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.v17.leanback.app.SearchFragment

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.

If you do not supply a callback via setSpeechRecognitionCallback(SpeechRecognitionCallback), an internal speech recognizer will be used 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.

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 XML attributes

From class


  android.app.Fragment

Inherited constants

From interface


    android.content.ComponentCallbacks2

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.
`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)` Called to do initial creation of a fragment.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onStart()` Called when the Fragment is visible to the user.
`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`	`setSearchQuery(Intent intent, boolean submit)` Sets the text of the search query based on the `EXTRA_RESULTS` in the given intent, and optionally submit the query.
`void`	`setSearchQuery(String query, boolean submit)` Sets the text of the search query and optionally submits 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)` Sets this callback to have the fragment pass speech recognition requests to the activity rather than using an internal recognizer.
`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 prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final Activity`	`getActivity()` Return the Activity this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`final Bundle`	`getArguments()` Return the arguments supplied to `setArguments(Bundle)`, if any.
`final FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`Transition`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Transition`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final FragmentManager`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`LoaderManager`	`getLoaderManager()` Return the LoaderManager for this fragment, creating it if needed.
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`Transition`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final Resources`	`getResources()` Return `getActivity().getResources()`.
`final boolean`	`getRetainInstance()`
`Transition`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`Transition`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Transition`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` Return the target fragment set by `setTargetFragment(Fragment, int)`.
`final int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment(Fragment, int)`.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()`
`View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` Create a new instance of a Fragment with the given class name.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`onActivityCreated(Bundle savedInstanceState)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Receive the result from a previous call to `startActivityForResult(Intent, int)`.
`void`	`onAttach(Activity activity)` This method was deprecated in API level 23. Use `onAttach(Context)` instead.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` Called when a fragment is attached as a child of this fragment.
`void`	`onConfigurationChanged(Configuration newConfig)` Called by the system when the device configuration changes while your component is running.
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Activity's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 12. Use `onInflate(Context, AttributeSet, Bundle)` instead.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method was deprecated in API level 23. Use `onInflate(Context, AttributeSet, Bundle)` instead.
`void`	`onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Screen's standard options menu to be displayed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` Callback for the result from requesting permissions.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onTrimMemory(int level)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` Requests permissions to be granted to this application.
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void`	`setEnterTransition(Transition transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void`	`setExitTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void`	`setHasOptionsMenu(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(Transition transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
`void`	`setReturnTransition(Transition transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void`	`setSharedElementEnterTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Transition transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` Optional target for this fragment.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` Set a hint to the system about whether this fragment's UI is currently visible to the user.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale for requesting a permission.
`void`	`startActivity(Intent intent)` Call `startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Call `startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)` from the fragment's containing Activity.
`String`	`toString()` Returns a string representation of the object.
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.content.ComponentCallbacks

Public constructors

SearchFragment

SearchFragment ()

Public methods

createArgs

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

Parameters
`args`	`Bundle`
`query`	`String`
`title`	`String`

Returns
`Bundle`

createArgs

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

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

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

Drawable getBadgeDrawable ()

Returns the badge drawable in the search bar.

Returns
`Drawable`

getRecognizerIntent

Intent getRecognizerIntent ()

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(Intent, boolean).

Returns
`Intent`

getTitle

String getTitle ()

Returns the title set in the search bar.

Returns
`String`

newInstance

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

void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle), but is not called if the fragment instance is retained across Activity re-creation (see setRetainInstance(boolean)).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see onActivityCreated(Bundle).

If your app's targetSdkVersion is 23 or lower, child fragments being restored from the savedInstanceState are restored after onCreate returns. When targeting N or above and running on an N or newer platform version they are restored by Fragment.onCreate.

Parameters
`savedInstanceState`	`Bundle`: If the fragment is being re-created from a previous saved state, this is the state.

onCreateView

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

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between onCreate(Bundle) and onActivityCreated(Bundle).

If you return a View from here, you will later be called in onDestroyView() when the view is being released.

Parameters
`inflater`	`LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`container`	`ViewGroup`: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View`	Return the View for the fragment's UI, or null.

onDestroy

void onDestroy ()

Called when the fragment is no longer in use. This is called after onStop() and before onDetach().

onPause

void onPause ()

Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle.

onRequestPermissionsResult

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

Callback for the result from requesting permissions. This method is invoked for every call on requestPermissions(String[], int).

Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.

Parameters
`requestCode`	`int`: The request code passed in `requestPermissions(String[], int)`.
`permissions`	`String`: The requested permissions. Never null.
`grantResults`	`int`: The grant results for the corresponding permissions which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED`. Never null.

onResume

void onResume ()

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onStart

void onStart ()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

setBadgeDrawable

void setBadgeDrawable (Drawable drawable)

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

Parameters
`drawable`	`Drawable`

setOnItemViewClickedListener

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

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.

setSearchQuery

void setSearchQuery (Intent intent, 
                boolean submit)

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

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.

setSearchResultProvider

void setSearchResultProvider (SearchFragment.SearchResultProvider searchResultProvider)

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

Parameters
`searchResultProvider`	`SearchFragment.SearchResultProvider`

setSpeechRecognitionCallback

void setSpeechRecognitionCallback (SpeechRecognitionCallback callback)

Sets this callback to have the fragment pass speech recognition requests to the activity rather than using an internal recognizer.

Parameters
`callback`	`SpeechRecognitionCallback`

setTitle

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

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.

Most visited

Recently visited

Results for

SearchFragment

Summary

Nested classes

Inherited XML attributes

Inherited constants

Public constructors

Public methods

Inherited methods

Public constructors

SearchFragment

Public methods

createArgs

createArgs

displayCompletions

displayCompletions

getBadgeDrawable

getRecognizerIntent

getTitle

newInstance

onCreate

onCreateView

onDestroy

onPause

onRequestPermissionsResult

onResume

onStart

setBadgeDrawable

setOnItemViewClickedListener

setOnItemViewSelectedListener

setSearchQuery

setSearchQuery

setSearchResultProvider

setSpeechRecognitionCallback

setTitle

startRecognition