DetailsOverviewRow - Android SDK

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

DetailsOverviewRow

extends Row

java.lang.Object
↳	android.support.v17.leanback.widget.Row
	↳	android.support.v17.leanback.widget.DetailsOverviewRow

Class Overview

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(int pos, Action action) This method is deprecated. Use `setActionsAdapter(ObjectAdapter)` and `getActionsAdapter()`
final void	addAction(Action action) This method is deprecated. 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 is deprecated. 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 is deprecated. 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.

[Expand]

Inherited Methods

From class android.support.v17.leanback.widget.Row

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public DetailsOverviewRow (Object item)

Constructor for a DetailsOverviewRow.

Parameters

item	The main item for the details page.

Public Methods

public final void addAction (int pos, Action action)

This method is 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	The position to insert the Action.
action	The Action to add.

public final void addAction (Action action)

This method is 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	The Action to add.

public Action getActionForKeyCode (int keyCode)

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

public final List<Action> getActions ()

This method is 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.

Returns

An unmodifiable view of the list of Actions.

public final ObjectAdapter getActionsAdapter ()

Returns the ObjectAdapter for actions.

public final Drawable getImageDrawable ()

Returns the image drawable of this details overview.

Returns

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

public final Object getItem ()

Returns the main item for the details page.

public boolean isImageScaleUpAllowed ()

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

public final boolean removeAction (Action action)

This method is 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	The Action to remove.

Returns

true if the overview contained the specified Action.

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

adapter	Adapter for actions.

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	The context to retrieve display metrics from.
bm	The bitmap to set.

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	The drawable to set.

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.

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.

Results

Interfaces

Classes

DetailsOverviewRow

Class Overview

Actions

Updating main item

Updating image

Summary

Public Constructors

public DetailsOverviewRow (Object item)

Parameters

Public Methods

public final void addAction (int pos, Action action)

Parameters

public final void addAction (Action action)

Parameters

public Action getActionForKeyCode (int keyCode)

public final List<Action> getActions ()

Returns

public final ObjectAdapter getActionsAdapter ()

public final Drawable getImageDrawable ()

Returns

public final Object getItem ()

public boolean isImageScaleUpAllowed ()

public final boolean removeAction (Action action)

Parameters

Returns

public final void setActionsAdapter (ObjectAdapter adapter)

Parameters

public final void setImageBitmap (Context context, Bitmap bm)

Parameters

public final void setImageDrawable (Drawable drawable)

Parameters

public void setImageScaleUpAllowed (boolean allowed)

public final void setItem (Object item)