PlaybackControlsRowPresenter
public
class
PlaybackControlsRowPresenter
extends PlaybackRowPresenter
java.lang.Object | ||||
↳ | androidx.leanback.widget.Presenter | |||
↳ | androidx.leanback.widget.RowPresenter | |||
↳ | androidx.leanback.widget.PlaybackRowPresenter | |||
↳ | androidx.leanback.widget.PlaybackControlsRowPresenter |
A PlaybackControlsRowPresenter 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 PlaybackFragment
.
The detailed description is rendered using a Presenter
passed in
PlaybackControlsRowPresenter(Presenter)
. Typically this will be an instance of
AbstractDetailsDescriptionPresenter
. The application can access the
detailed description ViewHolder from PlaybackControlsRowPresenter.ViewHolder.mDescriptionViewHolder
.
Summary
Nested classes | |
---|---|
class |
PlaybackControlsRowPresenter.ViewHolder
A ViewHolder for the PlaybackControlsRow. |
Inherited constants |
---|
Public constructors | |
---|---|
PlaybackControlsRowPresenter(Presenter descriptionPresenter)
Constructor for a PlaybackControlsRowPresenter. |
|
PlaybackControlsRowPresenter()
Constructor for a PlaybackControlsRowPresenter. |
Public methods | |
---|---|
boolean
|
areSecondaryActionsHidden()
Returns true if secondary actions are hidden. |
int
|
getBackgroundColor()
Returns the background color. |
OnActionClickedListener
|
getOnActionClickedListener()
Returns the listener for |
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
|
setBackgroundColor(int color)
Sets the background color. |
void
|
setOnActionClickedListener(OnActionClickedListener listener)
Sets the listener for |
void
|
setProgressColor(int color)
Sets the primary color for the progress bar. |
void
|
setSecondaryActionsHidden(boolean hidden)
Sets the secondary actions to be hidden behind a "more actions" button. |
void
|
showBottomSpace(PlaybackControlsRowPresenter.ViewHolder vh, boolean show)
Shows or hides space at the bottom of the playback controls row. |
void
|
showPrimaryActions(PlaybackControlsRowPresenter.ViewHolder vh)
Displays the primary actions. |
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
|
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
PlaybackControlsRowPresenter
public PlaybackControlsRowPresenter (Presenter descriptionPresenter)
Constructor for a PlaybackControlsRowPresenter.
Parameters | |
---|---|
descriptionPresenter |
Presenter : Presenter for displaying item details.
|
PlaybackControlsRowPresenter
public PlaybackControlsRowPresenter ()
Constructor for a PlaybackControlsRowPresenter.
Public methods
areSecondaryActionsHidden
public boolean areSecondaryActionsHidden ()
Returns true if secondary actions are hidden.
Returns | |
---|---|
boolean |
getBackgroundColor
public int getBackgroundColor ()
Returns the background color. If no background color was set, transparent is returned.
Returns | |
---|---|
int |
getOnActionClickedListener
public OnActionClickedListener getOnActionClickedListener ()
Returns the listener for Action
click events.
Returns | |
---|---|
OnActionClickedListener |
getProgressColor
public int getProgressColor ()
Returns the primary color for the progress bar. If no color was set, transparent is returned.
Returns | |
---|---|
int |
onReappear
public void onReappear (RowPresenter.ViewHolder rowViewHolder)
Provides hook to update the UI when the view reappears.
Parameters | |
---|---|
rowViewHolder |
RowPresenter.ViewHolder |
setBackgroundColor
public void setBackgroundColor (int color)
Sets the background color. If not set, a default from the theme will be used.
Parameters | |
---|---|
color |
int |
setOnActionClickedListener
public void setOnActionClickedListener (OnActionClickedListener listener)
Sets the listener for Action
click events.
Parameters | |
---|---|
listener |
OnActionClickedListener |
setProgressColor
public 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 |
setSecondaryActionsHidden
public void setSecondaryActionsHidden (boolean hidden)
Sets the secondary actions to be hidden behind a "more actions" button. When "more actions" is selected, the primary actions are replaced with the secondary actions.
Parameters | |
---|---|
hidden |
boolean |
showBottomSpace
public void showBottomSpace (PlaybackControlsRowPresenter.ViewHolder vh, boolean show)
Shows or hides space at the bottom of the playback controls row. This allows the row to hug the bottom of the display when no other rows are present.
Parameters | |
---|---|
vh |
PlaybackControlsRowPresenter.ViewHolder |
show |
boolean |
showPrimaryActions
public void showPrimaryActions (PlaybackControlsRowPresenter.ViewHolder vh)
Displays the primary actions. This will override the user having selected "more actions"
to display the secondary actions; see setSecondaryActionsHidden(boolean)
.
Parameters | |
---|---|
vh |
PlaybackControlsRowPresenter.ViewHolder |
Protected methods
createRowViewHolder
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 | |
---|---|
parent |
ViewGroup : The parent View for the Row's view holder. |
Returns | |
---|---|
RowPresenter.ViewHolder |
A ViewHolder for the Row's View. |
onBindRowViewHolder
protected 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 |
onRowViewAttachedToWindow
protected void onRowViewAttachedToWindow (RowPresenter.ViewHolder vh)
Invoked when the row view is attached to the window.
Parameters | |
---|---|
vh |
RowPresenter.ViewHolder |
onRowViewDetachedFromWindow
protected void onRowViewDetachedFromWindow (RowPresenter.ViewHolder vh)
Invoked when the row view is detached from the window.
Parameters | |
---|---|
vh |
RowPresenter.ViewHolder |
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.
Parameters | |
---|---|
vh |
RowPresenter.ViewHolder |
selected |
boolean |
onUnbindRowViewHolder
protected 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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-02-24 UTC.