PlaceSearchFragment

public final class PlaceSearchFragment extends Fragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	com.google.android.libraries.places.widget.PlaceSearchFragment

A fragment displays a list of places generated from either a text search or a nearby search request.

Summary

Nested types
`public enum PlaceSearchFragment.Content extends Enum` Enumeration of all content types supported by `PlaceSearchFragment`.

Public fields
`static final @NonNull List<@NonNull PlaceSearchFragment.Content>`	`ALL_CONTENT` List containing all `Content` supported by the widget.
`static final @NonNull List<@NonNull PlaceSearchFragment.Content>`	`STANDARD_CONTENT` A list containing standard `Content` for the widget.

Public constructors
`PlaceSearchFragment()`

Public methods
`final void`	`configureFromSearchByTextRequest(@NonNull SearchByTextRequest request)` Configures the fragment from a `SearchByTextRequest`.
`final void`	`configureFromSearchNearbyRequest(@NonNull SearchNearbyRequest request)` Configures the fragment from a `SearchNearbyRequest`.
`final @NonNull AttributionPosition`	`getAttributionPosition()` The position of the Google Maps attribution.
`final @NonNull MediaSize`	`getMediaSize()` The size of the media in the vertical fragment view.
`final boolean`	`getPreferTruncation()` Whether content is truncated to fit into a single line.
`final boolean`	`getSelectable()` Whether the place search results are selectable.
`static final @NonNull PlaceSearchFragment`	`newInstance( @NonNull List<@NonNull PlaceSearchFragment.Content> content, @NonNull Orientation orientation, @StyleRes int theme )` Creates a new instance of the `PlaceSearchFragment`.
`final void`	`registerListener(@NonNull PlaceSearchFragmentListener listener)` Registers the listener to receive callbacks when the places result is loaded or an error occurs, or when a place is selected if the fragment is configured to be selectable.
`final void`	`setAttributionPosition(@NonNull AttributionPosition attributionPosition)` The position of the Google Maps attribution.
`final void`	`setMediaSize(@NonNull MediaSize mediaSize)` The size of the media in the vertical fragment view.
`final void`	`setPreferTruncation(boolean preferTruncation)` Whether content is truncated to fit into a single line.
`final void`	`setSelectable(boolean selectable)` Whether the place search results are selectable.
`final void`	`unregisterListener()` Unregisters the listener to not receive callbacks when the places result is loaded or an error occurs, or when a place is selected if the fragment is configured to be selectable.

Inherited fields

From androidx.fragment.app.Fragment

final @Nullable String

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
mPreviousWho

Inherited methods

From androidx.fragment.app.Fragment

