AdvancedPlaceListFragment

public final class AdvancedPlaceListFragment extends Fragment implements PlaceActionController

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

---

A fragment that displays a list of places.

This advanced fragment supports configuring custom action buttons and media search.

Summary

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

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

Public constructors
AdvancedPlaceListFragment()

Public methods
final void	@MainThread applySearchMediaOptions(SearchMediaOptions options) Applies media search options to the fragment.
final void	configureFromCoordinates(@NonNull List<@NonNull LatLng> coordinates) Loads a list of places identified by their coordinates.
final void	configureFromPlaceIds(@NonNull List<@NonNull String> placeIds) Loads a list of places identified by their Place IDs.
final void	configureFromResourceNames(@NonNull List<@NonNull String> resourceNames) Loads a list of places identified by their Resource Names.
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 list results are selectable.
static final @NonNull AdvancedPlaceListFragment	newInstance(     @NonNull List<@NonNull AdvancedPlaceListFragment.Content> content,     @NonNull Orientation orientation,     @StyleRes int theme ) Creates a new instance of the AdvancedPlaceListFragment.
final void	registerListener(@NonNull PlaceListFragmentListener 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	setMediaResultListener(@NonNull MediaResultListener listener) Sets a listener to be invoked when internal photos are loaded or fail to load.
final void	setMediaSize(@NonNull MediaSize mediaSize) The size of the media in the vertical fragment view.
void	@MainThread setPlaceActionProvider(PlaceActionProvider placeActionProvider) Sets the PlaceActionProvider to be used by the widget.
final void	setPreferTruncation(boolean preferTruncation) Whether content is truncated to fit into a single line.
final void	setSelectable(boolean selectable) Whether the place list 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 addOnContextAvailableListener(     @NonNull OnContextAvailableListener listener ) 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 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 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 onViewStateRestored(@Nullable Bundle p0) @Nullable Context peekAvailableContext() 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) void removeOnContextAvailableListener(     @NonNull OnContextAvailableListener listener ) 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 AdvancedPlaceListFragment.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 AdvancedPlaceListFragment.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

AdvancedPlaceListFragment

public AdvancedPlaceListFragment()

Public methods

applySearchMediaOptions

@MainThread
public final void applySearchMediaOptions(SearchMediaOptions options)

Applies media search options to the fragment.

Parameters
SearchMediaOptions options	the SearchMediaOptions to apply.

configureFromCoordinates

public final void configureFromCoordinates(@NonNull List<@NonNull LatLng> coordinates)

Loads a list of places identified by their coordinates.

configureFromPlaceIds

public final void configureFromPlaceIds(@NonNull List<@NonNull String> placeIds)

Loads a list of places identified by their Place IDs.

configureFromResourceNames

public final void configureFromResourceNames(@NonNull List<@NonNull String> resourceNames)

Loads a list of places identified by their Resource Names.

getAttributionPosition

public final @NonNull AttributionPosition getAttributionPosition()

The position of the Google Maps attribution. This is necessary because a developer can set attributionPosition immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

getMediaSize

public final @NonNull MediaSize getMediaSize()

The size of the media in the vertical fragment view. This is necessary because a developer can set mediaSize immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

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

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

getSelectable

public final boolean getSelectable()

Whether the place list results are selectable. This is necessary because a developer can set selectable immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

newInstance

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

Creates a new instance of the AdvancedPlaceListFragment.

Parameters
@NonNull List<@NonNull AdvancedPlaceListFragment.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.

registerListener

public final void registerListener(@NonNull PlaceListFragmentListener 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. Caller is responsible to re-register the listener on configuration changes.

setAttributionPosition

public final void setAttributionPosition(@NonNull AttributionPosition attributionPosition)

The position of the Google Maps attribution. This is necessary because a developer can set attributionPosition immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

setMediaResultListener

public final void setMediaResultListener(@NonNull MediaResultListener listener)

Sets a listener to be invoked when internal photos are loaded or fail to load. Caller is responsible to re-set the listener on configuration changes.

Parameters
@NonNull MediaResultListener listener	the MediaResultListener to be invoked.

setMediaSize

public final void setMediaSize(@NonNull MediaSize mediaSize)

The size of the media in the vertical fragment view. This is necessary because a developer can set mediaSize immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

setPlaceActionProvider

@MainThread
public void setPlaceActionProvider(PlaceActionProvider placeActionProvider)

Sets the PlaceActionProvider to be used by the widget.

The provider is responsible for providing the actions to be displayed and notifying the widget of any changes.

Parameters
PlaceActionProvider placeActionProvider	The provider to set.

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

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

setSelectable

public final void setSelectable(boolean selectable)

Whether the place list results are selectable. This is necessary because a developer can set selectable immediately after the fragment is created, but before onViewCreated is called (where the controller is initialized).

Once the controller is created, it is the source of truth. This copy is also updated to handle config changes.

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.