SectionHeader


@CarProtocol
@ExperimentalCarApi
@RequiresCarApi(value = 9)
class SectionHeader


Represents a header for a section within a SectionedItemTemplate.

A section header must include a title. It can also include a start icon, an end icon, and can handle click events.

Summary

Nested types

A builder of SectionHeader.

Constants

const Int

Represents a large sized image to be displayed in the section header.

const Int

Represents a small icon to be displayed in the section header.

Public functions

Boolean
equals(other: Any?)
CarIcon?

Returns the end icon of the header, or null if none is set.

OnClickDelegate?

Returns the OnClickDelegate to handle click events on the header, or null if the header is not clickable.

CarIcon?

Returns the start icon of the header, or null if none is set.

Int

Returns the type of the start icon.

CarText?

Returns the subtitle of the header, or null if none is set.

CarText

Returns the title of the header.

Int
String

Constants

IMAGE_TYPE_LARGE

Added in 1.8.0
const val IMAGE_TYPE_LARGE = 2: Int

Represents a large sized image to be displayed in the section header.

IMAGE_TYPE_SMALL

Added in 1.8.0
const val IMAGE_TYPE_SMALL = 1: Int

Represents a small icon to be displayed in the section header.

Public functions

equals

fun equals(other: Any?): Boolean

getEndIcon

Added in 1.8.0
fun getEndIcon(): CarIcon?

Returns the end icon of the header, or null if none is set.

See also
setEndIcon

getOnClickDelegate

Added in 1.8.0
fun getOnClickDelegate(): OnClickDelegate?

Returns the OnClickDelegate to handle click events on the header, or null if the header is not clickable.

getStartIcon

Added in 1.8.0
fun getStartIcon(): CarIcon?

Returns the start icon of the header, or null if none is set.

getStartIconType

Added in 1.8.0
fun getStartIconType(): Int

Returns the type of the start icon.

See also
setStartIcon

getSubtitle

Added in 1.9.0-alpha01
fun getSubtitle(): CarText?

Returns the subtitle of the header, or null if none is set.

getTitle

Added in 1.8.0
fun getTitle(): CarText

Returns the title of the header.

hashCode

fun hashCode(): Int

toString

fun toString(): String