PaneTemplate

@CarProtocol
class PaneTemplate : 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

A builder of PaneTemplate.

Public functions
Boolean
equals(other: Any?)
ActionStrip?

This function is deprecated.

use getEndHeaderActions instead.
Header?

Returns the Header to display in this template.
Action?

This function is deprecated.

use getStartHeaderAction instead.
Pane

Returns the Pane to display in the template.
CarText?

This function is deprecated.

use getTitle instead.
Int
String

Public functions

equals

fun equals(other: Any?): Boolean

getActionStrip

Added in 1.0.0
Deprecated in 1.7.0-alpha01
fun getActionStrip(): ActionStrip?

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

See also
setActionStrip

getHeader

Added in 1.7.0-alpha01
fun getHeader(): Header?

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
fun getHeaderAction(): Action?

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
fun getPane(): Pane

Returns the Pane to display in the template.

See also
Builder

getTitle

Added in 1.0.0
Deprecated in 1.7.0-alpha01
fun getTitle(): CarText?

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

See also
setTitle

hashCode

fun hashCode(): Int

toString

fun toString(): String