PlaybackTransportRowPresenter

Artifact: androidx.leanback:leanback

View Source

Added in 1.1.0

---

Kotlin |Java

public class PlaybackTransportRowPresenter extends PlaybackRowPresenter

java.lang.Object
↳	androidx.leanback.widget.Presenter
	↳	androidx.leanback.widget.RowPresenter
		↳	androidx.leanback.widget.PlaybackRowPresenter
			↳	androidx.leanback.widget.PlaybackTransportRowPresenter

---

A PlaybackTransportRowPresenter renders a PlaybackControlsRow to display a series of playback control buttons. Typically this row will be the first row in a fragment such as the androidx.leanback.app.PlaybackSupportFragment.

The detailed description is rendered using a Presenter passed in setDescriptionPresenter. This can be an instance of AbstractDetailsDescriptionPresenter. The application can access the detailed description ViewHolder from getDescriptionViewHolder.

Summary

Nested types
public inner class PlaybackTransportRowPresenter.ViewHolder extends PlaybackRowPresenter.ViewHolder implements PlaybackSeekUi A ViewHolder for the PlaybackControlsRow supporting seek UI.

Public constructors
PlaybackTransportRowPresenter()

Public methods
float	getDefaultSeekIncrement() Get default seek increment if PlaybackSeekDataProvider is null.
OnActionClickedListener	getOnActionClickedListener() Returns the listener for Action click events.
@ColorInt int	getProgressColor() Returns the primary color for the progress bar.
@ColorInt int	getSecondaryProgressColor() Returns the secondary color for the progress bar.
void	onReappear(RowPresenter.ViewHolder rowViewHolder) Provides hook to update the UI when the view reappears.
void	setDefaultSeekIncrement(float ratio) Set default seek increment if PlaybackSeekDataProvider is null.
void	setDescriptionPresenter(Presenter descriptionPresenter)
void	setOnActionClickedListener(OnActionClickedListener listener) Sets the listener for Action click events.
void	setProgressColor(@ColorInt int color) Sets the primary color for the progress bar.
void	setSecondaryProgressColor(@ColorInt int color) Sets the secondary color for the progress bar.

Protected methods
RowPresenter.ViewHolder	createRowViewHolder(ViewGroup parent) Called to create a ViewHolder object for a Row.
void	onBindRowViewHolder(     @NonNull RowPresenter.ViewHolder holder,     @NonNull Object item ) Binds the given row object to the given ViewHolder.
void	onProgressBarClicked(PlaybackTransportRowPresenter.ViewHolder vh) Client of progress bar is clicked, default implementation delegate click to PlayPauseAction.
void	onRowViewAttachedToWindow(@NonNull RowPresenter.ViewHolder vh) Invoked when the row view is attached to the window.
void	onRowViewDetachedFromWindow(@NonNull RowPresenter.ViewHolder vh) Invoked when the row view is detached from the window.
void	onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected) Called when the given row view changes selection state.
void	onUnbindRowViewHolder(@NonNull RowPresenter.ViewHolder holder) Unbinds the given ViewHolder.

Inherited Constants

From androidx.leanback.widget.RowPresenter static final int SYNC_ACTIVATED_CUSTOM = 0 Don't synchronize row view activated status with selected status or expanded status, application will do its own through setActivated. static final int SYNC_ACTIVATED_TO_EXPANDED = 1 Synchronizes row view's activated status to expand status of the row view holder. static final int SYNC_ACTIVATED_TO_EXPANDED_AND_SELECTED = 3 Sets the row view's activated status to true when both expand and selected are true. static final int SYNC_ACTIVATED_TO_SELECTED = 2 Synchronizes row view's activated status to selected status of the row view holder.

