PlaybackControlsRowPresenter

class PlaybackControlsRowPresenter : PlaybackRowPresenter

kotlin.Any
   ↳ 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 androidx.leanback.app.PlaybackFragment.

The detailed description is rendered using a Presenter passed in PlaybackControlsRowPresenter. Typically this will be an instance of AbstractDetailsDescriptionPresenter. The application can access the detailed description ViewHolder from mDescriptionViewHolder.

Summary

Nested types

A ViewHolder for the PlaybackControlsRow.

Public constructors

Constructor for a PlaybackControlsRowPresenter.
PlaybackControlsRowPresenter(descriptionPresenter: Presenter?)

Constructor for a PlaybackControlsRowPresenter.

Public functions
Boolean

Returns true if secondary actions are hidden.
@ColorInt Int

Returns the background color.
OnActionClickedListener?

Returns the listener for Action click events.
@ColorInt Int

Returns the primary color for the progress bar.
Unit

Provides hook to update the UI when the view reappears.
Unit

Sets the background color.
Unit

Sets the listener for Action click events.
Unit

Sets the primary color for the progress bar.
Unit

Sets the secondary actions to be hidden behind a "more actions" button.
Unit

Shows or hides space at the bottom of the playback controls row.
Unit

Displays the primary actions.

Protected functions
RowPresenter.ViewHolder

Called to create a ViewHolder object for a Row.
Unit

Binds the given row object to the given ViewHolder.
Unit

Invoked when the row view is attached to the window.
Unit

Invoked when the row view is detached from the window.
Unit

Called when the given row view changes selection state.
Unit

Unbinds the given ViewHolder.

Inherited Constants
From androidx.leanback.widget.RowPresenter
const Int

Don't synchronize row view activated status with selected status or expanded status, application will do its own through setActivated.
const Int

Synchronizes row view's activated status to expand status of the row view holder.
const Int

Sets the row view's activated status to true when both expand and selected are true.
const Int

Synchronizes row view's activated status to selected status of the row view holder.

Inherited functions
From androidx.leanback.widget.FacetProvider
abstract Any?
getFacet(facetClass: Class<Any!>)

Queries optional implemented facet.
From androidx.leanback.widget.Presenter
java-static Unit

Utility method for removing all running animations on a view.
Any!
getFacet(facetClass: Class<Any!>!)

Queries optional implemented facet.
abstract Unit
onBindViewHolder(viewHolder: Presenter.ViewHolder, item: Any?)

Binds a View to an item.
Unit
onBindViewHolder(
    viewHolder: Presenter.ViewHolder,
    item: Any,
    payloads: (Mutable)List<Any!>
)

Binds a View to an item with a list of payloads.
abstract Presenter.ViewHolder

Creates a new View.
abstract Unit

Unbinds a View from an item.
Unit

Called when a view created by this presenter has been attached to a window.
Unit

Called when a view created by this presenter has been detached from its window.
Unit
setFacet(facetClass: Class<Any!>!, facetImpl: Any!)

Sets dynamic implemented facet in addition to basic Presenter functions.
Unit
setOnClickListener(
    holder: Presenter.ViewHolder!,
    listener: View.OnClickListener!
)

Called to set a click listener for the given view holder.
From androidx.leanback.widget.RowPresenter
Unit

This method is only called from onRowViewSelected onRowViewSelected.
Unit

Freezes/unfreezes the row, typically used when a transition starts/ends.
RowHeaderPresenter!

Returns the Presenter used for rendering the header, or null if none has been set.
RowPresenter.ViewHolder!

Returns the RowPresenter.ViewHolder from the given RowPresenter ViewHolder.
Boolean

Returns true if the row selection effect is enabled.
Float

Returns the current select level.
Int

Returns the policy of updating row view activated status.
Unit

Called after a RowPresenter.ViewHolder is created for a Row.
Boolean

Returns true if the Row view should clip its children.
Boolean

