lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey
added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

DetailsOverviewRow

public class DetailsOverviewRow
extends Row

java.lang.Object
   ↳ android.support.v17.leanback.widget.Row
     ↳ android.support.v17.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 setImageBitmap(Context, Bitmap) or setImageDrawable(Drawable) on the UI thread, and the view will be updated.

Summary

Nested classes

class DetailsOverviewRow.Listener

Listener for changes of DetailsOverviewRow. 

Public constructors

DetailsOverviewRow(Object item)

Constructor for a DetailsOverviewRow.

Public methods

final void addAction(Action action)

This method was deprecated in API level 22.1.0. Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

final void addAction(int pos, Action action)

This method was deprecated in API level 22.1.0. Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

Action getActionForKeyCode(int keyCode)

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

final List<Action> getActions()

This method was deprecated in API level 22.1.0. Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

final ObjectAdapter getActionsAdapter()

Returns the ObjectAdapter for actions.

final Drawable getImageDrawable()

Returns the image drawable of this details overview.

final Object getItem()

Returns the main item for the details page.

boolean isImageScaleUpAllowed()

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

final boolean removeAction(Action action)

This method was deprecated in API level 22.1.0. Use setActionsAdapter(ObjectAdapter) and getActionsAdapter()

final void setActionsAdapter(ObjectAdapter adapter)

Sets the ObjectAdapter for actions.

final void setImageBitmap(Context context, Bitmap bm)

Sets a Bitmap as the image of this details overview.

final void setImageDrawable(Drawable drawable)

Sets a drawable as the image of this details overview.

void setImageScaleUpAllowed(boolean allowed)

Allows or disallows scaling up of images.

final void setItem(Object item)

Sets the main item for the details page.

Inherited methods

From class android.support.v17.leanback.widget.Row
From class java.lang.Object

Public constructors

DetailsOverviewRow

added in version 22.1.0
DetailsOverviewRow (Object item)

Constructor for a DetailsOverviewRow.

Parameters
item Object: The main item for the details page.

Public methods

addAction

added in version 22.1.0
void addAction (Action action)

This method was deprecated in API level 22.1.0.
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

added in version 22.1.0
void addAction (int pos, 
                Action action)

This method was deprecated in API level 22.1.0.
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

added in version 22.1.0
Action getActionForKeyCode (int keyCode)

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

Parameters
keyCode int

Returns
Action

getActions

added in version 22.1.0
List<Action> getActions ()

This method was deprecated in API level 22.1.0.
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.

Returns
List<Action> An unmodifiable view of the list of Actions.

getActionsAdapter

added in version 22.1.0
ObjectAdapter getActionsAdapter ()

Returns the ObjectAdapter for actions.

Returns
ObjectAdapter

getImageDrawable

added in version 22.1.0
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

added in version 22.1.0
Object getItem ()

Returns the main item for the details page.

Returns
Object

isImageScaleUpAllowed

added in version 22.1.0
boolean isImageScaleUpAllowed ()

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

Returns
boolean

removeAction

added in version 22.1.0
boolean removeAction (Action action)

This method was deprecated in API level 22.1.0.
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.

Returns
boolean true if the overview contained the specified Action.

setActionsAdapter

added in version 22.1.0
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
adapter ObjectAdapter: Adapter for actions.

setImageBitmap

added in version 22.1.0
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.

bm Bitmap: The bitmap to set.

setImageDrawable

added in version 22.1.0
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

added in version 22.1.0
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.

Parameters
allowed boolean

setItem

added in version 22.1.0
void setItem (Object item)

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

Parameters
item Object