Inherited methods
From androidx.leanback.widget.FacetProvider abstract @Nullable Object getFacet(@NonNull Class<Object> facetClass) Queries optional implemented facet.
From androidx.leanback.widget.Presenter static void cancelAnimationsRecursive(View view) Utility method for removing all running animations on a view. final Object getFacet(Class<Object> facetClass) Queries optional implemented facet. abstract void onBindViewHolder(     @NonNull Presenter.ViewHolder viewHolder,     @Nullable Object item ) Binds a View to an item. void onBindViewHolder(     @NonNull Presenter.ViewHolder viewHolder,     @NonNull Object item,     @NonNull List<Object> payloads ) Binds a View to an item with a list of payloads. abstract @NonNull Presenter.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent) Creates a new View. abstract void onUnbindViewHolder(@NonNull Presenter.ViewHolder viewHolder) Unbinds a View from an item. void onViewAttachedToWindow(@NonNull Presenter.ViewHolder holder) Called when a view created by this presenter has been attached to a window. void onViewDetachedFromWindow(@NonNull Presenter.ViewHolder holder) Called when a view created by this presenter has been detached from its window. final void setFacet(Class<Object> 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 androidx.leanback.widget.RowPresenter void dispatchItemSelectedListener(     RowPresenter.ViewHolder vh,     boolean selected ) This method is only called from onRowViewSelected onRowViewSelected. void freeze(@NonNull 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. final void onBindViewHolder(     @NonNull Presenter.ViewHolder viewHolder,     @Nullable Object item ) Binds a View to an item. final Presenter.ViewHolder onCreateViewHolder(ViewGroup parent) Creates a new View. void onRowViewExpanded(RowPresenter.ViewHolder vh, boolean expanded) Called when the row view's expanded state changes. void onSelectLevelChanged(RowPresenter.ViewHolder vh) Callback when the select level changes. final void onUnbindViewHolder(@NonNull Presenter.ViewHolder viewHolder) Unbinds a View from an item. final void onViewAttachedToWindow(@NonNull Presenter.ViewHolder holder) Called when a view created by this presenter has been attached to a window. final void onViewDetachedFromWindow(@NonNull Presenter.ViewHolder holder) Called when a view created by this presenter has been detached from its window. void setEntranceTransitionState(     @NonNull 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.

Public constructors

PlaybackTransportRowPresenter

Added in 1.1.0

public PlaybackTransportRowPresenter()

Public methods

getDefaultSeekIncrement

Added in 1.1.0

public float getDefaultSeekIncrement()

Get default seek increment if PlaybackSeekDataProvider is null.

Returns
float	float value between 0(inclusive) and 1(inclusive).

getOnActionClickedListener

Added in 1.1.0

public OnActionClickedListener getOnActionClickedListener()

Returns the listener for Action click events.

getProgressColor

Added in 1.1.0

public @ColorInt int getProgressColor()

Returns the primary color for the progress bar. If no color was set, transparent is returned.

getSecondaryProgressColor

Added in 1.1.0

public @ColorInt int getSecondaryProgressColor()

Returns the secondary color for the progress bar. If no color was set, transparent is returned.

onReappear

public void onReappear(RowPresenter.ViewHolder rowViewHolder)

Provides hook to update the UI when the view reappears.

setDefaultSeekIncrement

Added in 1.1.0

public void setDefaultSeekIncrement(float ratio)

Set default seek increment if PlaybackSeekDataProvider is null.

Parameters
float ratio	float value between 0(inclusive) and 1(inclusive).

setDescriptionPresenter

Added in 1.1.0

public void setDescriptionPresenter(Presenter descriptionPresenter)

Parameters
Presenter descriptionPresenter	Presenter for displaying item details.

setOnActionClickedListener

Added in 1.1.0

public void setOnActionClickedListener(OnActionClickedListener listener)

Sets the listener for Action click events.

setProgressColor

Added in 1.1.0

public void setProgressColor(@ColorInt int color)

Sets the primary color for the progress bar. If not set, a default from the theme will be used.

setSecondaryProgressColor

Added in 1.1.0

public void setSecondaryProgressColor(@ColorInt int color)

Sets the secondary color for the progress bar. If not set, a default from the theme playbackProgressSecondaryColor will be used.

Parameters
@ColorInt int color	Color used to draw secondary progress.

Protected methods

createRowViewHolder

Added in 1.2.0-alpha04

protected 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
ViewGroup parent	The parent View for the Row's view holder.

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

onBindRowViewHolder

protected void onBindRowViewHolder(
    @NonNull RowPresenter.ViewHolder holder,
    @NonNull Object item
)

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

onProgressBarClicked

Added in 1.1.0

protected void onProgressBarClicked(PlaybackTransportRowPresenter.ViewHolder vh)

Client of progress bar is clicked, default implementation delegate click to PlayPauseAction.

Parameters
PlaybackTransportRowPresenter.ViewHolder vh	ViewHolder of PlaybackTransportRowPresenter

onRowViewAttachedToWindow

protected void onRowViewAttachedToWindow(@NonNull RowPresenter.ViewHolder vh)

Invoked when the row view is attached to the window.

onRowViewDetachedFromWindow

protected void onRowViewDetachedFromWindow(@NonNull RowPresenter.ViewHolder vh)

Invoked when the row view is detached from the window.

onRowViewSelected

protected void onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected)

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.

onUnbindRowViewHolder

protected void onUnbindRowViewHolder(@NonNull RowPresenter.ViewHolder holder)

Unbinds the given ViewHolder. Derived classes of RowPresenter overriding onUnbindRowViewHolder must call through the super class's implementation of this method.