PlaybackRowPresenter

Kotlin |Java

abstract class PlaybackRowPresenter : RowPresenter

kotlin.Any
↳	androidx.leanback.widget.Presenter
	↳	androidx.leanback.widget.RowPresenter
		↳	androidx.leanback.widget.PlaybackRowPresenter

Known Direct Subclasses

PlaybackControlsRowPresenter, PlaybackTransportRowPresenter

PlaybackControlsRowPresenter	A PlaybackControlsRowPresenter renders a `PlaybackControlsRow` to display a series of playback control buttons.
PlaybackTransportRowPresenter	A PlaybackTransportRowPresenter renders a `PlaybackControlsRow` to display a series of playback control buttons.

Subclass of RowPresenter that can define the desired behavior when the view reappears. This is presently used by PlaybackControlsRowPresenter to update the UI after we show/hide the controls view.

Summary

Nested classes
open	`ViewHolder` This container is used for trapping click events and passing them to the playback controls.

Inherited constants

From class 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
`<init>()` Subclass of `RowPresenter` that can define the desired behavior when the view reappears.

Public methods
open Unit	`onReappear(rowViewHolder: RowPresenter.ViewHolder!)` Provides hook to update the UI when the view reappears.

Inherited functions

From class Presenter

`Unit`	`cancelAnimationsRecursive(view: View!)` Utility method for removing all running animations on a view.
`Any!`	`getFacet(facetClass: Class<*>!)`
`Unit`	`onBindViewHolder(viewHolder: Presenter.ViewHolder!, item: Any!, payloads: MutableList<Any!>!)` Binds a `View` to an item with a list of payloads.
`Unit`	`setFacet(facetClass: Class<*>!, facetImpl: Any!)` Sets dynamic implemented facet in addition to basic Presenter functions.
`Unit`	`setOnClickListener(holder: Presenter.ViewHolder!, listener: OnClickListener!)` Called to set a click listener for the given view holder. The default implementation sets the click listener on the root view in the view holder. If the root view isn't focusable this method should be overridden to set the listener on the appropriate focusable child view(s).

From class RowPresenter

