DetailsOverviewRowPresenter

Kotlin |Java

open class DetailsOverviewRowPresenter : RowPresenter

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

Renders a DetailsOverviewRow to display an overview of an item. Typically this row will be the first row in a fragment such as the DetailsFragment. The View created by the DetailsOverviewRowPresenter is made in three parts: ImageView on the left, action list view on the bottom and a customizable detailed description view on the right.

The detailed description is rendered using a Presenter passed in DetailsOverviewRowPresenter(Presenter). Typically this will be an instance of AbstractDetailsDescriptionPresenter. The application can access the detailed description ViewHolder from ViewHolder#mDetailsDescriptionViewHolder.

To participate in activity transition, call setSharedElementEnterTransition(Activity, * String) during Activity's onCreate().

Because transition support and layout are fully controlled by DetailsOverviewRowPresenter, developer can not override DetailsOverviewRowPresenter.ViewHolder for adding/replacing views of DetailsOverviewRowPresenter. If further customization is required beyond replacing the detailed description, the application should create a new row presenter class.

Summary

Nested classes
	`ViewHolder` A ViewHolder for the DetailsOverviewRow.

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>(detailsPresenter: Presenter!)` Constructor for a DetailsOverviewRowPresenter.

Public methods
open Int	`getBackgroundColor()` Returns the background color.
open OnActionClickedListener!	`getOnActionClickedListener()` Returns the listener for Action click events.
open Boolean	`isStyleLarge()` Returns true if the layout style is large.
Boolean	`isUsingDefaultSelectEffect()`
open Unit	`setBackgroundColor(@ColorInt color: Int)` Sets the background color.
open Unit	`setOnActionClickedListener(listener: OnActionClickedListener!)` Sets the listener for Action click events.
Unit	`setSharedElementEnterTransition(activity: Activity!, sharedElementName: String!, timeoutMs: Long)` Sets the enter transition of target activity to be transiting into overview row created by this presenter.
Unit	`setSharedElementEnterTransition(activity: Activity!, sharedElementName: String!)` Sets the enter transition of target activity to be transiting into overview row created by this presenter.
open Unit	`setStyleLarge(large: Boolean)` Sets the layout style to be large or small.

Protected methods
open RowPresenter.ViewHolder!	`createRowViewHolder(parent: ViewGroup!)`
open Unit	`onBindRowViewHolder(holder: RowPresenter.ViewHolder!, item: Any!)`
open Unit	`onRowViewAttachedToWindow(vh: RowPresenter.ViewHolder!)`
open Unit	`onRowViewDetachedFromWindow(vh: RowPresenter.ViewHolder!)`
open Unit	`onRowViewSelected(vh: RowPresenter.ViewHolder!, selected: Boolean)`
open Unit	`onSelectLevelChanged(holder: RowPresenter.ViewHolder!)`
open Unit	`onUnbindRowViewHolder(holder: RowPresenter.ViewHolder!)`

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

`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.
`Unit`	`onBindViewHolder(viewHolder: Presenter.ViewHolder!, item: Any!)`
`Presenter.ViewHolder!`	`onCreateViewHolder(parent: ViewGroup!)`
`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`	`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>

DetailsOverviewRowPresenter(detailsPresenter: Presenter!)

Constructor for a DetailsOverviewRowPresenter.

Parameters
`detailsPresenter`	Presenter!: The `Presenter` used to render the detailed description of the row.

Public methods

getBackgroundColor

@ColorInt open fun getBackgroundColor(): Int

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

getOnActionClickedListener

open fun getOnActionClickedListener(): OnActionClickedListener!

Returns the listener for Action click events.

isStyleLarge

open fun isStyleLarge(): Boolean

Returns true if the layout style is large.

isUsingDefaultSelectEffect

fun isUsingDefaultSelectEffect(): Boolean

setBackgroundColor

open fun setBackgroundColor(@ColorInt color: Int): Unit

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

setOnActionClickedListener

open fun setOnActionClickedListener(listener: OnActionClickedListener!): Unit

Sets the listener for Action click events.

setSharedElementEnterTransition

fun setSharedElementEnterTransition(
    activity: Activity!, 
    sharedElementName: String!, 
    timeoutMs: Long
): Unit

Sets the enter transition of target activity to be transiting into overview row created by this presenter. The transition will be cancelled if the overview image is not loaded in the timeout period.

It assumes shared element passed from calling activity is an ImageView; the shared element transits to overview image on the starting edge of the detail overview row, while bounds of overview row grows and reveals text and action buttons.

The method must be invoked in target Activity's onCreate().

setSharedElementEnterTransition

fun setSharedElementEnterTransition(
    activity: Activity!, 
    sharedElementName: String!
): Unit

Sets the enter transition of target activity to be transiting into overview row created by this presenter. The transition will be cancelled if overview image is not loaded in a default timeout period.

The method must be invoked in target Activity's onCreate().

setStyleLarge

open fun setStyleLarge(large: Boolean): Unit

Sets the layout style to be large or small. This affects the height of the overview, including the text description. The default is large.

Protected methods

createRowViewHolder

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

onBindRowViewHolder

protected open fun onBindRowViewHolder(
    holder: RowPresenter.ViewHolder!, 
    item: Any!
): Unit

onRowViewAttachedToWindow

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

onRowViewDetachedFromWindow

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

onRowViewSelected

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

onSelectLevelChanged

protected open fun onSelectLevelChanged(holder: RowPresenter.ViewHolder!): Unit

onUnbindRowViewHolder

protected open fun onUnbindRowViewHolder(holder: RowPresenter.ViewHolder!): Unit