added in version 24.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

Summary: Nested Classes | Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

AbstractMediaListHeaderPresenter

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public abstract class AbstractMediaListHeaderPresenter
extends RowPresenter

java.lang.Object
↳	android.support.v17.leanback.widget.Presenter
	↳	android.support.v17.leanback.widget.RowPresenter
		↳	android.support.v17.leanback.widget.AbstractMediaListHeaderPresenter

---

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

Subclasses of this class must override onBindMediaListHeaderViewHolder(ViewHolder, Object) 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
class	AbstractMediaListHeaderPresenter.ViewHolder The ViewHolder for the AbstractMediaListHeaderPresenter.

Inherited constants

From class android.support.v17.leanback.widget.RowPresenter int SYNC_ACTIVATED_CUSTOM Don't synchronize row view activated status with selected status or expanded status, application will do its own through 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
AbstractMediaListHeaderPresenter(Context context, int mThemeResId) Constructor used for creating an abstract media-list header presenter of a given theme.
AbstractMediaListHeaderPresenter() Constructor used for creating an abstract media-list header presenter.

Public methods
boolean	isUsingDefaultSelectEffect() Returns true if this RowPresenter is using the default dimming effect.
void	setBackgroundColor(int color) Sets the background color for the row views within the playlist.

Protected methods
RowPresenter.ViewHolder	createRowViewHolder(ViewGroup parent) Called to create a ViewHolder object for a Row.
abstract void	onBindMediaListHeaderViewHolder(AbstractMediaListHeaderPresenter.ViewHolder vh, Object item) Binds the playlist header data model provided by the user to the AbstractMediaListHeaderPresenter.ViewHolder provided by the AbstractMediaListHeaderPresenter.
void	onBindRowViewHolder(RowPresenter.ViewHolder vh, Object item) Binds the given row object to the given ViewHolder.

Inherited methods
From class android.support.v17.leanback.widget.RowPresenter abstract RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent) Called to create a ViewHolder object for a Row. void dispatchItemSelectedListener(RowPresenter.ViewHolder vh, boolean selected) This method is only called from onRowViewSelected(ViewHolder, boolean) onRowViewSelected. void freeze(RowPresenter.ViewHolder holder, boolean freeze) Freezes/unfreezes the row, typically used when a transition starts/ends. final RowHeaderPresenter getHeaderPresenter() Returns the Presenter used for rendering the header, or null if none has been set. final RowPresenter.ViewHolder getRowViewHolder(Presenter.ViewHolder holder) Returns the RowPresenter.ViewHolder from the given RowPresenter ViewHolder. final boolean getSelectEffectEnabled() Returns true if the row selection effect is enabled. final float getSelectLevel(Presenter.ViewHolder vh) Returns the current select level. final int getSyncActivatePolicy() Returns the policy of updating row view activated status. void initializeRowViewHolder(RowPresenter.ViewHolder vh) Called after a RowPresenter.ViewHolder is created for a Row. boolean isClippingChildren() Returns true if the Row view should clip its children. boolean isUsingDefaultSelectEffect() Returns true if this RowPresenter is using the default dimming effect. void onBindRowViewHolder(RowPresenter.ViewHolder vh, Object item) Binds the given row object to the given ViewHolder. final void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item) Binds a View to an item. final Presenter.ViewHolder onCreateViewHolder(ViewGroup parent) Creates a new View. void onRowViewAttachedToWindow(RowPresenter.ViewHolder vh) Invoked when the row view is attached to the window. void onRowViewDetachedFromWindow(RowPresenter.ViewHolder vh) Invoked when the row view is detached from the window. void onRowViewExpanded(RowPresenter.ViewHolder vh, boolean expanded) Called when the row view's expanded state changes. void onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected) Called when the given row view changes selection state. void onSelectLevelChanged(RowPresenter.ViewHolder vh) Callback when the select level changes. void onUnbindRowViewHolder(RowPresenter.ViewHolder vh) Unbinds the given ViewHolder. final void onUnbindViewHolder(Presenter.ViewHolder viewHolder) Unbinds a View from an item. final void onViewAttachedToWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been attached to a window. final void onViewDetachedFromWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been detached from its window. void setEntranceTransitionState(RowPresenter.ViewHolder holder, boolean afterEntrance) Changes the visibility of views. final void setHeaderPresenter(RowHeaderPresenter headerPresenter) Sets the Presenter used for rendering the header. final void setRowViewExpanded(Presenter.ViewHolder holder, boolean expanded) Sets the expanded state of a Row view. final void setRowViewSelected(Presenter.ViewHolder holder, boolean selected) Sets the selected state of a Row view. final void setSelectEffectEnabled(boolean applyDimOnSelect) Enables or disables the row selection effect. final void setSelectLevel(Presenter.ViewHolder vh, float level) Sets the current select level to a value between 0 (unselected) and 1 (selected). final void setSyncActivatePolicy(int syncActivatePolicy) Sets the policy of updating row view activated status.
From class android.support.v17.leanback.widget.Presenter static void cancelAnimationsRecursive(View view) Utility method for removing all running animations on a view. final Object getFacet(Class<?> facetClass) Queries optional implemented facet. abstract void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item) Binds a View to an item. void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item, List<Object> payloads) Binds a View to an item with a list of payloads. abstract Presenter.ViewHolder onCreateViewHolder(ViewGroup parent) Creates a new View. abstract void onUnbindViewHolder(Presenter.ViewHolder viewHolder) Unbinds a View from an item. void onViewAttachedToWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been attached to a window. void onViewDetachedFromWindow(Presenter.ViewHolder holder) Called when a view created by this presenter has been detached from its window. final void setFacet(Class<?> facetClass, Object facetImpl) Sets dynamic implemented facet in addition to basic Presenter functions. void setOnClickListener(Presenter.ViewHolder holder, View.OnClickListener listener) Called to set a click listener for the given view holder.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.support.v17.leanback.widget.FacetProvider abstract Object getFacet(Class<?> facetClass) Queries optional implemented facet.

