Row

Kotlin |Java

open class Row

kotlin.Any
↳	androidx.leanback.widget.Row

Known Direct Subclasses

DetailsOverviewRow, DividerRow, ListRow, PageRow, PlaybackControlsRow, SectionRow

DetailsOverviewRow	An overview `Row` for a details fragment.
DividerRow	Used to represent divider in HeadersFragment.
ListRow	A `Row` composed of a optional `HeaderItem`, and an `ObjectAdapter` describing the items in the list.
PageRow	Used to represent content spanning full page.
PlaybackControlsRow	A `Row` of playback controls to be displayed by a `PlaybackControlsRowPresenter`.
SectionRow	Used to represent section item in HeadersFragment.

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.
`<init>()` Constructor for a Row.

Public methods
HeaderItem!	`getHeaderItem()` Returns the `HeaderItem` that represents metadata for the row.
Long	`getId()` Returns a unique identifier for this row.
open Boolean	`isRenderedAsRowView()` Returns true if this Row can be rendered in a visible row view, false otherwise.
Unit	`setHeaderItem(headerItem: HeaderItem!)` Sets the `HeaderItem` that represents metadata for the row.
Unit	`setId(id: Long)` Sets the id for this row.

Public constructors

<init>

Row(
    id: Long, 
    headerItem: HeaderItem!)

Constructor for a Row.

Parameters
`id`	Long: The id of the row.
`headerItem`	HeaderItem!: 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

getHeaderItem

fun getHeaderItem(): HeaderItem!

Returns the HeaderItem that represents metadata for the row.

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

getId

fun getId(): Long

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

If setId(long) is ever called on this row, it will return this id.
If setId(long) has not been called but the header item is not null, the result of HeaderItem#getId() is returned.
Otherwise NO_ID is returned.

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.

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.

setId

fun setId(id: Long): Unit

Sets the id for this row.

Parameters
`id`	Long: The id of the row.