`void`	`dump( @NonNull String p0, @Nullable FileDescriptor p1, @NonNull PrintWriter p2, @Nullable String[] p3 )`
`final boolean`	`equals(@Nullable Object other)`
`final @Nullable FragmentActivity`	`getActivity()`
`boolean`	`getAllowEnterTransitionOverlap()`
`boolean`	`getAllowReturnTransitionOverlap()`
`final @Nullable Bundle`	`getArguments()`
`final @NonNull FragmentManager`	`getChildFragmentManager()`
`@Nullable Context`	`getContext()`
`@NonNull CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()`
`@NonNull ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`@Nullable Object`	`getEnterTransition()`
`@Nullable Object`	`getExitTransition()`
`final @Nullable FragmentManager`	`getFragmentManager()` This method is deprecated. Deprecated in Java
`final @Nullable Object`	`getHost()`
`final int`	`getId()`
`final @NonNull LayoutInflater`	`getLayoutInflater()`
`@NonNull LayoutInflater`	`@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) getLayoutInflater(@Nullable Bundle p0)` This method is deprecated. Deprecated in Java
`@NonNull Lifecycle`	`getLifecycle()`
`@NonNull LoaderManager`	`getLoaderManager()` This method is deprecated. Deprecated in Java
`final @Nullable Fragment`	`getParentFragment()`
`final @NonNull FragmentManager`	`getParentFragmentManager()`
`@Nullable Object`	`getReenterTransition()`
`final @NonNull Resources`	`getResources()`
`final boolean`	`getRetainInstance()` This method is deprecated. Deprecated in Java
`@Nullable Object`	`getReturnTransition()`
`final @NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`@Nullable Object`	`getSharedElementEnterTransition()`
`@Nullable Object`	`getSharedElementReturnTransition()`
`final @NonNull String`	`getString(@StringRes int p0)`
`final @NonNull String`	`getString(@StringRes int p0, @NonNull Object p1)`
`final @Nullable String`	`getTag()`
`final @Nullable Fragment`	`getTargetFragment()` This method is deprecated. Deprecated in Java
`final int`	`getTargetRequestCode()` This method is deprecated. Deprecated in Java
`final @NonNull CharSequence`	`getText(@StringRes int p0)`
`boolean`	`getUserVisibleHint()` This method is deprecated. Deprecated in Java
`@Nullable View`	`getView()`
`@NonNull LifecycleOwner`	`@MainThread getViewLifecycleOwner()`
`@NonNull LiveData<@NonNull LifecycleOwner>`	`getViewLifecycleOwnerLiveData()`
`@NonNull ViewModelStore`	`getViewModelStore()`
`final boolean`	`@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) hasOptionsMenu()`
`final int`	`hashCode()`
`final boolean`	`isAdded()`
`final boolean`	`isDetached()`
`final boolean`	`isHidden()`
`final boolean`	`isInLayout()`
`final boolean`	`@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) isMenuVisible()`
`final boolean`	`isRemoving()`
`final boolean`	`isResumed()`
`final boolean`	`isStateSaved()`
`final boolean`	`isVisible()`
`void`	`@MainThread @CallSuper onActivityCreated(@Nullable Bundle p0)` This method is deprecated. Deprecated in Java
`void`	`onActivityResult(int p0, int p1, @Nullable Intent p2)` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onAttach(@NonNull Activity p0)` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onAttach(@NonNull Context p0)`
`void`	`@MainThread onAttachFragment(@NonNull Fragment p0)` This method is deprecated. Deprecated in Java
`void`	`@CallSuper onConfigurationChanged(@NonNull Configuration p0)`
`boolean`	`@MainThread onContextItemSelected(@NonNull MenuItem p0)`
`@Nullable Animation`	`@MainThread onCreateAnimation(int p0, boolean p1, int p2)`
`@Nullable Animator`	`@MainThread onCreateAnimator(int p0, boolean p1, int p2)`
`void`	`@MainThread onCreateContextMenu( @NonNull ContextMenu p0, @NonNull View p1, @Nullable ContextMenu.ContextMenuInfo p2 )`
`void`	`@MainThread onCreateOptionsMenu(@NonNull Menu p0, @NonNull MenuInflater p1)` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onDestroy()`
`void`	`@MainThread onDestroyOptionsMenu()` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onDestroyView()`
`void`	`@MainThread @CallSuper onDetach()`
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle p0)`
`void`	`@MainThread onHiddenChanged(boolean p0)`
`void`	`@UiThread @CallSuper onInflate(@NonNull Activity p0, @NonNull AttributeSet p1, @Nullable Bundle p2)` This method is deprecated. Deprecated in Java
`void`	`@UiThread @CallSuper onInflate(@NonNull Context p0, @NonNull AttributeSet p1, @Nullable Bundle p2)`
`void`	`@MainThread @CallSuper onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean p0)`
`boolean`	`@MainThread onOptionsItemSelected(@NonNull MenuItem p0)` This method is deprecated. Deprecated in Java
`void`	`@MainThread onOptionsMenuClosed(@NonNull Menu p0)` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onPause()`
`void`	`onPictureInPictureModeChanged(boolean p0)`
`void`	`@MainThread onPrepareOptionsMenu(@NonNull Menu p0)` This method is deprecated. Deprecated in Java
`void`	`@MainThread onPrimaryNavigationFragmentChanged(boolean p0)`
`void`	`onRequestPermissionsResult(int p0, @NonNull String[] p1, @NonNull int[] p2)` This method is deprecated. Deprecated in Java
`void`	`@MainThread @CallSuper onResume()`
`void`	`@MainThread @CallSuper onStart()`
`void`	`@MainThread @CallSuper onStop()`
`void`	`@MainThread @CallSuper onViewStateRestored(@Nullable Bundle p0)`
`void`	`postponeEnterTransition()`
`final void`	`postponeEnterTransition(long p0, @NonNull TimeUnit p1)`
`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultCallback<@NonNull O> callback )`
`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultRegistry registry, @NonNull ActivityResultCallback<@NonNull O> callback )`
`void`	`registerForContextMenu(@NonNull View p0)`
`final void`	`requestPermissions(@NonNull String[] p0, int p1)` This method is deprecated. Deprecated in Java
`final @NonNull FragmentActivity`	`requireActivity()`
`final @NonNull Bundle`	`requireArguments()`
`final @NonNull Context`	`requireContext()`
`final @NonNull FragmentManager`	`requireFragmentManager()` This method is deprecated. Deprecated in Java
`final @NonNull Object`	`requireHost()`
`final @NonNull Fragment`	`requireParentFragment()`
`final @NonNull View`	`requireView()`
`void`	`setAllowEnterTransitionOverlap(boolean p0)`
`void`	`setAllowReturnTransitionOverlap(boolean p0)`
`void`	`setArguments(@Nullable Bundle p0)`
`void`	`setEnterSharedElementCallback(@Nullable SharedElementCallback p0)`
`void`	`setEnterTransition(@Nullable Object p0)`
`void`	`setExitSharedElementCallback(@Nullable SharedElementCallback p0)`
`void`	`setExitTransition(@Nullable Object p0)`
`void`	`setHasOptionsMenu(boolean p0)` This method is deprecated. Deprecated in Java
`void`	`setInitialSavedState(@Nullable Fragment.SavedState p0)`
`void`	`setMenuVisibility(boolean p0)`
`void`	`setReenterTransition(@Nullable Object p0)`
`void`	`setRetainInstance(boolean p0)` This method is deprecated. Deprecated in Java
`void`	`setReturnTransition(@Nullable Object p0)`
`void`	`setSharedElementEnterTransition(@Nullable Object p0)`
`void`	`setSharedElementReturnTransition(@Nullable Object p0)`
`void`	`setTargetFragment(@Nullable Fragment p0, int p1)` This method is deprecated. Deprecated in Java
`void`	`setUserVisibleHint(boolean p0)` This method is deprecated. Deprecated in Java
`boolean`	`shouldShowRequestPermissionRationale(@NonNull String p0)`
`void`	`startActivity(@NonNull Intent p0)`
`void`	`startActivity(@NonNull Intent p0, @Nullable Bundle p1)`
`void`	`startActivityForResult(@NonNull Intent p0, int p1)` This method is deprecated. Deprecated in Java
`void`	`startActivityForResult(@NonNull Intent p0, int p1, @Nullable Bundle p2)` This method is deprecated. Deprecated in Java
`void`	`startIntentSenderForResult( @NonNull IntentSender p0, int p1, @Nullable Intent p2, int p3, int p4, int p5, @Nullable Bundle p6 )` This method is deprecated. Deprecated in Java
`void`	`startPostponedEnterTransition()`
`@NonNull String`	`toString()`
`void`	`unregisterForContextMenu(@NonNull View p0)`

