DetailsOverviewRow

Kotlin |Java

open class DetailsOverviewRow : Row

kotlin.Any
↳	androidx.leanback.widget.Row
	↳	androidx.leanback.widget.DetailsOverviewRow

An overview Row for a details fragment. This row consists of an image, a description view, and optionally a series of Actions that can be taken for the item.

Actions

Application uses setActionsAdapter(ObjectAdapter) to set actions on the overview row. SparseArrayObjectAdapter is recommended for easily updating actions while maintaining the order. The application can add or remove actions on the UI thread after the row is bound to a view.

Updating main item

After the row is bound to a view, the application may call setItem(Object) on UI thread and the view will be updated.

Updating image

After the row is bound to view, the application may change the image by calling or setImageDrawable(Drawable) on the UI thread, and the view will be updated.

Summary

Nested classes
open	`Listener` Listener for changes of DetailsOverviewRow.

Public constructors
`<init>(item: Any!)` Constructor for a DetailsOverviewRow.

Public methods
Unit	`addAction(action: Action!)` Adds an Action to the overview.
Unit	`addAction(pos: Int, action: Action!)` Adds an Action to the overview at the specified position.
open Action!	`getActionForKeyCode(keyCode: Int)` Returns the Action associated with the given keycode, or null if no associated action exists.
MutableList<Action!>!	`getActions()` Returns a read-only view of the list of Actions of this details overview.
ObjectAdapter!	`getActionsAdapter()` Returns the `ObjectAdapter` for actions.
Drawable!	`getImageDrawable()` Returns the image drawable of this details overview.
Any!	`getItem()` Returns the main item for the details page.
open Boolean	`isImageScaleUpAllowed()` Returns true if the image may be scaled up; false otherwise.
Boolean	`removeAction(action: Action!)` Removes the given Action from the overview.
Unit	`setActionsAdapter(adapter: ObjectAdapter!)` Sets the `ObjectAdapter` for actions.
Unit	`setImageBitmap(context: Context!, bm: Bitmap!)` Sets a Bitmap as the image of this details overview.
Unit	`setImageDrawable(drawable: Drawable!)` Sets a drawable as the image of this details overview.
open Unit	`setImageScaleUpAllowed(allowed: Boolean)` Allows or disallows scaling up of images.
Unit	`setItem(item: Any!)` Sets the main item for the details page.

Inherited functions

From class Row

`HeaderItem!`	`getHeaderItem()` Returns the `HeaderItem` that represents metadata for the row.
`Long`	`getId()` Returns a unique identifier for this row. This id can come from one of three places: If `setId(long)` is ever called on this row, it will return this id. If `setId(long)` has not been called but the header item is not null, the result of `HeaderItem#getId()` is returned. Otherwise `NO_ID` is returned.
`Boolean`	`isRenderedAsRowView()` Returns true if this Row can be rendered in a visible row view, false otherwise. For example `ListRow` is rendered by `ListRowPresenter`. `PageRow`, `SectionRow`, `DividerRow` are rendered as invisible row views.
`Unit`	`setHeaderItem(headerItem: HeaderItem!)` Sets the `HeaderItem` that represents metadata for the row.
`Unit`	`setId(id: Long)` Sets the id for this row.

Public constructors

<init>

DetailsOverviewRow(item: Any!)

Constructor for a DetailsOverviewRow.

Parameters
`item`	Any!: The main item for the details page.

Public methods

addAction

fun addAction(action: Action!): Unit

Deprecated: Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

Adds an Action to the overview. It will throw ClassCastException if the current actions adapter is not an instance of ArrayObjectAdapter. Must be called on the UI thread.

Parameters
`action`	Action!: The Action to add.

addAction

fun addAction(
    pos: Int, 
    action: Action!
): Unit

Deprecated: Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

Adds an Action to the overview at the specified position. It will throw ClassCastException if current actions adapter is not an instance of fArrayObjectAdapter. Must be called on the UI thread.

Parameters
`pos`	Int: The position to insert the Action.
`action`	Action!: The Action to add.

getActionForKeyCode

open fun getActionForKeyCode(keyCode: Int): Action!

Returns the Action associated with the given keycode, or null if no associated action exists.

getActions

fun getActions(): MutableList<Action!>!

Deprecated: Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

Returns a read-only view of the list of Actions of this details overview. It will throw ClassCastException if current actions adapter is not ArrayObjectAdapter. Must be called on UI thread.

Return
`MutableList<Action!>!`	An unmodifiable view of the list of Actions.

getActionsAdapter

fun getActionsAdapter(): ObjectAdapter!

Returns the ObjectAdapter for actions.

getImageDrawable

fun getImageDrawable(): Drawable!

Returns the image drawable of this details overview.

Return
`Drawable!`	The overview's image drawable, or null if no drawable has been assigned.

getItem

fun getItem(): Any!

Returns the main item for the details page.

isImageScaleUpAllowed

open fun isImageScaleUpAllowed(): Boolean

Returns true if the image may be scaled up; false otherwise.

removeAction

fun removeAction(action: Action!): Boolean

Deprecated: Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

Removes the given Action from the overview. It will throw ClassCastException if current actions adapter is not ArrayObjectAdapter. Must be called on UI thread.

Parameters
`action`	Action!: The Action to remove.

Return
`Boolean`	true if the overview contained the specified Action.

setActionsAdapter

fun setActionsAdapter(adapter: ObjectAdapter!): Unit

Sets the ObjectAdapter for actions. A default PresenterSelector will be attached to the adapter if it doesn't have one.

Parameters
`adapter`	ObjectAdapter!: Adapter for actions.

setImageBitmap

fun setImageBitmap(
    context: Context!, 
    bm: Bitmap!
): Unit

Sets a Bitmap as the image of this details overview. Must be called on UI thread after row is bound to view.

Parameters
`context`	Context!: The context to retrieve display metrics from.
`bm`	Bitmap!: The bitmap to set.

setImageDrawable

fun setImageDrawable(drawable: Drawable!): Unit

Sets a drawable as the image of this details overview. Must be called on UI thread after row is bound to view.

Parameters
`drawable`	Drawable!: The drawable to set.

setImageScaleUpAllowed

open fun setImageScaleUpAllowed(allowed: Boolean): Unit

Allows or disallows scaling up of images. Images will always be scaled down if necessary. Must be called on UI thread after row is bound to view.