Stay organized with collections Save and categorize content based on your preferences.

DetailsOverviewRow

public class DetailsOverviewRow extends Row

java.lang.Object
   ↳ 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 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 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 or setImageDrawable on the UI thread, and the view will be updated.

Summary

Nested types
DetailsOverviewRow.Listener

Listener for changes of DetailsOverviewRow.

Public constructors

Constructor for a DetailsOverviewRow.

Public methods
final void
addAction(Action action)

This method is deprecated.

Use setActionsAdapter and getActionsAdapter
final void
addAction(int pos, Action action)

This method is deprecated.

Use setActionsAdapter and getActionsAdapter
Action
getActionForKeyCode(int keyCode)

Returns the Action associated with the given keycode, or null if no associated action exists.
final List<Action>

This method is deprecated.

Use setActionsAdapter and getActionsAdapter
final ObjectAdapter

Returns the ObjectAdapter for actions.
final Drawable

Returns the image drawable of this details overview.
final Object

Returns the main item for the details page.
boolean

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

This method is deprecated.

Use setActionsAdapter and getActionsAdapter
final void

Sets the ObjectAdapter for actions.
final void
setImageBitmap(Context context, Bitmap bm)

Sets a Bitmap as the image of this details overview.
final void

Sets a drawable as the image of this details overview.
void
setImageScaleUpAllowed(boolean allowed)

Allows or disallows scaling up of images.
final void

Sets the main item for the details page.

Inherited methods
From androidx.leanback.widget.Row
final HeaderItem

Returns the HeaderItem that represents metadata for the row.
final long

Returns a unique identifier for this row.
boolean

Returns true if this Row can be rendered in a visible row view, false otherwise.
final void

Sets the HeaderItem that represents metadata for the row.
final void
setId(long id)

Sets the id for this row.

Public constructors

DetailsOverviewRow

public DetailsOverviewRow(Object item)

Constructor for a DetailsOverviewRow.

Parameters
Object item

The main item for the details page.

Public methods

addAction

public final void addAction(Action action)

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

public final void addAction(int pos, Action action)

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
int pos

The position to insert the Action.
Action action

The Action to add.

getActionForKeyCode

public Action getActionForKeyCode(int keyCode)

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

getActions

public final List<Action> getActions()

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.

Returns
List<Action>

An unmodifiable view of the list of Actions.

getActionsAdapter

public final ObjectAdapter getActionsAdapter()

Returns the ObjectAdapter for actions.

getImageDrawable

public final Drawable getImageDrawable()

Returns the image drawable of this details overview.

Returns
Drawable

The overview's image drawable, or null if no drawable has been assigned.

getItem

public final Object getItem()

Returns the main item for the details page.

isImageScaleUpAllowed

public boolean isImageScaleUpAllowed()

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

removeAction

public final boolean removeAction(Action action)

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.
Returns
boolean

true if the overview contained the specified Action.

setActionsAdapter

public final void setActionsAdapter(ObjectAdapter adapter)

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

Parameters
ObjectAdapter adapter

Adapter for actions.

setImageBitmap

public final void setImageBitmap(Context context, Bitmap bm)

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.
Bitmap bm

The bitmap to set.

setImageDrawable

public final void setImageDrawable(Drawable drawable)

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

public void setImageScaleUpAllowed(boolean allowed)

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

public final void setItem(Object item)

Sets the main item for the details page. Must be called on UI thread after row is bound to view.