Public fields

ALL_CONTENT

public static final @NonNull List<@NonNull PlaceSearchFragment.Content> ALL_CONTENT

List containing all Content supported by the widget. This can be passed into the widget's newInstance function to show all content on the widget.

STANDARD_CONTENT

public static final @NonNull List<@NonNull PlaceSearchFragment.Content> STANDARD_CONTENT

A list containing standard Content for the widget. This can be passed into the widget's newInstance function to show standard content on the widget.

Public constructors

PlaceSearchFragment

public PlaceSearchFragment()

Public methods

configureFromSearchByTextRequest

public final void configureFromSearchByTextRequest(@NonNull SearchByTextRequest request)

Configures the fragment from a SearchByTextRequest.

SearchByTextRequest.getPlaceFields will be overridden by fields associated with Content. Only the requested content will be fetched.
PlaceSearchFragment does not support routing summaries, therefore SearchByTextRequest.isRoutingSummariesIncluded will be ignored.

configureFromSearchNearbyRequest

public final void configureFromSearchNearbyRequest(@NonNull SearchNearbyRequest request)

Configures the fragment from a SearchNearbyRequest. SearchNearbyRequest.getPlaceFields is

SearchNearbyRequest.getPlaceFields will be overridden by fields associated with Content. Only the requested content will be fetched.
PlaceSearchFragment does not support routing summaries, therefore SearchNearbyRequest.isRoutingSummariesIncluded will be ignored.

getAttributionPosition

public final @NonNull AttributionPosition getAttributionPosition()

The position of the Google Maps attribution.

getMediaSize

public final @NonNull MediaSize getMediaSize()

The size of the media in the vertical fragment view.

getPreferTruncation

public final boolean getPreferTruncation()

Whether content is truncated to fit into a single line. Not all content may be truncatable to fit into a single line (like ratings).

getSelectable

public final boolean getSelectable()

Whether the place search results are selectable.

public static final @NonNull PlaceSearchFragment newInstance(
    @NonNull List<@NonNull PlaceSearchFragment.Content> content,
    @NonNull Orientation orientation,
    @StyleRes int theme
)

Creates a new instance of the PlaceSearchFragment.

Parameters
`@NonNull List<@NonNull PlaceSearchFragment.Content> content`	a list of `Content` values to be shown on the widget.
`@NonNull Orientation orientation`	the `Orientation` to show the widget in.
`@StyleRes int theme`	a theme inherits from R.style.PlacesMaterialTheme and overrides theme attributes to customize the widget appearance.

public final void registerListener(@NonNull PlaceSearchFragmentListener listener)

Registers the listener to receive callbacks when the places result is loaded or an error occurs, or when a place is selected if the fragment is configured to be selectable.

public final void setAttributionPosition(@NonNull AttributionPosition attributionPosition)

The position of the Google Maps attribution.

public final void setMediaSize(@NonNull MediaSize mediaSize)

The size of the media in the vertical fragment view.

setPreferTruncation

public final void setPreferTruncation(boolean preferTruncation)

Whether content is truncated to fit into a single line. Not all content may be truncatable to fit into a single line (like ratings).

setSelectable

public final void setSelectable(boolean selectable)

Whether the place search results are selectable.

unregisterListener

public final void unregisterListener()

Unregisters the listener to not receive callbacks when the places result is loaded or an error occurs, or when a place is selected if the fragment is configured to be selectable.

PlaceSearchFragment

Summary

Nested types

Public fields

Public constructors

Public methods

Inherited fields

Inherited methods

Public fields

ALL_CONTENT

STANDARD_CONTENT

Public constructors

PlaceSearchFragment

Public methods

configureFromSearchByTextRequest

configureFromSearchNearbyRequest

getAttributionPosition

getMediaSize

getPreferTruncation

getSelectable

newInstance

registerListener

setAttributionPosition

setMediaSize

setPreferTruncation

setSelectable

unregisterListener