FullWidthDetailsOverviewRowPresenter

Kotlin |Java

open class FullWidthDetailsOverviewRowPresenter : RowPresenter

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

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

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

The logo view is rendered using a customizable DetailsOverviewLogoPresenter passed in FullWidthDetailsOverviewRowPresenter(Presenter, DetailsOverviewLogoPresenter). The application can access the logo ViewHolder from ViewHolder#getLogoViewHolder().

To support activity shared element transition, call setListener(Listener) with FullWidthDetailsOverviewSharedElementHelper during Activity's onCreate(). Application is free to create its own "shared element helper" class using the Listener for image binding. Call setParticipatingEntranceTransition(boolean) with false

The view has three states: STATE_HALF STATE_FULL and STATE_SMALL. See androidx.leanback.app.DetailsFragment where it switches states based on selected row position.

Summary

Nested classes
abstract	`Listener` Listeners for events on ViewHolder.
open	`ViewHolder` A ViewHolder for the DetailsOverviewRow.

Constants
static Int	`ALIGN_MODE_MIDDLE` This is the alignment mode that the ending edge of logo and the starting edge of description align to the middle of the overview view.
static Int	`ALIGN_MODE_START` This is the alignment mode that the logo and description align to the starting edge of the overview view.
static Int	`STATE_FULL` This is the state when the view covers full width and height of screen.
static Int	`STATE_HALF` This is the default state corresponding to layout file.
static Int	`STATE_SMALL` This is the state where the view shrinks to a small banner.

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 FullWidthDetailsOverviewRowPresenter.
`<init>(detailsPresenter: Presenter!, logoPresenter: DetailsOverviewLogoPresenter!)` Constructor for a FullWidthDetailsOverviewRowPresenter.

Public methods
Int	`getActionsBackgroundColor()` Returns the background color of actions.
Int	`getAlignmentMode()` Returns alignment mode of Description.
Int	`getBackgroundColor()` Returns the background color.
Int	`getInitialState()` Returns the initial state used to create ViewHolder.
open OnActionClickedListener!	`getOnActionClickedListener()` Returns the listener for Action click events.
Boolean	`isParticipatingEntranceTransition()` Returns true if the overview should be part of shared element transition.
Boolean	`isUsingDefaultSelectEffect()`
Unit	`notifyOnBindLogo(viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!)` Called by `DetailsOverviewLogoPresenter` to notify logo was bound to view.
Unit	`setActionsBackgroundColor(color: Int)` Sets the background color for Action Bar.
Unit	`setAlignmentMode(alignmentMode: Int)` Set alignment mode of Description.
Unit	`setBackgroundColor(color: Int)` Sets the background color.
open Unit	`setEntranceTransitionState(holder: RowPresenter.ViewHolder!, afterEntrance: Boolean)`
Unit	`setInitialState(state: Int)` Change the initial state used to create ViewHolder.
Unit	`setListener(listener: FullWidthDetailsOverviewRowPresenter.Listener!)` Set listener for details overview presenter.
open Unit	`setOnActionClickedListener(listener: OnActionClickedListener!)` Sets the listener for Action click events.
Unit	`setParticipatingEntranceTransition(participating: Boolean)` Sets if the overview should be part of shared element transition.
Unit	`setState(viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!, state: Int)` Switch state of a ViewHolder.

Protected methods
open RowPresenter.ViewHolder!	`createRowViewHolder(parent: ViewGroup!)`
open Int	`getLayoutResourceId()` Get resource id to inflate the layout.
open Boolean	`isClippingChildren()`
open Unit	`onBindRowViewHolder(holder: RowPresenter.ViewHolder!, item: Any!)`
open Unit	`onLayoutLogo(viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!, oldState: Int, logoChanged: Boolean)` Layout logo position based on current state.
open Unit	`onLayoutOverviewFrame(viewHolder: FullWidthDetailsOverviewRowPresenter.ViewHolder!, oldState: Int, logoChanged: Boolean)` Layout overview frame based on current state.
open Unit	`onRowViewAttachedToWindow(vh: RowPresenter.ViewHolder!)`
open Unit	`onRowViewDetachedFromWindow(vh: RowPresenter.ViewHolder!)`
open Unit	`onSelectLevelChanged(holder: RowPresenter.ViewHolder!)`
open Unit	`onStateChanged(`