Android APIs
public class

ItemBridgeAdapter

extends Adapter
implements FacetProviderAdapter
java.lang.Object
   ↳ android.support.v7.widget.RecyclerView.Adapter
     ↳ android.support.v17.leanback.widget.ItemBridgeAdapter

Class Overview

Bridge from Presenter to RecyclerView.Adapter. Public to allow use by third party Presenters.

Summary

Nested Classes
class ItemBridgeAdapter.AdapterListener Interface for listening to ViewHolder operations. 
class ItemBridgeAdapter.ViewHolder ViewHolder for the ItemBridgeAdapter. 
class ItemBridgeAdapter.Wrapper Interface for wrapping a view created by a Presenter into another view. 
Public Constructors
ItemBridgeAdapter(ObjectAdapter adapter, PresenterSelector presenterSelector)
ItemBridgeAdapter(ObjectAdapter adapter)
ItemBridgeAdapter()
Public Methods
void clear()
Clears the adapter.
FacetProvider getFacetProvider(int type)
Queries FacetProvider for a given type within Adapter.
int getItemCount()
Returns the total number of items in the data set hold by the adapter.
long getItemId(int position)
Return the stable ID for the item at position.
int getItemViewType(int position)
Return the view type of the item at position for the purposes of view recycling.
ArrayList<Presenter> getPresenterMapper()
Returns the presenter mapper array.
ItemBridgeAdapter.Wrapper getWrapper()
final void onBindViewHolder(RecyclerView.ViewHolder holder, int position)
Called by RecyclerView to display the data at the specified position.
final RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType)
View.OnFocusChangeListener that assigned in onCreateViewHolder(ViewGroup) may be chained, user should never change View.OnFocusChangeListener after that.
final void onViewAttachedToWindow(RecyclerView.ViewHolder holder)
Called when a view created by this adapter has been attached to a window.
final void onViewDetachedFromWindow(RecyclerView.ViewHolder holder)
Called when a view created by this adapter has been detached from its window.
final void onViewRecycled(RecyclerView.ViewHolder holder)
Called when a view created by this adapter has been recycled.
void setAdapter(ObjectAdapter adapter)
Sets the ObjectAdapter.
void setAdapterListener(ItemBridgeAdapter.AdapterListener listener)
Sets the AdapterListener.
void setPresenterMapper(ArrayList<Presenter> presenters)
Sets the presenter mapper array.
void setWrapper(ItemBridgeAdapter.Wrapper wrapper)
Protected Methods
void onAddPresenter(Presenter presenter, int type)
Called when presenter is added to Adapter.
void onAttachedToWindow(ItemBridgeAdapter.ViewHolder viewHolder)
Called when ViewHolder has been attached to window.
void onBind(ItemBridgeAdapter.ViewHolder viewHolder)
Called when ViewHolder has been bound to data.
void onCreate(ItemBridgeAdapter.ViewHolder viewHolder)
Called when ViewHolder is created.
void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder viewHolder)
Called when ViewHolder has been detached from window.
void onUnbind(ItemBridgeAdapter.ViewHolder viewHolder)
Called when ViewHolder has been unbound from data.
[Expand]
Inherited Methods
From class android.support.v7.widget.RecyclerView.Adapter
From class java.lang.Object
From interface android.support.v17.leanback.widget.FacetProviderAdapter

Public Constructors

public ItemBridgeAdapter (ObjectAdapter adapter, PresenterSelector presenterSelector)

public ItemBridgeAdapter (ObjectAdapter adapter)

public ItemBridgeAdapter ()

Public Methods

public void clear ()

Clears the adapter.

public FacetProvider getFacetProvider (int type)

Queries FacetProvider for a given type within Adapter.

Parameters
type type of the item.
Returns
  • Facet provider for the type.

public int getItemCount ()

Returns the total number of items in the data set hold by the adapter.

Returns
  • The total number of items in this adapter.

public long getItemId (int position)