Public constructors

AbstractMediaListHeaderPresenter

added in version 24.1.0

AbstractMediaListHeaderPresenter (Context context, 
                int mThemeResId)

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.

AbstractMediaListHeaderPresenter

added in version 24.1.0

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

added in version 24.1.0

boolean isUsingDefaultSelectEffect ()

Returns true if this RowPresenter is using the default dimming effect. A subclass may (most likely) return false and override onSelectLevelChanged(ViewHolder).

Returns
boolean

setBackgroundColor

added in version 24.1.0

void setBackgroundColor (int color)

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

added in version 24.1.0

RowPresenter.ViewHolder createRowViewHolder (ViewGroup parent)

Called to create a ViewHolder object for a Row. Subclasses will override this method to return a different concrete ViewHolder object.

Parameters
parent	ViewGroup: The parent View for the Row's view holder.

Returns
RowPresenter.ViewHolder	A ViewHolder for the Row's View.

onBindMediaListHeaderViewHolder

added in version 24.1.0

void onBindMediaListHeaderViewHolder (AbstractMediaListHeaderPresenter.ViewHolder vh, 
                Object item)

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

Parameters
vh	AbstractMediaListHeaderPresenter.ViewHolder: The ViewHolder for this AbstractMediaListHeaderPresenter.
item	Object: The header data object being presented.

onBindRowViewHolder

added in version 24.1.0

void onBindRowViewHolder (RowPresenter.ViewHolder vh, 
                Object item)

Binds the given row object to the given ViewHolder. Derived classes of RowPresenter overriding onBindRowViewHolder(ViewHolder, Object) must call through the super class's implementation of this method.

Parameters
vh	RowPresenter.ViewHolder
item	Object

• Interfaces

  • BaseGridView.OnKeyInterceptListener
  • BaseGridView.OnMotionInterceptListener
  • BaseGridView.OnTouchInterceptListener
  • BaseGridView.OnUnhandledKeyListener
  • BaseOnItemViewClickedListener
  • BaseOnItemViewSelectedListener
  • BrowseFrameLayout.OnChildFocusListener
  • BrowseFrameLayout.OnFocusSearchListener
  • FacetProvider
  • FacetProviderAdapter
  • FocusHighlight
  • FragmentAnimationProvider
  • ImeKeyMonitor
  • ImeKeyMonitor.ImeKeyListener
  • MultiActionsProvider
  • OnActionClickedListener
  • OnChildLaidOutListener
  • OnChildSelectedListener
  • OnItemViewClickedListener
  • OnItemViewSelectedListener
  • PlaybackSeekUi
  • SearchBar.SearchBarListener
  • SearchBar.SearchBarPermissionListener
  • SearchEditText.OnKeyboardDismissListener
  • SpeechRecognitionCallback
  • TitleViewAdapter.Provider
  • ViewHolderTask

