ItemBridgeAdapter

public class ItemBridgeAdapter
extends Adapter implements FacetProviderAdapter

java.lang.Object
   ↳ androidx.recyclerview.widget.RecyclerView.Adapter
     ↳ androidx.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, List payloads)

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

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 Presenter.onCreateViewHolder(ViewGroup) may be chained, user should never change View.OnFocusChangeListener after that.

final boolean onFailedToRecycleView(RecyclerView.ViewHolder holder)

Called by the RecyclerView if a ViewHolder created by this Adapter cannot be recycled due to its transient state.

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

Public constructors

ItemBridgeAdapter

public ItemBridgeAdapter (ObjectAdapter adapter, 
                PresenterSelector presenterSelector)

Parameters
adapter ObjectAdapter

presenterSelector PresenterSelector

ItemBridgeAdapter

public ItemBridgeAdapter (ObjectAdapter adapter)

Parameters
adapter ObjectAdapter

ItemBridgeAdapter

public ItemBridgeAdapter ()

Public methods

clear

public void clear ()

Clears the adapter.

getFacetProvider

public 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

public 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

public long getItemId (int position)

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

Parameters
position int: Adapter position to query

Returns
long the stable ID of the item at position

getItemViewType

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

public ArrayList<Presenter> getPresenterMapper ()

Returns the presenter mapper array.

Returns
ArrayList<Presenter>

getWrapper

public ItemBridgeAdapter.Wrapper getWrapper ()

Returns the ItemBridgeAdapter.Wrapper.

Returns
ItemBridgeAdapter.Wrapper

onBindViewHolder

public final 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 RecyclerView.ViewHolder.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 RecyclerView.ViewHolder.getBindingAdapterPosition() 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.

onBindViewHolder

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 RecyclerView.ViewHolder.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 Rec