Return the stable ID for the item at position. If hasStableIds() would return false this method should return NO_ID. The default implementation of this method returns NO_ID.

Parameters
position Adapter position to query
Returns
  • the stable ID of the item at position

public int getItemViewType (int position)

Return the view type of the item at position for the purposes of view recycling.

The default implementation of this method returns 0, making the assumption of a single view type for the adapter. Unlike ListView adapters, types need not be contiguous. Consider using id resources to uniquely identify item view types.

Parameters
position position to query
Returns
  • integer value identifying the type of the view needed to represent the item at position. Type codes need not be contiguous.

public ArrayList<Presenter> getPresenterMapper ()

Returns the presenter mapper array.

public ItemBridgeAdapter.Wrapper getWrapper ()

public final void onBindViewHolder (RecyclerView.ViewHolder holder, int position)

Called by RecyclerView to display the data at the specified position. This method should update the contents of the itemView to reflect the item at the given position.

Note that unlike ListView, RecyclerView will not call this method again if the position of the item changes in the data set unless the item itself is invalidated or the new position cannot be determined. For this reason, you should only use the position parameter while acquiring the related data item inside this method and should not keep a copy of it. If you need the position of an item later on (e.g. in a click listener), use getAdapterPosition() which will have the updated adapter position. Override onBindViewHolder(ViewHolder, int, List) instead if Adapter can handle effcient partial bind.

Parameters
holder The ViewHolder which should be updated to represent the contents of the item at the given position in the data set.
position The position of the item within the adapter's data set.

public final RecyclerView.ViewHolder onCreateViewHolder (ViewGroup parent, int viewType)

View.OnFocusChangeListener that assigned in onCreateViewHolder(ViewGroup) may be chained, user should never change View.OnFocusChangeListener after that.

Parameters
parent The ViewGroup into which the new View will be added after it is bound to an adapter position.
viewType The view type of the new View.
Returns
  • A new ViewHolder that holds a View of the given view type.

public final void onViewAttachedToWindow (RecyclerView.ViewHolder holder)

Called when a view created by this adapter has been attached to a window.

This can be used as a reasonable signal that the view is about to be seen by the user. If the adapter previously freed any resources in onViewDetachedFromWindow those resources should be restored here.

Parameters
holder Holder of the view being attached

public final void onViewDetachedFromWindow (RecyclerView.ViewHolder holder)

Called when a view created by this adapter has been detached from its window.

Becoming detached from the window is not necessarily a permanent condition; the consumer of an Adapter's views may choose to cache views offscreen while they are not visible, attaching an detaching them as appropriate.

Parameters
holder Holder of the view being detached

public final void onViewRecycled (RecyclerView.ViewHolder holder)

Called when a view created by this adapter has been recycled.

A view is recycled when a RecyclerView.LayoutManager decides that it no longer needs to be attached to its parent RecyclerView. This can be because it has fallen out of visibility or a set of cached views represented by views still attached to the parent RecyclerView. If an item view has large or expensive data bound to it such as large bitmaps, this may be a good place to release those resources.

RecyclerView calls this method right before clearing ViewHolder's internal data and sending it to RecycledViewPool. This way, if ViewHolder was holding valid information before being recycled, you can call getAdapterPosition() to get its adapter position.

Parameters
holder The ViewHolder for the view being recycled

public void setAdapter (ObjectAdapter adapter)

Sets the ObjectAdapter.

public void setAdapterListener (ItemBridgeAdapter.AdapterListener listener)

Sets the AdapterListener.

public void setPresenterMapper (ArrayList<Presenter> presenters)

Sets the presenter mapper array.

public void setWrapper (ItemBridgeAdapter.Wrapper wrapper)

Protected Methods

protected void onAddPresenter (Presenter presenter, int type)

Called when presenter is added to Adapter.

protected void onAttachedToWindow (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been attached to window.

protected void onBind (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been bound to data.

protected void onCreate (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder is created.

protected void onDetachedFromWindow (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been detached from window.

protected void onUnbind (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been unbound from data.