ListRowPresenter

Kotlin |Java

open class ListRowPresenter : RowPresenter

kotlin.Any
↳	androidx.leanback.widget.Presenter
	↳	androidx.leanback.widget.RowPresenter
		↳	androidx.leanback.widget.ListRowPresenter

ListRowPresenter renders ListRow using a HorizontalGridView hosted in a ListRowView.

Optionally, setHoverCardPresenterSelector(PresenterSelector) can be used to display a view for the currently focused list item below the rendered list. This view is known as a hover card.

Row selection animation

ListRowPresenter disables RowPresenter's default full row dimming effect and draws a dim overlay on each child individually. A subclass may disable the overlay on each child by overriding isUsingDefaultListSelectEffect() to return false and write its own child dim effect in applySelectLevelToChild(ViewHolder, View).

Shadow

ListRowPresenter applies a default shadow to each child view. Call setShadowEnabled(boolean) to disable shadows. A subclass may override and return false in isUsingDefaultShadow() and replace with its own shadow implementation.

Summary

Nested classes
open	`SelectItemViewHolderTask` A task on the ListRowPresenter.
open	`ViewHolder` ViewHolder for the ListRowPresenter.

Inherited constants

From class RowPresenter

`Int`	`SYNC_ACTIVATED_CUSTOM` Don't synchronize row view activated status with selected status or expanded status, application will do its own through `RowPresenter.ViewHolder#setActivated(boolean)`.
`Int`	`SYNC_ACTIVATED_TO_EXPANDED` Synchronizes row view's activated status to expand status of the row view holder.
`Int`	`SYNC_ACTIVATED_TO_EXPANDED_AND_SELECTED` Sets the row view's activated status to true when both expand and selected are true.
`Int`	`SYNC_ACTIVATED_TO_SELECTED` Synchronizes row view's activated status to selected status of the row view holder.

Public constructors
`<init>()` Constructs a ListRowPresenter with defaults.
`<init>(focusZoomFactor: Int)` Constructs a ListRowPresenter with the given parameters.
`<init>(focusZoomFactor: Int, useFocusDimmer: Boolean)` Constructs a ListRowPresenter with the given parameters.

Public methods
Boolean	`areChildRoundedCornersEnabled()` Returns true if rounded corners are enabled for children of this row.
Unit	`enableChildRoundedCorners(enable: Boolean)` Enables or disabled rounded corners on children of this row.
open Unit	`freeze(holder: RowPresenter.ViewHolder!, freeze: Boolean)`
open Int	`getExpandedRowHeight()` Returns the expanded row height for rows created by this Presenter.
Int	`getFocusZoomFactor()` Returns the zoom factor used for focus highlighting.
PresenterSelector!	`getHoverCardPresenterSelector()` Returns the `PresenterSelector` used for showing a select object in a hover card.
open Int	`getRecycledPoolSize(presenter: Presenter!)` Returns the recycled pool size for the given presenter.
open Int	`getRowHeight()` Returns the row height for list rows created by this Presenter.
Boolean	`getShadowEnabled()` Returns true if child shadow is enabled.
Int	`getZoomFactor()` Returns the zoom factor used for focus highlighting.
Boolean	`isFocusDimmerUsed()` Returns true if the focus dimmer is used for focus highlighting; false otherwise.
Boolean	`isKeepChildForeground()` Returns true if keeps foreground of child of this row, false otherwise.
open Boolean	`isUsingDefaultListSelectEffect()` Returns true so that default select effect is applied to each individual child of `HorizontalGridView`.
Boolean	`isUsingDefaultSelectEffect()` ListRowPresenter overrides the default select effect of `RowPresenter` and return false.
open Boolean	`isUsingDefaultShadow()` Default implementation returns true if SDK version >= 21, shadow (either static or z-order based) will be applied to each individual child of `HorizontalGridView`.
open Boolean	`isUsingOutlineClipping(context: Context!)` Returns true if leanback view outline is enabled on the system or false otherwise.
open Boolean	`isUsingZOrder(context: Context!)` Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled on each child of horizontal list.
open Unit	`setEntranceTransitionState(holder: RowPresenter.ViewHolder!, afterEntrance: Boolean)`
open Unit	`setExpandedRowHeight(rowHeight: Int)` Sets the expanded row height for rows created by this Presenter.
Unit	`setHoverCardPresenterSelector(selector: PresenterSelector!)` Sets the `PresenterSelector` used for showing a select object in a hover card.
Unit	`setKeepChildForeground(keep: Boolean)` When ListRowPresenter applies overlay color on the child, it may change child's foreground Drawable.
open Unit	`setNumRows(numRows: Int)` Sets the numbers of rows for rendering the list of items.
open Unit	`setRecycledPoolSize(presenter: Presenter!, size: Int)` Sets the recycled pool size for the given presenter.
open Unit	`setRowHeight(rowHeight: Int)` Sets the row height for rows created by this Presenter.
Unit	`setShadowEnabled(enabled: Boolean)` Enables or disables child shadow.

Protected methods
open Unit	`applySelectLevelToChild(rowViewHolder: ListRowPresenter.ViewHolder!, childView: View!)` Applies select level to a child.
open RowPresenter.ViewHolder!	`createRowViewHolder(parent: ViewGroup!)`
open ShadowOverlayHelper.Options!	`createShadowOverlayOptions()` Create ShadowOverlayHelper Options.
open Unit	`dispatchItemSelectedListener(holder: RowPresenter.ViewHolder!, selected: Boolean)` Dispatch item selected event using current selected item in the `HorizontalGridView`.
open Unit	`initializeRowViewHolder(holder: RowPresenter.ViewHolder!)`
open Unit	`onBindRowViewHolder(holder: RowPresenter.ViewHolder!, item: Any!)`
open Unit	`onRowViewExpanded(holder: RowPresenter.ViewHolder!, expanded: Boolean)`
open Unit	`onRowViewSelected(holder: RowPresenter.ViewHolder!, selected: Boolean)`
open Unit	`onSelectLevelChanged(holder: RowPresenter.ViewHolder!)` Applies select level to header and draws a default color dim over each child of `HorizontalGridView`.
open Unit	`onUnbindRowViewHolder(holder: RowPresenter.ViewHolder!)`

Inherited functions

From class Presenter

`Unit`	`cancelAnimationsRecursive(view: View!)` Utility method for removing all running animations on a view.
`Any!`	`getFacet(facetClass: Class<*>!)`
`Unit`	`onBindViewHolder(viewHolder: Presenter.ViewHolder!, item: Any!, payloads: MutableList<Any!>!)` Binds a `View` to an item with a list of payloads.
`Unit`

ListRowPresenter

Hover card

Row selection animation

Shadow

Summary