• Classes

  • AbstractDetailsDescriptionPresenter
  • AbstractDetailsDescriptionPresenter.ViewHolder
  • AbstractMediaItemPresenter
  • AbstractMediaItemPresenter.ViewHolder
  • AbstractMediaListHeaderPresenter
  • AbstractMediaListHeaderPresenter.ViewHolder
  • Action
  • ArrayObjectAdapter
  • BaseCardView
  • BaseCardView.LayoutParams
  • BaseGridView
  • BrowseFrameLayout
  • ClassPresenterSelector
  • ControlButtonPresenterSelector
  • CursorObjectAdapter
  • DetailsOverviewLogoPresenter
  • DetailsOverviewLogoPresenter.ViewHolder
  • DetailsOverviewRow
  • DetailsOverviewRow.Listener
  • DetailsOverviewRowPresenter
  • DetailsOverviewRowPresenter.ViewHolder
  • DetailsParallax
  • DiffCallback
  • DividerPresenter
  • DividerRow
  • FocusHighlightHelper
  • FullWidthDetailsOverviewRowPresenter
  • FullWidthDetailsOverviewRowPresenter.Listener
  • FullWidthDetailsOverviewRowPresenter.ViewHolder
  • FullWidthDetailsOverviewRowPresenter.ViewHolder.DetailsOverviewRowListener
  • FullWidthDetailsOverviewSharedElementHelper
  • GuidanceStylist
  • GuidanceStylist.Guidance
  • GuidedAction
  • GuidedAction.Builder
  • GuidedAction.BuilderBase
  • GuidedActionDiffCallback
  • GuidedActionEditText
  • GuidedActionsStylist
  • GuidedActionsStylist.ViewHolder
  • GuidedDatePickerAction
  • GuidedDatePickerAction.Builder
  • GuidedDatePickerAction.BuilderBase
  • HeaderItem
  • HorizontalGridView
  • HorizontalHoverCardSwitcher
  • ImageCardView
  • ItemAlignmentFacet
  • ItemAlignmentFacet.ItemAlignmentDef
  • ItemBridgeAdapter
  • ItemBridgeAdapter.AdapterListener
  • ItemBridgeAdapter.ViewHolder
  • ItemBridgeAdapter.Wrapper
  • ItemBridgeAdapterShadowOverlayWrapper
  • ListRow
  • ListRowHoverCardView
  • ListRowPresenter
  • ListRowPresenter.SelectItemViewHolderTask
  • ListRowPresenter.ViewHolder
  • ListRowView
  • MultiActionsProvider.MultiAction
  • ObjectAdapter
  • ObjectAdapter.DataObserver
  • OnChildViewHolderSelectedListener
  • PageRow
  • Parallax
  • Parallax.FloatProperty
  • Parallax.IntProperty
  • Parallax.PropertyMarkerValue
  • ParallaxEffect
  • ParallaxTarget
  • ParallaxTarget.DirectPropertyTarget
  • ParallaxTarget.PropertyValuesHolderTarget
  • PlaybackControlsRow
  • PlaybackControlsRow.ClosedCaptioningAction
  • PlaybackControlsRow.FastForwardAction
  • PlaybackControlsRow.HighQualityAction
  • PlaybackControlsRow.MoreActions
  • PlaybackControlsRow.MultiAction
  • PlaybackControlsRow.OnPlaybackProgressCallback
  • PlaybackControlsRow.PictureInPictureAction
  • PlaybackControlsRow.PlayPauseAction
  • PlaybackControlsRow.RepeatAction
  • PlaybackControlsRow.RewindAction
  • PlaybackControlsRow.ShuffleAction
  • PlaybackControlsRow.SkipNextAction
  • PlaybackControlsRow.SkipPreviousAction
  • PlaybackControlsRow.ThumbsAction
  • PlaybackControlsRow.ThumbsDownAction
  • PlaybackControlsRow.ThumbsUpAction
  • PlaybackControlsRowPresenter
  • PlaybackControlsRowPresenter.ViewHolder
  • PlaybackRowPresenter
  • PlaybackRowPresenter.ViewHolder
  • PlaybackSeekDataProvider
  • PlaybackSeekDataProvider.ResultCallback
  • PlaybackSeekUi.Client
  • PlaybackTransportRowPresenter
  • PlaybackTransportRowPresenter.ViewHolder
  • Presenter
  • Presenter.ViewHolder
  • Presenter.ViewHolderTask
  • PresenterSelector
  • PresenterSwitcher
  • RecyclerViewParallax
  • RecyclerViewParallax.ChildPositionProperty
  • Row
  • RowHeaderPresenter
  • RowHeaderPresenter.ViewHolder
  • RowHeaderView
  • RowPresenter
  • RowPresenter.ViewHolder
  • SearchBar
  • SearchEditText
  • SearchOrbView
  • SearchOrbView.Colors
  • SectionRow
  • ShadowOverlayContainer
  • ShadowOverlayHelper
  • ShadowOverlayHelper.Builder
  • ShadowOverlayHelper.Options
  • SinglePresenterSelector
  • SparseArrayObjectAdapter
  • SpeechOrbView
  • TitleHelper
  • TitleView
  • TitleViewAdapter
  • VerticalGridPresenter
  • VerticalGridPresenter.ViewHolder
  • VerticalGridView