DetailsOverviewRow
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 Action
s that can be taken for the item.
Actions
Application usessetActionsAdapter(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 callsetItem(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 for changes of DetailsOverviewRow. |
Public constructors | |
---|---|
Constructor for a DetailsOverviewRow. |
Public methods | |
---|---|
Unit |
Adds an Action to the overview. |
Unit |
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!>! |
Returns a read-only view of the list of Actions of this details overview. |
ObjectAdapter! |
Returns the |
Drawable! |
Returns the image drawable of this details overview. |
Any! |
getItem() Returns the main item for the details page. |
open Boolean |
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 |
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 |
Sets the main item for the details page. |
Inherited functions | |
---|---|
Public constructors
<init>
DetailsOverviewRow(item: Any!)
Constructor for a DetailsOverviewRow.
Parameters | |
---|---|
item |
Any!: The main item for the details page. |
Public methods
addAction
funaddAction(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
funaddAction(
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
fungetActions(): 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. |
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. |
isImageScaleUpAllowed
open fun isImageScaleUpAllowed(): Boolean
Returns true if the image may be scaled up; false otherwise.
removeAction
funremoveAction(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.