Returns true if this RowPresenter is using the default dimming effect.
Unit
onBindViewHolder(viewHolder: Presenter.ViewHolder, item: Any?)

Binds a View to an item.
Presenter.ViewHolder!

Creates a new View.
Unit

Called when the row view's expanded state changes.
Unit

Callback when the select level changes.
Unit

Unbinds a View from an item.
Unit

Called when a view created by this presenter has been attached to a window.
Unit

Called when a view created by this presenter has been detached from its window.
Unit
setEntranceTransitionState(
    holder: RowPresenter.ViewHolder,
    afterEntrance: Boolean
)

Changes the visibility of views.
Unit

Sets the Presenter used for rendering the header.
Unit

Sets the expanded state of a Row view.
Unit

Sets the selected state of a Row view.
Unit
setSelectEffectEnabled(applyDimOnSelect: Boolean)

Enables or disables the row selection effect.
Unit

Sets the current select level to a value between 0 (unselected) and 1 (selected).
Unit
setSyncActivatePolicy(syncActivatePolicy: Int)

Sets the policy of updating row view activated status.

Public constructors

PlaybackControlsRowPresenter

Added in 1.1.0
PlaybackControlsRowPresenter()

Constructor for a PlaybackControlsRowPresenter.

PlaybackControlsRowPresenter

Added in 1.1.0
PlaybackControlsRowPresenter(descriptionPresenter: Presenter?)

Constructor for a PlaybackControlsRowPresenter.

Parameters
descriptionPresenter: Presenter?

Presenter for displaying item details.

Public functions

areSecondaryActionsHidden

Added in 1.1.0
fun areSecondaryActionsHidden(): Boolean

Returns true if secondary actions are hidden.

getBackgroundColor

Added in 1.1.0
fun getBackgroundColor(): @ColorInt Int

Returns the background color. If no background color was set, transparent is returned.

getOnActionClickedListener

Added in 1.1.0
fun getOnActionClickedListener(): OnActionClickedListener?

Returns the listener for Action click events.

getProgressColor

Added in 1.1.0
fun getProgressColor(): @ColorInt Int

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

onReappear

fun onReappear(rowViewHolder: RowPresenter.ViewHolder): Unit

Provides hook to update the UI when the view reappears.

setBackgroundColor

Added in 1.1.0
fun setBackgroundColor(color: @ColorInt Int): Unit

Sets the background color. If not set, a default from the theme will be used.

setOnActionClickedListener

Added in 1.1.0
fun setOnActionClickedListener(listener: OnActionClickedListener?): Unit

Sets the listener for Action click events.

setProgressColor

Added in 1.1.0
fun setProgressColor(color: @ColorInt Int): Unit

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

setSecondaryActionsHidden

Added in 1.1.0
fun setSecondaryActionsHidden(hidden: Boolean): Unit

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.

showBottomSpace

Added in 1.1.0
fun showBottomSpace(
    vh: PlaybackControlsRowPresenter.ViewHolder,
    show: Boolean
): Unit

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.

showPrimaryActions

Added in 1.1.0
fun showPrimaryActions(vh: PlaybackControlsRowPresenter.ViewHolder): Unit

Displays the primary actions. This will override the user having selected "more actions" to display the secondary actions; see setSecondaryActionsHidden.

Protected functions

createRowViewHolder

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

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 fun onBindRowViewHolder(holder: RowPresenter.ViewHolder, item: Any): Unit

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.

onRowViewAttachedToWindow

protected fun onRowViewAttachedToWindow(vh: RowPresenter.ViewHolder): Unit

Invoked when the row view is attached to the window.

onRowViewDetachedFromWindow

protected fun onRowViewDetachedFromWindow(vh: RowPresenter.ViewHolder): Unit

Invoked when the row view is detached from the window.

onRowViewSelected

protected fun onRowViewSelected(vh: RowPresenter.ViewHolder, selected: Boolean): Unit

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 fun onUnbindRowViewHolder(holder: RowPresenter.ViewHolder): Unit

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