belongs to Maven artifact androidx.leanback:leanback:1.0.0-alpha1

PlaybackTransportRowPresenter

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 PlaybackSupportFragment.

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

Summary

Nested classes

class PlaybackTransportRowPresenter.ViewHolder

A ViewHolder for the PlaybackControlsRow supporting seek UI. 

Inherited constants

Public constructors

PlaybackTransportRowPresenter()

Public methods

float getDefaultSeekIncrement()

Get default seek increment if PlaybackSeekDataProvider is null.

OnActionClickedListener getOnActionClickedListener()

Returns the listener for Action click events.

int getProgressColor()

Returns the primary 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(int color)

Sets the primary color for the progress bar.

Protected methods

RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent)

Called to create a ViewHolder object for a Row.

void onBindRowViewHolder(RowPresenter.ViewHolder holder, 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(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 onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected)

Called when the given row view changes selection state.

void onUnbindRowViewHolder(RowPresenter.ViewHolder holder)

Unbinds the given ViewHolder.

Inherited methods

Public constructors

PlaybackTransportRowPresenter

PlaybackTransportRowPresenter ()

Public methods

getDefaultSeekIncrement

float getDefaultSeekIncrement ()

Get default seek increment if PlaybackSeekDataProvider is null.

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

getOnActionClickedListener

OnActionClickedListener getOnActionClickedListener ()

Returns the listener for Action click events.

Returns
OnActionClickedListener

getProgressColor

int getProgressColor ()

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

Returns
int

onReappear

void onReappear (RowPresenter.ViewHolder rowViewHolder)

Provides hook to update the UI when the view reappears.

Parameters
rowViewHolder RowPresenter.ViewHolder

setDefaultSeekIncrement

void setDefaultSeekIncrement (float ratio)

Set default seek increment if PlaybackSeekDataProvider is null.

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

setDescriptionPresenter

void setDescriptionPresenter (Presenter descriptionPresenter)

Parameters
descriptionPresenter Presenter: Presenter for displaying item details.

setOnActionClickedListener

void setOnActionClickedListener (OnActionClickedListener listener)

Sets the listener for Action click events.

Parameters
listener OnActionClickedListener

setProgressColor

void setProgressColor (int color)

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

Parameters
color int

Protected methods

createRowViewHolder

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.

onBindRowViewHolder

void onBindRowViewHolder (RowPresenter.ViewHolder holder, 
                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
holder RowPresenter.ViewHolder

item Object

onProgressBarClicked

void onProgressBarClicked (PlaybackTransportRowPresenter.ViewHolder vh)

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

Parameters
vh PlaybackTransportRowPresenter.ViewHolder: ViewHolder of PlaybackTransportRowPresenter

onRowViewAttachedToWindow

void onRowViewAttachedToWindow (RowPresenter.ViewHolder vh)

Invoked when the row view is attached to the window.

Parameters
vh RowPresenter.ViewHolder

onRowViewDetachedFromWindow

void onRowViewDetachedFromWindow (RowPresenter.ViewHolder vh)

Invoked when the row view is detached from the window.

Parameters
vh RowPresenter.ViewHolder

onRowViewSelected

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.

Parameters
vh RowPresenter.ViewHolder

selected boolean

onUnbindRowViewHolder

void onUnbindRowViewHolder (RowPresenter.ViewHolder holder)

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

Parameters
holder RowPresenter.ViewHolder