Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

Row

open class Row
kotlin.Any
   ↳ androidx.leanback.widget.Row

The base class for all rows. A commonly used subclass is the ListRow. Custom subclasses may define other types of rows.

Summary

Public constructors
<init>(id: Long, headerItem: HeaderItem!)

Constructor for a Row.

<init>(headerItem: HeaderItem!)

Constructor for a Row.

Constructor for a Row.

Public methods
Unit
setId(id: Long)

Sets the id for this row.

Unit
setHeaderItem(headerItem: HeaderItem!)

Sets the HeaderItem that represents metadata for the row.

open Boolean

Returns true if this Row can be rendered in a visible row view, false otherwise.

Long

Returns a unique identifier for this row.

HeaderItem!

Returns the HeaderItem that represents metadata for the row.

Public constructors

<init>

Row(id: Long, headerItem: HeaderItem!)

Constructor for a Row.

Parameters
id Long: The id of the row.
headerItem Long: The HeaderItem for this Row, or null if there is no header.

<init>

Row(headerItem: HeaderItem!)

Constructor for a Row.

Parameters
headerItem HeaderItem!: The HeaderItem for this Row, or null if there is no header.

<init>

Row()

Constructor for a Row.

Public methods

setId

fun setId(id: Long): Unit

Sets the id for this row.

Parameters
id Long: The id of the row.

setHeaderItem

fun setHeaderItem(headerItem: HeaderItem!): Unit

Sets the HeaderItem that represents metadata for the row.

Parameters
headerItem HeaderItem!: The HeaderItem for this Row, or null if there is no header.

isRenderedAsRowView

open fun isRenderedAsRowView(): Boolean

Returns true if this Row can be rendered in a visible row view, false otherwise. For example ListRow is rendered by ListRowPresenter. PageRow, SectionRow, DividerRow are rendered as invisible row views.

Return
Boolean: True if this Row can be rendered in a visible row view, false otherwise.

getId

fun getId(): Long

Returns a unique identifier for this row. This id can come from one of three places:

getHeaderItem

fun getHeaderItem(): HeaderItem!

Returns the HeaderItem that represents metadata for the row.

Return
HeaderItem!: The HeaderItem for this row, or null if unset.