AbstractMediaItemPresenter

abstract class AbstractMediaItemPresenter : RowPresenter

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

Abstract Presenter class for rendering media items in a playlist format. Media item data provided for this presenter can implement the interface MultiActionsProvider, if the media rows wish to contain custom actions. Media items in the playlist are arranged as a vertical list with each row holding each media item's details provided by the user of this class and a set of optional custom actions. Each media item's details and actions are separately focusable. The appearance of each one of the media row components can be controlled through setting theme's attributes. Each media item row provides a view flipper for switching between different views depending on the playback state. A default layout is provided by this presenter for rendering different playback states, or a custom layout can be provided by the user by overriding the playbackMediaItemNumberViewFlipperLayout attribute in the currently specified theme. Subclasses should also override getMediaPlayState(Object) to provide the current play state of their media item model in case they wish to use different views depending on the playback state. The presenter can optionally provide line separators between media rows by setting setHasMediaRowSeparator(boolean) to true.

Subclasses must override onBindMediaDetails to implement their media item model data binding to each row view.

The OnItemViewClickedListener and OnItemViewSelectedListener can be used in the same fashion to handle selection or click events on either of media details or each individual action views.

AbstractMediaListHeaderPresenter can be used in conjunction with this presenter in order to display a playlist with a header view.

Summary

Nested classes
open	ViewHolder The ViewHolder for the AbstractMediaItemPresenter.

Constants
static Int	PLAY_STATE_INITIAL Indicating that the media item is currently neither playing nor paused.
static Int	PLAY_STATE_PAUSED Indicating that the media item is currently paused.
static Int	PLAY_STATE_PLAYING Indicating that the media item is currently playing

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>() Constructor used for creating an abstract media item presenter.
<init>(themeId: Int) Constructor used for creating an abstract media item presenter.

Public methods
open Presenter!	getActionPresenter() Return the presenter used to render a media item row actions.
open Int	getThemeId() Return The resource id of the theme that defines attributes controlling the appearance of different widgets in a media item row.
open Boolean	hasMediaRowSeparator()
open Boolean	isUsingDefaultSelectEffect()
open Unit	onBindMediaPlayState(vh: AbstractMediaItemPresenter.ViewHolder!) Binds the media item number view to the appropriate play state view of the media item.
open Unit	onUnbindMediaPlayState(vh: AbstractMediaItemPresenter.ViewHolder!) Called when the given ViewHolder wants to unbind the play state view.
open Unit	setActionPresenter(actionPresenter: Presenter!) Sets the action presenter rendering each optional custom action within each media item row.
open Unit	setBackgroundColor(color: Int) Sets the background color for the row views within the playlist.
open Unit	setHasMediaRowSeparator(hasSeparator: Boolean) Specifies whether a line separator should be used between media item rows.
open Unit	setThemeId(themeId: Int) Sets the theme used to style a media item row components.

Protected methods
open RowPresenter.ViewHolder!	createRowViewHolder(parent: ViewGroup!)
open Int	getMediaPlayState(item: Any!) Returns the current play state of the given media item.
open Boolean	isClippingChildren()
abstract Unit	onBindMediaDetails(vh: AbstractMediaItemPresenter.ViewHolder!, item: Any!) Binds the media item details to their views provided by the AbstractMediaItemPresenter.
open Unit	onBindRowActions(vh: AbstractMediaItemPresenter.ViewHolder!) Binds the given media item object action to the given ViewHolder's action views.
open Unit	onBindRowViewHolder(vh: RowPresenter.ViewHolder!, item: Any!)
open Unit	onUnbindMediaDetails(vh: AbstractMediaItemPresenter.ViewHolder!) Unbinds the media item details from their views provided by the AbstractMediaItemPresenter.

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 setFacet(facetClass: Class<*>!, facetImpl: Any!) Sets dynamic implemented facet in addition to basic Presenter functions. Unit setOnClickListener(holder: Presenter.ViewHolder!, listener: OnClickListener!) Called to set a click listener for the given view holder. The default implementation sets the click listener on the root view in the view holder. If the root view isn't focusable this method should be overridden to set the listener on the appropriate focusable child view(s).
From class RowPresenter Unit dispatchItemSelectedListener(vh: RowPresenter.ViewHolder!, selected: Boolean) This method is only called from onRowViewSelected(ViewHolder, boolean) onRowViewSelected. The default behavior is to signal row selected events with a null item parameter. A Subclass of RowPresenter having child items should override this method and dispatch events with item information. Unit freeze(holder: RowPresenter.ViewHolder!, freeze: Boolean) Freezes/unfreezes the row, typically used when a transition starts/ends. This method is called by the fragment, it should not call it directly by the application. RowHeaderPresenter! getHeaderPresenter() Returns the Presenter used for rendering the header, or null if none has been set. RowPresenter.ViewHolder! getRowViewHolder(holder: Presenter.ViewHolder!) Returns the RowPresenter.ViewHolder from the given RowPresenter ViewHolder. Boolean getSelectEffectEnabled() Returns true if the row selection effect is enabled. This value not only determines whether the default dim implementation is used, but subclasses must also respect this flag. Float getSelectLevel(vh: Presenter.ViewHolder!) Returns the current select level. The value will be between 0 (unselected) and 1 (selected). Int getSyncActivatePolicy() Returns the policy of updating row view activated status. Can be one of: Default value SYNC_ACTIVATED_TO_EXPANDED SYNC_ACTIVATED_TO_SELECTED SYNC_ACTIVATED_TO_EXPANDED_AND_SELECTED SYNC_ACTIVATED_CUSTOM Unit initializeRowViewHolder(vh