`RowPresenter.ViewHolder!`	`createRowViewHolder(parent: ViewGroup!)` Called to create a ViewHolder object for a Row. Subclasses will override this method to return a different concrete ViewHolder object.
`Unit`	`dispatchItemSelectedListener(vh: RowPresenter.ViewHolder!, selected: Boolean)` This method is only called from `onRowViewSelected(ViewHolder, boolean)` onRowViewSelected. The default behavior is to signal row selected events with a null item parameter. A Subclass of RowPresenter having child items should override this method and dispatch events with item information.
`Unit`	`freeze(holder: RowPresenter.ViewHolder!, freeze: Boolean)` Freezes/unfreezes the row, typically used when a transition starts/ends. This method is called by the fragment, it should not call it directly by the application.
`RowHeaderPresenter!`	`getHeaderPresenter()` Returns the Presenter used for rendering the header, or null if none has been set.
`RowPresenter.ViewHolder!`	`getRowViewHolder(holder: Presenter.ViewHolder!)` Returns the `RowPresenter.ViewHolder` from the given RowPresenter ViewHolder.
`Boolean`	`getSelectEffectEnabled()` Returns true if the row selection effect is enabled. This value not only determines whether the default dim implementation is used, but subclasses must also respect this flag.
`Float`	`getSelectLevel(vh: Presenter.ViewHolder!)` Returns the current select level. The value will be between 0 (unselected) and 1 (selected).
`Int`	`getSyncActivatePolicy()` Returns the policy of updating row view activated status. Can be one of: Default value `SYNC_ACTIVATED_TO_EXPANDED` `SYNC_ACTIVATED_TO_SELECTED` `SYNC_ACTIVATED_TO_EXPANDED_AND_SELECTED` `SYNC_ACTIVATED_CUSTOM`
`Unit`	`initializeRowViewHolder(vh: RowPresenter.ViewHolder!)` Called after a `RowPresenter.ViewHolder` is created for a Row. Subclasses may override this method and start by calling super.initializeRowViewHolder(ViewHolder).
`Boolean`	`isClippingChildren()` Returns true if the Row view should clip its children. The clipChildren flag is set on view in `initializeRowViewHolder(ViewHolder)`. Note that Slide transition or explode transition need turn off clipChildren. Default value is false.
`Boolean`	`isUsingDefaultSelectEffect()` Returns true if this RowPresenter is using the default dimming effect. A subclass may (most likely) return false and override `onSelectLevelChanged(ViewHolder)`.
`Unit`	`onBindRowViewHolder(vh: RowPresenter.ViewHolder!, item: Any!)` 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.
`Unit`	`onBindViewHolder(viewHolder: Presenter.ViewHolder!, item: Any!)`
`Presenter.ViewHolder!`	`onCreateViewHolder(parent: ViewGroup!)`
`Unit`	`onRowViewAttachedToWindow(vh: RowPresenter.ViewHolder!)` Invoked when the row view is attached to the window.
`Unit`	`onRowViewDetachedFromWindow(vh: RowPresenter.ViewHolder!)` Invoked when the row view is detached from the window.
`Unit`	`onRowViewExpanded(vh: RowPresenter.ViewHolder!, expanded: Boolean)` Called when the row view's expanded state changes. A subclass may override this method to respond to expanded state changes of a Row. The default implementation will hide/show the header view. Subclasses may make visual changes to the Row View but must not create animation on the Row view.
`Unit`	`onRowViewSelected(vh: RowPresenter.ViewHolder!, selected: Boolean)` 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.
`Unit`	`onSelectLevelChanged(vh: RowPresenter.ViewHolder!)` Callback when the select level changes. The default implementation applies the select level to `RowHeaderPresenter#setSelectLevel(RowHeaderPresenter.ViewHolder, float)` when `getSelectEffectEnabled()` is true. Subclasses may override this function and implement a different select effect. In this case, the method `isUsingDefaultSelectEffect()` should also be overridden to disable the default dimming effect.
`Unit`	`onUnbindRowViewHolder(vh: RowPresenter.ViewHolder!)` Unbinds the given ViewHolder. Derived classes of `RowPresenter` overriding `onUnbindRowViewHolder(ViewHolder)` must call through the super class's implementation of this method.
`Unit`	`onUnbindViewHolder(viewHolder: Presenter.ViewHolder!)`
`Unit`	`onViewAttachedToWindow(holder: Presenter.ViewHolder!)`
`Unit`	`onViewDetachedFromWindow(holder: Presenter.ViewHolder!)`
`Unit`	`setEntranceTransitionState(holder: RowPresenter.ViewHolder!, afterEntrance: Boolean)` Changes the visibility of views. The entrance transition will be run against the views that change visibilities. A subclass may override and begin with calling super.setEntranceTransitionState(). This method is called by the fragment, it should not be called directly by the application.
`Unit`	`setHeaderPresenter(headerPresenter: RowHeaderPresenter!)` Sets the Presenter used for rendering the header. Can be null to disable header rendering. The method must be called before creating any Row Views.
`Unit`	`setRowViewExpanded(holder: Presenter.ViewHolder!, expanded: Boolean)` Sets the expanded state of a Row view.
`Unit`	`setRowViewSelected(holder: Presenter.ViewHolder!, selected: Boolean)` Sets the selected state of a Row view.
`Unit`	`setSelectEffectEnabled(applyDimOnSelect: Boolean)` Enables or disables the row selection effect. This will not only affect the default dim effect, but subclasses must respect this flag as well.
`Unit`	`setSelectLevel(vh: Presenter.ViewHolder!, level: Float)` Sets the current select level to a value between 0 (unselected) and 1 (selected). Subclasses may override `onSelectLevelChanged(ViewHolder)` to respond to changes in the selected level.
`Unit`	`setSyncActivatePolicy(syncActivatePolicy: Int)` Sets the policy of updating row view activated status. Can be one of: Default value `SYNC_ACTIVATED_TO_EXPANDED` `SYNC_ACTIVATED_TO_SELECTED` `SYNC_ACTIVATED_TO_EXPANDED_AND_SELECTED` `SYNC_ACTIVATED_CUSTOM`

Public constructors

<init>

PlaybackRowPresenter()

Public methods

onReappear

open fun onReappear(rowViewHolder: RowPresenter.ViewHolder!): Unit

Provides hook to update the UI when the view reappears.