Skip to content

Most visited

Recently visited

navigation
added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:27.0.0

ItemBridgeAdapter

public class ItemBridgeAdapter
extends Adapter implements FacetProviderAdapter

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


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 held 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()

Returns the ItemBridgeAdapter.Wrapper.

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

Called by RecyclerView to display the data at the specified position.

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

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 setPresenter(PresenterSelector presenterSelector)

Changes Presenter that creates and binds the view.

void setPresenterMapper(ArrayList<Presenter> presenters)

Sets the presenter mapper array.

void setWrapper(ItemBridgeAdapter.Wrapper wrapper)

Sets the ItemBridgeAdapter.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.

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

ItemBridgeAdapter

added in version 22.1.0
ItemBridgeAdapter (ObjectAdapter adapter, 
                PresenterSelector presenterSelector)

Parameters
adapter ObjectAdapter

presenterSelector PresenterSelector

ItemBridgeAdapter

added in version 22.1.0
ItemBridgeAdapter (ObjectAdapter adapter)

Parameters
adapter ObjectAdapter

ItemBridgeAdapter

added in version 22.1.0
ItemBridgeAdapter ()

Public methods

clear

added in version 22.1.0
void clear ()

Clears the adapter.

getFacetProvider

added in version 24.1.0
FacetProvider getFacetProvider (int type)

Queries FacetProvider for a given type within Adapter.

Parameters
type int: type of the item.

Returns
FacetProvider Facet provider for the type.

getItemCount

added in version 22.1.0
int getItemCount ()

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

Returns
int The total number of items in this adapter.

getItemId

added in version 22.1.0
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 int: Adapter position to query

Returns
long the stable ID of the item at position

getItemViewType

added in version 22.1.0
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 int: position to query

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

getPresenterMapper

added in version 22.1.0
ArrayList<Presenter> getPresenterMapper ()

Returns the presenter mapper array.

Returns
ArrayList<Presenter>

getWrapper

added in version 22.1.0
ItemBridgeAdapter.Wrapper getWrapper ()

Returns the ItemBridgeAdapter.Wrapper.

Returns
ItemBridgeAdapter.Wrapper

onBindViewHolder

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

Parameters
holder RecyclerView.ViewHolder: The ViewHolder which should be updated to represent the contents of the item at the given position in the data set.

position int: The position of the item within the adapter's data set.

onBindViewHolder

added in version 27.0.0
void onBindViewHolder (RecyclerView.ViewHolder holder, 
                int position, 
                List payloads)

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.

Partial bind vs full bind:

The payloads parameter is a merge list from notifyItemChanged(int, Object) or notifyItemRangeChanged(int, int, Object). If the payloads list is not empty, the ViewHolder is currently bound to old data and Adapter may run an efficient partial update using the payload info. If the payload is empty, Adapter must run a full bind. Adapter should not assume that the payload passed in notify methods will be received by onBindViewHolder(). For example when the view is not attached to the screen, the payload in notifyItemChange() will be simply dropped.

Parameters
holder RecyclerView.ViewHolder: The ViewHolder which should be updated to represent the contents of the item at the given position in the data set.

position int: The position of the item within the adapter's data set.

payloads List: A non-null list of merged payloads. Can be empty list if requires full update.

onCreateViewHolder

added in version 22.1.0
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 ViewGroup: The ViewGroup into which the new View will be added after it is bound to an adapter position.

viewType int: The view type of the new View.

Returns
RecyclerView.ViewHolder A new ViewHolder that holds a View of the given view type.

onViewAttachedToWindow

added in version 22.1.0
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 RecyclerView.ViewHolder: Holder of the view being attached

onViewDetachedFromWindow

added in version 22.1.0
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 and detaching them as appropriate.

Parameters
holder RecyclerView.ViewHolder: Holder of the view being detached

onViewRecycled

added in version 22.1.0
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 RecyclerView.ViewHolder: The ViewHolder for the view being recycled

setAdapter

added in version 22.1.0
void setAdapter (ObjectAdapter adapter)

Sets the ObjectAdapter.

Parameters
adapter ObjectAdapter

setAdapterListener

added in version 22.1.0
void setAdapterListener (ItemBridgeAdapter.AdapterListener listener)

Sets the AdapterListener.

Parameters
listener ItemBridgeAdapter.AdapterListener

setPresenter

added in version 25.4.0
void setPresenter (PresenterSelector presenterSelector)

Changes Presenter that creates and binds the view.

Parameters
presenterSelector PresenterSelector: Presenter that creates and binds the view.

setPresenterMapper

added in version 22.1.0
void setPresenterMapper (ArrayList<Presenter> presenters)

Sets the presenter mapper array.

Parameters
presenters ArrayList

setWrapper

added in version 22.1.0
void setWrapper (ItemBridgeAdapter.Wrapper wrapper)

Sets the ItemBridgeAdapter.Wrapper.

Parameters
wrapper ItemBridgeAdapter.Wrapper

Protected methods

onAddPresenter

added in version 22.1.0
void onAddPresenter (Presenter presenter, 
                int type)

Called when presenter is added to Adapter.

Parameters
presenter Presenter

type int

onAttachedToWindow

added in version 22.1.0
void onAttachedToWindow (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been attached to window.

Parameters
viewHolder ItemBridgeAdapter.ViewHolder

onBind

added in version 22.1.0
void onBind (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been bound to data.

Parameters
viewHolder ItemBridgeAdapter.ViewHolder

onCreate

added in version 22.1.0
void onCreate (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder is created.

Parameters
viewHolder ItemBridgeAdapter.ViewHolder

onDetachedFromWindow

added in version 22.1.0
void onDetachedFromWindow (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been detached from window.

Parameters
viewHolder ItemBridgeAdapter.ViewHolder

onUnbind

added in version 22.1.0
void onUnbind (ItemBridgeAdapter.ViewHolder viewHolder)

Called when ViewHolder has been unbound from data.

Parameters
viewHolder ItemBridgeAdapter.ViewHolder

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)