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

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

@Nullable Action

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

@NonNull Pane

Returns the Pane to display in the template.

@Nullable CarText

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

int
@NonNull String

Public methods

equals

Added in 1.4.0-rc02
public boolean equals(@Nullable Object other)

getActionStrip

Added in 1.0.0
public @Nullable ActionStrip getActionStrip()

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

See also
setActionStrip

getHeaderAction

Added in 1.0.0
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
public @Nullable CarText getTitle()

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

See also
setTitle

hashCode

Added in 1.4.0-rc02
public int hashCode()

toString

Added in 1.4.0-rc02
public @NonNull String toString()