Summary: Nested Classes | Methods | Inherited Methods

PlaceListNavigationTemplate

Kotlin |Java

public final class PlaceListNavigationTemplate
extends Object implements Template

java.lang.Object
↳	androidx.car.app.navigation.model.PlaceListNavigationTemplate

---

A template that supports showing a list of places alongside a custom drawn map.

The template itself does not expose a drawing surface. In order to draw on the canvas, use AppManager.setSurfaceCallback(SurfaceCallback).

Template Restrictions

In regards to template refreshes, as described in Screen.onGetTemplate(), this template is considered a refresh of a previous one if:

• The template title has not changed, and
• The previous template is in a loading state (see PlaceListNavigationTemplate.Builder.setLoading(boolean), or the number of rows and the string contents (title, texts, not counting spans) of each row between the previous and new ItemLists have not changed.

In order to use this template your car app MUST declare that it uses the androidx.car.app.NAVIGATION_TEMPLATES permission in the manifest.

Summary

Nested classes
class	PlaceListNavigationTemplate.Builder A builder of PlaceListNavigationTemplate.

Public methods
boolean	equals(Object other)
ActionStrip	getActionStrip() Returns the ActionStrip for this template or null if not set.
Action	getHeaderAction() Returns the Action that is set to be displayed in the header of the template or null if not set.
ItemList	getItemList() Returns the list of items to display alongside the map or null if the list is not set.
CarText	getTitle() Returns the title of the template or null if not set.
int	hashCode()
boolean	isLoading() Returns whether the template is loading.
String	toString()

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() 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()

Public methods

equals

public boolean equals (Object other)

Parameters
other	Object

Returns
boolean

getActionStrip

public ActionStrip getActionStrip ()

Returns the ActionStrip for this template or null if not set.

Returns
ActionStrip

See also:

• PlaceListNavigationTemplate.Builder.setActionStrip(ActionStrip)

getHeaderAction

public Action getHeaderAction ()

Returns the Action that is set to be displayed in the header of the template or null if not set.

Returns
Action

See also:

• PlaceListNavigationTemplate.Builder.setHeaderAction(Action)

getItemList

public ItemList getItemList ()

Returns the list of items to display alongside the map or null if the list is not set.

Returns
ItemList

See also:

• PlaceListNavigationTemplate.Builder.setItemList(ItemList)

getTitle

public CarText getTitle ()

Returns the title of the template or null if not set.

Returns
CarText

See also:

• PlaceListNavigationTemplate.Builder.setTitle(CharSequence)

hashCode

public int hashCode ()

Returns
int

isLoading

public boolean isLoading ()

Returns whether the template is loading.

Returns
boolean

See also:

• PlaceListNavigationTemplate.Builder.setLoading(boolean)

toString

public String toString ()

Returns
String