AbstractMediaItemPresenter

Kotlin |Java

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: RowPresenter.ViewHolder!) Called after a RowPresenter.ViewHolder is created for a Row. Subclasses may override this method and start by calling super.initializeRowViewHolder(ViewHolder). Unit onBindViewHolder(viewHolder: Presenter.ViewHolder!, item: Any!) Presenter.ViewHolder! onCreateViewHolder(parent: ViewGroup!) Unit onRowViewAttachedToWindow(vh: RowPresenter.ViewHolder!) Invoked when the row view is attached to the window. Unit onRowViewDetachedFromWindow(vh: RowPresenter.ViewHolder!) Invoked when the row view is detached from the window. Unit onRowViewExpanded(vh: RowPresenter.ViewHolder!, expanded: Boolean) Called when the row view's expanded state changes. A subclass may override this method to respond to expanded state changes of a Row. The default implementation will hide/show the header view. Subclasses may make visual changes to the Row View but must not create animation on the Row view. Unit onRowViewSelected(vh: RowPresenter.ViewHolder!, selected: Boolean) Called when the given row view changes selection state. A subclass may override this to respond to selected state changes of a Row. A subclass may make visual changes to Row view but must not create animation on the Row view. Unit onSelectLevelChanged(vh: RowPresenter.ViewHolder!) Callback when the select level changes. The default implementation applies the select level to RowHeaderPresenter#setSelectLevel(RowHeaderPresenter.ViewHolder, float) when getSelectEffectEnabled() is true. Subclasses may override this function and implement a different select effect. In this case, the method isUsingDefaultSelectEffect() should also be overridden to disable the default dimming effect. Unit onUnbindRowViewHolder(vh: RowPresenter.ViewHolder!) Unbinds the given ViewHolder. Derived classes of RowPresenter overriding onUnbindRowViewHolder(ViewHolder) must call through the super class's implementation of this method. Unit onUnbindViewHolder(viewHolder: Presenter.ViewHolder!) Unit onViewAttachedToWindow(holder: Presenter.ViewHolder!) Unit onViewDetachedFromWindow(holder: Presenter.ViewHolder!) Unit setEntranceTransitionState(holder: RowPresenter.ViewHolder!, afterEntrance: Boolean) Changes the visibility of views. The entrance transition will be run against the views that change visibilities. A subclass may override and begin with calling super.setEntranceTransitionState(). This method is called by the fragment, it should not be called directly by the application. Unit setHeaderPresenter(headerPresenter: RowHeaderPresenter!) Sets the Presenter used for rendering the header. Can be null to disable header rendering. The method must be called before creating any Row Views. Unit setRowViewExpanded(holder: Presenter.ViewHolder!, expanded: Boolean) Sets the expanded state of a Row view. Unit setRowViewSelected(holder: Presenter.ViewHolder!, selected: Boolean) Sets the selected state of a Row view. Unit setSelectEffectEnabled(applyDimOnSelect: Boolean) Enables or disables the row selection effect. This will not only affect the default dim effect, but subclasses must respect this flag as well. Unit setSelectLevel(vh: Presenter.ViewHolder!, level: Float) Sets the current select level to a value between 0 (unselected) and 1 (selected). Subclasses may override onSelectLevelChanged(ViewHolder) to respond to changes in the selected level. Unit setSyncActivatePolicy(syncActivatePolicy: Int) Sets 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

Constants

PLAY_STATE_INITIAL

static val PLAY_STATE_INITIAL: Int

Indicating that the media item is currently neither playing nor paused.

Value: 0

PLAY_STATE_PAUSED

static val PLAY_STATE_PAUSED: Int

Indicating that the media item is currently paused.

Value: 1

PLAY_STATE_PLAYING

static val PLAY_STATE_PLAYING: Int

Indicating that the media item is currently playing

Value: 2

Public constructors

<init>

AbstractMediaItemPresenter()

Constructor used for creating an abstract media item presenter.

<init>

AbstractMediaItemPresenter(themeId: Int)

Constructor used for creating an abstract media item presenter.

Parameters
themeId	Int: The resource id of the theme that defines attributes controlling the appearance of different widgets in a media item row.

Public methods

getActionPresenter

open fun getActionPresenter(): Presenter!

Return the presenter used to render a media item row actions.

Return
Presenter!	the presenter used to render a media item row actions.

getThemeId

open fun getThemeId(): Int

