ViewHolder

Kotlin |Java

open class ViewHolder : RowPresenter.ViewHolder

kotlin.Any
↳	androidx.leanback.widget.Presenter.ViewHolder
	↳	androidx.leanback.widget.RowPresenter.ViewHolder
		↳	androidx.leanback.widget.AbstractMediaItemPresenter.ViewHolder

The ViewHolder for the AbstractMediaItemPresenter. It references different views that place different meta-data corresponding to a media item details, actions, selector, listeners, and presenters,

Summary

Public constructors
`<init>(view: View!)`

Public methods
open ViewGroup!	`getMediaItemActionsContainer()`
open View!	`getMediaItemDetailsView()`
open TextView!	`getMediaItemDurationView()`
open TextView!	`getMediaItemNameView()` Returns the view displayed when the media item is neither playing nor paused, corresponding to the playback state of PLAY_STATE_INITIAL.
open TextView!	`getMediaItemNumberView()`
open ViewFlipper!	`getMediaItemNumberViewFlipper()`
open View!	`getMediaItemPausedView()`
open View!	`getMediaItemPlayingView()`
open Array<MultiActionsProvider.MultiAction!>!	`getMediaItemRowActions()`
open View!	`getMediaItemRowSeparator()`
open View!	`getSelectorView()`
open Unit	`notifyActionChanged(action: MultiActionsProvider.MultiAction!)` Notifies an action has changed in this media row and the UI needs to be updated
open Unit	`notifyDetailsChanged()` Notifies the content of the media item details in a row has changed and triggers updating the UI.
open Unit	`notifyPlayStateChanged()` Notifies the playback state of the media item row has changed.
open Unit	`onBindRowActions()` Binds the actions in a media item row object to their views.
open Unit	`setSelectedMediaItemNumberView(position: Int)` Flips to the view at index 'position'.

Inherited functions

From class ViewHolder

Any!

getFacet(facetClass: Class<*>!)

Unit

setFacet(facetClass: Class<*>!, facetImpl: Any!)

Sets dynamic implemented facet in addition to basic ViewHolder functions.

From class ViewHolder

`RowHeaderPresenter.ViewHolder!`	`getHeaderViewHolder()` Returns the view holder for the Row header for this Row.
`BaseOnItemViewClickedListener<Any!>!`	`getOnItemViewClickedListener()` Returns the listener for item click event.
`BaseOnItemViewSelectedListener<Any!>!`	`getOnItemViewSelectedListener()` Returns the listener for item or row selection.
`OnKeyListener!`	`getOnKeyListener()` Returns the key listener.
`Row!`	`getRow()` Returns the row bound to this ViewHolder. Returns null if the row is not an instance of `Row`.
`Any!`	`getRowObject()` Returns the Row object bound to this ViewHolder.
`Float`	`getSelectLevel()` Returns the current selection level of the Row.
`Any!`	`getSelectedItem()` Return currently selected item inside a row ViewHolder.
`Presenter.ViewHolder!`	`getSelectedItemViewHolder()` Return `ViewHolder` of currently selected item inside a row ViewHolder.
`Boolean`	`isExpanded()` Returns whether the Row is in its expanded state.
`Boolean`	`isSelected()` Returns whether the Row is selected.
`Unit`	`setActivated(activated: Boolean)` Sets the row view's activated status. The status will be applied to children through `syncActivatedStatus(View)`. Application should only call this function when `RowPresenter#getSyncActivatePolicy()` is `RowPresenter#SYNC_ACTIVATED_CUSTOM`; otherwise the value will be overwritten when expanded or selected status changes.
`Unit`	`setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener<Any!>!)` Sets the listener for item click event. RowPresenter does nothing but subclass of RowPresenter may fire item click event if it has the concept of item. OnItemViewClickedListener will override `View.OnClickListener` that item presenter sets during `Presenter#onCreateViewHolder(ViewGroup)`.
`Unit`	`setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener<Any!>!)` Sets the listener for item or row selection. RowPresenter fires row selection event with null item. A subclass of RowPresenter e.g. `ListRowPresenter` may fire a selection event with selected item.
`Unit`	`setOnKeyListener(keyListener: OnKeyListener!)` Sets a key listener.
`Unit`	`syncActivatedStatus(view: View!)` Synchronizes the activated status of view to the last value passed through `RowPresenter.ViewHolder#setActivated(boolean)`. No operation if `RowPresenter.ViewHolder#setActivated(boolean)` is never called. Normally application does not need to call this method, `ListRowPresenter` automatically calls this method when a child is attached to list row. However if application writes its own custom RowPresenter, it should call this method when attaches a child to the row view.

