# DetailsOverviewRow # DetailsOverviewRow Artifact:[androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/widget/DetailsOverviewRow.java+class:androidx.leanback.widget.DetailsOverviewRow) Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/widget/DetailsOverviewRow "View this page in Java")
``` class DetailsOverviewRow : Row ```
|---|---|-------------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) ||| | ↳ | [androidx.leanback.widget.Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row) || | | ↳ | [androidx.leanback.widget.DetailsOverviewRow](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow) | *** ** * ** *** An overview[Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row)for a details fragment. This row consists of an image, a description view, and optionally a series of[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)s that can be taken for the item. ### Actions Application uses[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))to set actions on the overview row.[SparseArrayObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/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](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setItem(java.lang.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[setImageBitmap](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setImageBitmap(android.content.Context,android.graphics.Bitmap))or[setImageDrawable](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setImageDrawable(android.graphics.drawable.Drawable))on the UI thread, and the view will be updated. ## Summary | ### Nested types | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `class `[DetailsOverviewRow.Listener](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow.Listener) Listener for changes of DetailsOverviewRow. | | ### Public constructors | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [DetailsOverviewRow](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#DetailsOverviewRow(java.lang.Object))`(item: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`)` Constructor for a DetailsOverviewRow. | | ### Public functions | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | ~~[addAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#addAction(androidx.leanback.widget.Action))~~`(action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!)` **This function is deprecated.** Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter())
| | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | ~~[addAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#addAction(int,androidx.leanback.widget.Action))~~`(pos: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`, action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!)` **This function is deprecated.** Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter())
| | [Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`?` | [getActionForKeyCode](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionForKeyCode(int))`(keyCode: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Returns the Action associated with the given keycode, or null if no associated action exists. | | `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!>!` | ~~[getActions](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActions())~~`()` **This function is deprecated.** Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter())
| | [ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter) | [getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter())`()` Returns the[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter)for actions. | | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?` | [getImageDrawable](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getImageDrawable())`()` Returns the image drawable of this details overview. | | [Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) | [getItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getItem())`()` Returns the main item for the details page. | | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isImageScaleUpAllowed](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#isImageScaleUpAllowed())`()` Returns true if the image may be scaled up; false otherwise. | | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | ~~[removeAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#removeAction(androidx.leanback.widget.Action))~~`(action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!)` **This function is deprecated.** Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter())
| | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))`(adapter: `[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter)`)` Sets the[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter)for actions. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setImageBitmap](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setImageBitmap(android.content.Context,android.graphics.Bitmap))`(context: `[Context](https://developer.android.com/reference/android/content/Context.html)`, bm: `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html)`)` Sets a Bitmap as the image of this details overview. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setImageDrawable](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setImageDrawable(android.graphics.drawable.Drawable))`(drawable: `[Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?)` Sets a drawable as the image of this details overview. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setImageScaleUpAllowed](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setImageScaleUpAllowed(boolean))`(allowed: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Allows or disallows scaling up of images. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setItem(java.lang.Object))`(item: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`)` Sets the main item for the details page. | | ### Inherited functions | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From[androidx.leanback.widget.Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row) |-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [HeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/HeaderItem)`!` | [getHeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row#getHeaderItem())`()` Returns the[HeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/HeaderItem)that represents metadata for the row. | | [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getId](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row#getId())`()` Returns a unique identifier for this row. | | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isRenderedAsRowView](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row#isRenderedAsRowView())`()` Returns true if this Row can be rendered in a visible row view, false otherwise. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setHeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row#setHeaderItem(androidx.leanback.widget.HeaderItem))`(headerItem: `[HeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/HeaderItem)`!)` Sets the[HeaderItem](https://developer.android.com/reference/kotlin/androidx/leanback/widget/HeaderItem)that represents metadata for the row. | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setId](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row#setId(long))`(id: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` Sets the id for this row. | | ## Public constructors ### DetailsOverviewRow Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` DetailsOverviewRow(item: Any) ``` Constructor for a DetailsOverviewRow. | Parameters | |-------------------------------------------------------------------------------------|-------------------------------------| | `item: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) | The main item for the details page. | ## Public functions ### addAction Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun [addAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#addAction(androidx.leanback.widget.Action))(action: Action!): Unit ``` | **This function is deprecated.** | | Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter()) Adds an Action to the overview. It will throw ClassCastException if the current actions adapter is not an instance of[ArrayObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ArrayObjectAdapter). Must be called on the UI thread. | Parameters | |-------------------------------------------------------------------------------------------------------|--------------------| | `action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!` | The Action to add. | ### addAction Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun [addAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#addAction(int,androidx.leanback.widget.Action))(pos: Int, action: Action!): Unit ``` | **This function is deprecated.** | | Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter()) Adds an Action to the overview at the specified position. It will throw ClassCastException if current actions adapter is not an instance of f[ArrayObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ArrayObjectAdapter). Must be called on the UI thread. | Parameters | |-------------------------------------------------------------------------------------------------------|------------------------------------| | `pos: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The position to insert the Action. | | `action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!` | The Action to add. | ### getActionForKeyCode Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun getActionForKeyCode(keyCode: Int): Action? ``` Returns the Action associated with the given keycode, or null if no associated action exists. ### getActions Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun [getActions](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActions())(): (Mutable)List! ``` | **This function is deprecated.** | | Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#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](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ArrayObjectAdapter). Must be called on UI thread. | Returns | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| | `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!>!` | An unmodifiable view of the list of Actions. | ### getActionsAdapter Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun getActionsAdapter(): ObjectAdapter ``` Returns the[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter)for actions. ### getImageDrawable Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun getImageDrawable(): Drawable? ``` Returns the image drawable of this details overview. | Returns | |------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| | [Drawable](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?` | The overview's image drawable, or null if no drawable has been assigned. | ### getItem Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun getItem(): Any ``` Returns the main item for the details page. ### isImageScaleUpAllowed Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun isImageScaleUpAllowed(): Boolean ``` Returns true if the image may be scaled up; false otherwise. ### removeAction Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) Deprecated in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun [removeAction](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#removeAction(androidx.leanback.widget.Action))(action: Action!): Boolean ``` | **This function is deprecated.** | | Use[setActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#setActionsAdapter(androidx.leanback.widget.ObjectAdapter))and[getActionsAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/DetailsOverviewRow#getActionsAdapter()) Removes the given Action from the overview. It will throw ClassCastException if current actions adapter is not[ArrayObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ArrayObjectAdapter). Must be called on UI thread. | Parameters | |-------------------------------------------------------------------------------------------------------|-----------------------| | `action: `[Action](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Action)`!` | The Action to remove. | | Returns | |-------------------------------------------------------------------------------------|------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | true if the overview contained the specified Action. | ### setActionsAdapter Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun setActionsAdapter(adapter: ObjectAdapter): Unit ``` Sets the[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter)for actions. A default[PresenterSelector](https://developer.android.com/reference/kotlin/androidx/leanback/widget/PresenterSelector)will be attached to the adapter if it doesn't have one. | Parameters | |-------------------------------------------------------------------------------------------------------------------|----------------------| | `adapter: `[ObjectAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ObjectAdapter) | Adapter for actions. | ### setImageBitmap Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` 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](https://developer.android.com/reference/android/content/Context.html) | The context to retrieve display metrics from. | | `bm: `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap.html) | The bitmap to set. | ### setImageDrawable Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` 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](https://developer.android.com/reference/android/graphics/drawable/Drawable.html)`?` | The drawable to set. | ### setImageScaleUpAllowed Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` 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. ### setItem Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0) ``` fun setItem(item: Any): Unit ``` Sets the main item for the details page. Must be called on UI thread after row is bound to view.