PlaybackControlsRowPresenter

Kotlin |Java

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

From class androidx.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 `RowPresenter.ViewHolder.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
`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 `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`	`setBackgroundColor(int color)` Sets the background color.
`void`	`setOnActionClickedListener(OnActionClickedListener listener)` Sets the listener for `Action` click events.
`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

From class


        
          androidx.leanback.widget.PlaybackRowPresenter


      onReappear(RowPresenter.ViewHolder rowViewHolder)

Provides hook to update the UI when the view reappears.

From class


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


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


        
          androidx.leanback.widget.FacetProvider


        abstract
        
        
        
        
        Object


      getFacet(Class<?> facetClass)

Queries optional implemented facet.

Public constructors

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`

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`

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`

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`

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.

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`

protected void onRowViewAttachedToWindow (RowPresenter.ViewHolder vh)

Invoked when the row view is attached to the window.

Parameters
`vh`	`RowPresenter.ViewHolder`

protected void onRowViewDetachedFromWindow (RowPresenter.ViewHolder vh)

Invoked when the row view is detached from the window.

Parameters
`vh`	`RowPresenter.ViewHolder`

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`

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`

PlaybackControlsRowPresenter

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

PlaybackControlsRowPresenter

PlaybackControlsRowPresenter

Public methods

areSecondaryActionsHidden

getBackgroundColor

getOnActionClickedListener

getProgressColor

onReappear

setBackgroundColor

setOnActionClickedListener

setProgressColor

setSecondaryActionsHidden

showBottomSpace

showPrimaryActions

Protected methods

createRowViewHolder

onBindRowViewHolder

onRowViewAttachedToWindow

onRowViewDetachedFromWindow

onRowViewSelected

onUnbindRowViewHolder