Inherited properties

From class ViewHolder

ColorOverlayDimmer!

mColorDimmer

From class ViewHolder

View!

view

Public constructors

<init>

ViewHolder(view: View!)

Public methods

getMediaItemActionsContainer

open fun getMediaItemActionsContainer(): ViewGroup!

Return
ViewGroup!: The view containing the set of custom actions

getMediaItemDetailsView

open fun getMediaItemDetailsView(): View!

Return
View!: The view container of media item details

getMediaItemDurationView

open fun getMediaItemDurationView(): TextView!

Return
TextView!: The TextView responsible for rendering the media item duration

getMediaItemNameView

open fun getMediaItemNameView(): TextView!

Returns the view displayed when the media item is neither playing nor paused, corresponding to the playback state of PLAY_STATE_INITIAL.

Return
TextView!: The TextView responsible for rendering the media item name.

getMediaItemNumberView

open fun getMediaItemNumberView(): TextView!

Return
TextView!: The TextView responsible for rendering the media item number. This view is rendered when the media item row is neither playing nor paused.

getMediaItemNumberViewFlipper

open fun getMediaItemNumberViewFlipper(): ViewFlipper!

Return
ViewFlipper!: The FlipperView responsible for flipping between different media item number views depending on the playback state

getMediaItemPausedView

open fun getMediaItemPausedView(): View!

Return
View!: The view rendered when the media item row is paused.

getMediaItemPlayingView

open fun getMediaItemPlayingView(): View!

Return
View!: The view rendered when the media item row is playing.

getMediaItemRowActions

open fun getMediaItemRowActions(): Array<MultiActionsProvider.MultiAction!>!

Return
Array<MultiActionsProvider.MultiAction!>!: Array of MultiActions displayed for this media item row

getMediaItemRowSeparator

open fun getMediaItemRowSeparator(): View!

Return
View!: The view responsible for rendering the separator line between media rows

getSelectorView

open fun getSelectorView(): View!

Return
View!: The SelectorView responsible for highlighting the in-focus view within each media item row

notifyActionChanged

open fun notifyActionChanged(action: MultiActionsProvider.MultiAction!): Unit

Notifies an action has changed in this media row and the UI needs to be updated

Parameters
`action`	MultiActionsProvider.MultiAction!: The action whose state has changed

notifyDetailsChanged

open fun notifyDetailsChanged(): Unit

Notifies the content of the media item details in a row has changed and triggers updating the UI. This causes onBindMediaDetails(ViewHolder, Object) on the user's provided presenter to be called back, allowing them to update UI accordingly.

notifyPlayStateChanged

open fun notifyPlayStateChanged(): Unit

Notifies the playback state of the media item row has changed. This in turn triggers updating of the UI for that media item row if corresponding views are specified for each playback state. By default, 3 views are provided for each playback state, or these views can be provided by the user.

onBindRowActions

open fun onBindRowActions(): Unit

Binds the actions in a media item row object to their views. This consists of creating (or reusing the existing) action view holders, and populating them with the actions' icons.

setSelectedMediaItemNumberView

open fun setSelectedMediaItemNumberView(position: Int): Unit

Flips to the view at index 'position'. This position corresponds to the index of a particular view within the ViewFlipper layout specified for the MediaItemNumberView (see playbackMediaItemNumberViewFlipperLayout attribute).

Parameters
`position`	Int: The index of the child view to display.