AutocompleteSupportFragment

public class AutocompleteSupportFragment extends Fragment

Implements a fragment that presents a search box button to the user, which presents a search box UI when clicked. As the user types, the autocomplete service returns Place predictions for places such as businesses, addresses and points of interest. When the user selects a place, the autocomplete service returns the response via the PlaceSelectionListener.

Inherited Field Summary

From class android.support.v4.app.Fragment

public String

mPreviousWho

Public Constructor Summary

AutocompleteSupportFragment()

Public Method Summary

static AutocompleteSupportFragment	newInstance() Create a new autocomplete fragment with default config.
void	onActivityResult(int requestCode, int resultCode, Intent data)
void	onCreate(Bundle savedInstanceState)
void	onResume()
void	onSaveInstanceState(Bundle bundle)
void	onViewCreated(View view, Bundle savedInstanceState)
AutocompleteSupportFragment	setActivityMode(AutocompleteActivityMode mode) Sets the type of activity to open when a user initiates a query.
AutocompleteSupportFragment	setCountries(String... countries) See setCountries(List).
AutocompleteSupportFragment	setCountries(List<String> countries) Sets countries to restrict results to.
AutocompleteSupportFragment	setCountry(String country) This method is deprecated. Use setCountries(List) instead.
AutocompleteSupportFragment	setHint(CharSequence hint) Sets the hint text to display in the search input field when there is no text entered.
AutocompleteSupportFragment	setLocationBias(LocationBias locationBias) Biases the autocomplete results to a particular area.
AutocompleteSupportFragment	setLocationRestriction(LocationRestriction locationRestriction) Restricts the autocomplete results to a particular area.
AutocompleteSupportFragment	setOnPlaceSelectedListener(PlaceSelectionListener listener) Sets a listener that will be notified when a place is selected.
AutocompleteSupportFragment	setPlaceFields(List<Place.Field> placeFields) Sets the desired fields of the Place object returned from selecting an autocomplete result.
AutocompleteSupportFragment	setRegionCode(String regionCode) Sets the unicode country/region code (CLDR) of the location where the request is coming from.
AutocompleteSupportFragment	setText(CharSequence text) Sets the text to display in the search input field.
AutocompleteSupportFragment	setTypeFilter(TypeFilter typeFilter) This method is deprecated. Use setTypesFilter(List).
AutocompleteSupportFragment	setTypesFilter(List<String> placeTypes) Sets the filter that restricts the type(s) of results returned from the response.

Inherited Method Summary

From class android.support.v4.app.Fragment

void	dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)
final boolean	equals(Object arg0)
final FragmentActivity	getActivity()
boolean	getAllowEnterTransitionOverlap()
boolean	getAllowReturnTransitionOverlap()
final Bundle	getArguments()
final FragmentManager	getChildFragmentManager()
Context	getContext()
CreationExtras	getDefaultViewModelCreationExtras()
ViewModelProvider.Factory	getDefaultViewModelProviderFactory()
Object	getEnterTransition()
Object	getExitTransition()
final FragmentManager	getFragmentManager()
final Object	getHost()
final int	getId()
LayoutInflater	getLayoutInflater(Bundle arg0)
final LayoutInflater	getLayoutInflater()
Lifecycle	getLifecycle()
LoaderManager	getLoaderManager()
final Fragment	getParentFragment()
final FragmentManager	getParentFragmentManager()
Object	getReenterTransition()
final Resources	getResources()
final boolean	getRetainInstance()
Object	getReturnTransition()
final SavedStateRegistry	getSavedStateRegistry()
Object	getSharedElementEnterTransition()
Object	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()
LifecycleOwner	getViewLifecycleOwner()
LiveData<LifecycleOwner>	getViewLifecycleOwnerLiveData()
ViewModelStore	getViewModelStore()
final boolean	hasOptionsMenu()
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	isMenuVisible()
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)
Animation	onCreateAnimation(int arg0, boolean arg1, int arg2)
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(Activity arg0, AttributeSet arg1, Bundle arg2)
void	onInflate(Context arg0, AttributeSet arg1, Bundle arg2)
void	onLowMemory()
void	onMultiWindowModeChanged(boolean arg0)
boolean	onOptionsItemSelected(MenuItem arg0)
void	onOptionsMenuClosed(Menu arg0)
void	onPause()
void	onPictureInPictureModeChanged(boolean arg0)
void	onPrepareOptionsMenu(Menu arg0)
void	onPrimaryNavigationFragmentChanged(boolean arg0)
void	onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2)
void	onResume()
void	onSaveInstanceState(Bundle arg0)
void	onStart()
void	onStop()
void	onViewCreated(View arg0, Bundle arg1)
void	onViewStateRestored(Bundle arg0)
void	postponeEnterTransition()
final void	postponeEnterTransition(long arg0, TimeUnit arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultCallback<O> arg1)
final <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultRegistry arg1, ActivityResultCallback<O> arg2)
void	registerForContextMenu(View arg0)
final void	requestPermissions(String[] arg0, int arg1)
final FragmentActivity	requireActivity()
final Bundle	requireArguments()
final Context	requireContext()
final FragmentManager	requireFragmentManager()
final Object	requireHost()
final Fragment	requireParentFragment()
final View	requireView()
void	setAllowEnterTransitionOverlap(boolean arg0)
void	setAllowReturnTransitionOverlap(boolean arg0)
void	setArguments(Bundle arg0)
void	setEnterSharedElementCallback(SharedElementCallback arg0)
void	setEnterTransition(Object arg0)
void	setExitSharedElementCallback(SharedElementCallback arg0)
void	setExitTransition(Object arg0)
void	setHasOptionsMenu(boolean arg0)
void	setInitialSavedState(Fragment.SavedState arg0)
void	setMenuVisibility(boolean arg0)
void	setReenterTransition(Object arg0)
void	setRetainInstance(boolean arg0)
void	setReturnTransition(Object arg0)
void	setSharedElementEnterTransition(Object arg0)
void	setSharedElementReturnTransition(Object 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

boolean	equals(Object arg0)
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.ComponentCallbacks

abstract void	onConfigurationChanged(Configuration arg0)
abstract void	onLowMemory()

From interface android.view.View.OnCreateContextMenuListener

abstract void

onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

From interface androidx.lifecycle.LifecycleOwner

abstract Lifecycle

getLifecycle()

From interface androidx.lifecycle.ViewModelStoreOwner

abstract ViewModelStore

getViewModelStore()

From interface androidx.lifecycle.HasDefaultViewModelProviderFactory

CreationExtras	getDefaultViewModelCreationExtras()
abstract ViewModelProvider.Factory	getDefaultViewModelProviderFactory()

From interface androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry

getSavedStateRegistry()

From interface androidx.activity.result.ActivityResultCaller

abstract <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultCallback<O> arg1)
abstract <I, O> ActivityResultLauncher<I>	registerForActivityResult(ActivityResultContract<I, O> arg0, ActivityResultRegistry arg1, ActivityResultCallback<O> arg2)

