AbstractMediaListHeaderPresenter

Kotlin |Java

abstract class AbstractMediaListHeaderPresenter : RowPresenter

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

Abstract presenter class for rendering the header for a list of media items in a playlist. The presenter creates a ViewHolder for the TextView holding the header text.

Subclasses of this class must override in order to bind their header text to the media list header view.

AbstractMediaItemPresenter 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 `AbstractMediaListHeaderPresenter`.

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>(context: Context!, mThemeResId: Int)` Constructor used for creating an abstract media-list header presenter of a given theme.
`<init>()` Constructor used for creating an abstract media-list header presenter.

Public methods
open Boolean	`isUsingDefaultSelectEffect()`
open Unit	`setBackgroundColor(color: Int)` Sets the background color for the row views within the playlist.

Protected methods
open RowPresenter.ViewHolder!	`createRowViewHolder(parent: ViewGroup!)`
abstract Unit	`onBindMediaListHeaderViewHolder(vh: AbstractMediaListHeaderPresenter.ViewHolder!, item: Any!)` Binds the playlist header data model provided by the user to the `ViewHolder` provided by the `AbstractMediaListHeaderPresenter`.
open Unit	`onBindRowViewHolder(vh: RowPresenter.ViewHolder!, item: Any!)`

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).
`Boolean`	`isClippingChildren()` Returns true if the Row view should clip its children. The clipChildren flag is set on view in `initializeRowViewHolder(ViewHolder)`. Note that Slide transition or explode transition need turn off clipChildren. Default value is false.
`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`

Public constructors

<init>

AbstractMediaListHeaderPresenter(
    context: Context!, 
    mThemeResId: Int)

Constructor used for creating an abstract media-list header presenter of a given theme.

Parameters
`context`	Context!: The context the user of this presenter is running in.
`mThemeResId`	Int: The resource id of the desired theme used for styling of this presenter.

<init>

AbstractMediaListHeaderPresenter()

Constructor used for creating an abstract media-list header presenter. The styling for this presenter is extracted from Context of parent in createRowViewHolder(ViewGroup).

Public methods

isUsingDefaultSelectEffect

open fun isUsingDefaultSelectEffect(): Boolean

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 header text background color.

Protected methods

createRowViewHolder

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

onBindMediaListHeaderViewHolder

protected abstract fun onBindMediaListHeaderViewHolder(
    vh: AbstractMediaListHeaderPresenter.ViewHolder!, 
    item: Any!
): Unit

Binds the playlist header data model provided by the user to the ViewHolder provided by the AbstractMediaListHeaderPresenter. The subclasses of this presenter can access and bind the text view corresponding to the header by calling ViewHolder#getHeaderView(), on the ViewHolder provided as the argument vh by this presenter.

Parameters
`vh`	AbstractMediaListHeaderPresenter.ViewHolder!: The ViewHolder for this `AbstractMediaListHeaderPresenter`.
`item`	Any!: The header data object being presented.

onBindRowViewHolder

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

AbstractMediaListHeaderPresenter

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited functions

Public constructors

<init>

<init>

Public methods

isUsingDefaultSelectEffect

setBackgroundColor

Protected methods

createRowViewHolder

onBindMediaListHeaderViewHolder

onBindRowViewHolder