PaneTemplate

@CarProtocol
public final class PaneTemplate implements Template

A template that displays a Pane.

Template Restrictions In regards to template refreshes, as described in onGetTemplate, this template is considered a refresh of a previous one if:
  • The previous template is in a loading state (see setLoading, or
  • The template title has not changed, and the number of rows and the title (not counting spans) of each row between the previous and new Panes have not changed.

Summary

Nested types
public final class PaneTemplate.Builder

A builder of PaneTemplate.

Public methods
boolean
@Nullable ActionStrip

This method is deprecated.

use getEndHeaderActions instead.
@Nullable Header

Returns the Header to display in this template.
@Nullable Action

This method is deprecated.

use getStartHeaderAction instead.
@NonNull Pane

Returns the Pane to display in the template.
@Nullable CarText

This method is deprecated.

use getTitle instead.
int
@NonNull String

Public methods

equals

public boolean equals(@Nullable Object other)

getActionStrip

Added in 1.0.0
Deprecated in 1.7.0-alpha01
public @Nullable ActionStrip getActionStrip()

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

See also
setActionStrip

getHeader

Added in 1.7.0-alpha01
public @Nullable Header getHeader()

Returns the Header to display in this template.

This method was introduced in API 7, but is backwards compatible even if the client is using API 6 or below.

See also
setHeader

getHeaderAction

Added in 1.0.0
Deprecated in 1.7.0-alpha01
public @Nullable Action getHeaderAction()

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

See also
setHeaderAction

getPane

Added in 1.0.0
public @NonNull Pane getPane()

Returns the Pane to display in the template.

See also
Builder

getTitle

Added in 1.0.0
Deprecated in 1.7.0-alpha01
public @Nullable CarText getTitle()

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

See also
setTitle

hashCode

public int hashCode()

toString

public @NonNull String toString()