Public Constructors

public AutocompleteSupportFragment ()

Public Methods

public static AutocompleteSupportFragment newInstance ()

Create a new autocomplete fragment with default config.

public void onActivityResult (int requestCode, int resultCode, Intent data)

Parameters

requestCode
resultCode
data

public void onCreate (Bundle savedInstanceState)

Parameters

savedInstanceState

public void onResume ()

public void onSaveInstanceState (Bundle bundle)

Parameters

bundle

public void onViewCreated (View view, Bundle savedInstanceState)

Parameters

view
savedInstanceState

public AutocompleteSupportFragment setActivityMode (AutocompleteActivityMode mode)

Sets the type of activity to open when a user initiates a query.

Parameters

mode

public AutocompleteSupportFragment setCountries (String... countries)

See setCountries(List).

Parameters

countries

public AutocompleteSupportFragment setCountries (List<String> countries)

Sets countries to restrict results to.

This must be a list of ISO 3166-1 Alpha-2 country codes (case insensitive). If no countries are set, no country filtering will take place.

This will override values set with setCountry(String).

Up to five countries are supported. See the components parameter here.

Parameters

countries

public AutocompleteSupportFragment setCountry (String country)

This method is deprecated.
Use setCountries(List) instead.

See setCountries(String...) for details.

This will override countries set with setCountries(String...).

Parameters

country

public AutocompleteSupportFragment setHint (CharSequence hint)

Sets the hint text to display in the search input field when there is no text entered.

If the hint is unset or explicitly set to null, the hint text will be set to the default value.

Parameters

hint

public AutocompleteSupportFragment setLocationBias (LocationBias locationBias)

Biases the autocomplete results to a particular area.

Parameters

locationBias

public AutocompleteSupportFragment setLocationRestriction (LocationRestriction locationRestriction)

Restricts the autocomplete results to a particular area.

Parameters

locationRestriction

public AutocompleteSupportFragment setOnPlaceSelectedListener (PlaceSelectionListener listener)

Sets a listener that will be notified when a place is selected.

Parameters

listener	The listener that should be notified.

public AutocompleteSupportFragment setPlaceFields (List<Place.Field> placeFields)

Sets the desired fields of the Place object returned from selecting an autocomplete result.

Read more about Place Data Fields.

Parameters

placeFields

public AutocompleteSupportFragment setRegionCode (String regionCode)

Sets the unicode country/region code (CLDR) of the location where the request is coming from.

The region code field is only supported by Places API (New). Please enable your API key for the Places API (New) in the Google Cloud Console to use region code. If you do not enable your API key for the Places API (New), the region code will not affect the results.

Parameters

regionCode

public AutocompleteSupportFragment setText (CharSequence text)

Sets the text to display in the search input field.

Parameters

text

public AutocompleteSupportFragment setTypeFilter (TypeFilter typeFilter)

This method is deprecated.
Use setTypesFilter(List).

Restricts the autocomplete results to the given place type.

Parameters

typeFilter

public AutocompleteSupportFragment setTypesFilter (List<String> placeTypes)

Sets the filter that restricts the type(s) of results returned from the response.

Up to 5 place types are supported. A comprehensive list of the supported types can be found in PlaceTypes. The type collections specified in table 3 must be passed in as solo entries and cannot be combined with any other entries from table 1 or 2.

This will override setTypeFilter(TypeFilter) if both are used.

Parameters

placeTypes