Return The resource id of the theme that defines attributes controlling the appearance of different widgets in a media item row.

Return
Int	The resource id of the theme that defines attributes controlling the appearance of different widgets in a media item row.

hasMediaRowSeparator

open fun hasMediaRowSeparator(): Boolean

isUsingDefaultSelectEffect

open fun isUsingDefaultSelectEffect(): Boolean

onBindMediaPlayState

open fun onBindMediaPlayState(vh: AbstractMediaItemPresenter.ViewHolder!): Unit

Binds the media item number view to the appropriate play state view of the media item. The play state of the media item is extracted by calling getMediaPlayState(Object) for the media item embedded within this view. This method triggers updating of the playback state UI if corresponding views are specified for the current playback state. By default, 3 views are provided for each playback state, or these views can be provided by the user.

onUnbindMediaPlayState

open fun onUnbindMediaPlayState(vh: AbstractMediaItemPresenter.ViewHolder!): Unit

Called when the given ViewHolder wants to unbind the play state view.

Parameters
vh	AbstractMediaItemPresenter.ViewHolder!: The ViewHolder to unbind from.

setActionPresenter

open fun setActionPresenter(actionPresenter: Presenter!): Unit

Sets the action presenter rendering each optional custom action within each media item row.

Parameters
actionPresenter	Presenter!: the presenter to be used for rendering a media item row actions.

setBackgroundColor

open fun setBackgroundColor(color: Int): Unit

Sets the background color for the row views within the playlist. If this is not set, a default color, defaultBrandColor, from theme is used. This defaultBrandColor defaults to android:attr/colorPrimary on v21, if it's specified.

Parameters
color	Int: The ARGB color used to set as the media list background color.

setHasMediaRowSeparator

open fun setHasMediaRowSeparator(hasSeparator: Boolean): Unit

Specifies whether a line separator should be used between media item rows.

Parameters
hasSeparator	Boolean: true if a separator should be displayed, false otherwise.

setThemeId

open fun setThemeId(themeId: Int): Unit

Sets the theme used to style a media item row components.

Parameters
themeId	Int: The resource id of the theme that defines attributes controlling the appearance of different widgets in a media item row.

Protected methods

createRowViewHolder

protected open fun createRowViewHolder(parent: ViewGroup!): RowPresenter.ViewHolder!

getMediaPlayState

protected open fun getMediaPlayState(item: Any!): Int

Returns the current play state of the given media item. By default, this method returns PLAY_STATE_INITIAL which causes the media item number ViewHolder#getMediaItemNameView() to be displayed for different playback states. Users of this class should override this method in order to provide the play state of their custom media item data model.

Parameters
item	Any!: The media item

Return
Int	The current play state of this media item

isClippingChildren

protected open fun isClippingChildren(): Boolean

onBindMediaDetails

protected abstract fun onBindMediaDetails(
    vh: AbstractMediaItemPresenter.ViewHolder!, 
    item: Any!
): Unit

Binds the media item details to their views provided by the AbstractMediaItemPresenter. This method is to be overridden by the users of this presenter. The subclasses of this presenter can access and bind individual views for either of the media item number, name, or duration (depending on whichever views are visible according to the providing theme attributes), by calling ViewHolder#getMediaItemNumberView(), ViewHolder#getMediaItemNameView(), and ViewHolder#getMediaItemDurationView(), on the ViewHolder provided as the argument vh of this presenter.

Parameters
vh	AbstractMediaItemPresenter.ViewHolder!: The ViewHolder for this AbstractMediaItemPresenter.
item	Any!: The media item row object being presented.

onBindRowActions

protected open fun onBindRowActions(vh: AbstractMediaItemPresenter.ViewHolder!): Unit

Binds the given media item object action to the given ViewHolder's action views.

Parameters
vh	AbstractMediaItemPresenter.ViewHolder!: ViewHolder for the media item.

onBindRowViewHolder

protected open fun onBindRowViewHolder(
    vh: RowPresenter.ViewHolder!, 
    item: Any!
): Unit

onUnbindMediaDetails

protected open fun onUnbindMediaDetails(vh: AbstractMediaItemPresenter.ViewHolder!): Unit

Unbinds the media item details from their views provided by the AbstractMediaItemPresenter. This method can be overridden by the subclasses of this presenter if required.

Parameters
vh	AbstractMediaItemPresenter.ViewHolder!: ViewHolder to unbind from.