com.pedrogomez.renderers

Class RVRendererAdapter<T>

java.lang.Object

<any>

com.pedrogomez.renderers.RVRendererAdapter<T>

public class RVRendererAdapter<T>
extends <any>

RecyclerView.Adapter extension created to work RendererBuilders and Renderer instances. Other adapters have to use this one to show information into RecyclerView widgets.

This class is the heart of this library. It's used to avoid the library users declare a new renderer each time they have to show information into a RecyclerView.

RVRendererAdapter has to be constructed with a LayoutInflater to inflate views, one RendererBuilder to provide Renderer to RVRendererAdapter and one AdapteeCollection to provide the elements to render.

Constructor Summary

Constructors

Constructor and Description
RVRendererAdapter(RendererBuilder<T> rendererBuilder)
RVRendererAdapter(RendererBuilder<T> rendererBuilder, AdapteeCollection<T> collection)

Method Summary

Modifier and Type	Method and Description
boolean	add(T element) Add an element to the AdapteeCollection.
boolean	addAll(java.util.Collection<? extends T> elements) Add a Collection of elements to the AdapteeCollection.
void	clear() Remove all elements inside the AdapteeCollection.
void	diffUpdate(java.util.List<T> newList) Provides a ready to use diff update for our adapter based on the implementation of the standard equals method from Object.
protected AdapteeCollection<T>	getCollection() Allows the client code to access the AdapteeCollection from subtypes of RendererAdapter.
T	getItem(int position)
int	getItemCount()
long	getItemId(int position)
int	getItemViewType(int position) Indicate to the RecyclerView the type of Renderer used to one position using a numeric value.
void	onBindViewHolder(RendererViewHolder viewHolder, int position) Given a RendererViewHolder passed as argument and a position renders the view using the Renderer previously stored into the RendererViewHolder.
RendererViewHolder	onCreateViewHolder(android.view.ViewGroup viewGroup, int viewType) One of the two main methods in this class.
boolean	remove(java.lang.Object element) Remove an element from the AdapteeCollection.
boolean	removeAll(java.util.Collection<?> elements) Remove a Collection of elements to the AdapteeCollection.
void	setCollection(AdapteeCollection<T> collection)
protected void	updateRendererExtraValues(T content, Renderer<T> renderer, int position) Empty implementation created to allow the client code to extend this class without override getView method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RVRendererAdapter

public RVRendererAdapter(RendererBuilder<T> rendererBuilder)

RVRendererAdapter

public RVRendererAdapter(RendererBuilder<T> rendererBuilder,
                         AdapteeCollection<T> collection)

Method Detail

getItemCount

public int getItemCount()

getItem

public T getItem(int position)

getItemId

public long getItemId(int position)

setCollection

public void setCollection(AdapteeCollection<T> collection)

getItemViewType

public int getItemViewType(int position)

Indicate to the RecyclerView the type of Renderer used to one position using a numeric value.

Parameters:

position - to analyze.

Returns:

the id associated to the Renderer used to render the content given a position.

onCreateViewHolder

public RendererViewHolder onCreateViewHolder(android.view.ViewGroup viewGroup,
                                             int viewType)

One of the two main methods in this class. Creates a RendererViewHolder instance with a Renderer inside ready to be used. The RendererBuilder to create a RendererViewHolder using the information given as parameter.

Parameters:

viewGroup - used to create the ViewHolder.

viewType - associated to the renderer.

Returns:

ViewHolder extension with the Renderer it has to use inside.

onBindViewHolder

public void onBindViewHolder(RendererViewHolder viewHolder,
                             int position)

Given a RendererViewHolder passed as argument and a position renders the view using the Renderer previously stored into the RendererViewHolder.

Parameters:

viewHolder - with a Renderer class inside.

position - to render.

add

public boolean add(T element)

Add an element to the AdapteeCollection.

Parameters:

element - to add.

Returns:

if the element has been added.

remove

public boolean remove(java.lang.Object element)

Remove an element from the AdapteeCollection.

Parameters:

element - to remove.

Returns:

if the element has been removed.

addAll

public boolean addAll(java.util.Collection<? extends T> elements)

Add a Collection of elements to the AdapteeCollection.

Parameters:

elements - to add.

Returns:

if the elements have been added.

removeAll

public boolean removeAll(java.util.Collection<?> elements)

Remove a Collection of elements to the AdapteeCollection.

Parameters:

elements - to remove.

Returns:

if the elements have been removed.

clear

public void clear()

Remove all elements inside the AdapteeCollection.

getCollection

protected AdapteeCollection<T> getCollection()

Allows the client code to access the AdapteeCollection from subtypes of RendererAdapter.

Returns:

collection used in the adapter as the adaptee class.

updateRendererExtraValues

protected void updateRendererExtraValues(T content,
                                         Renderer<T> renderer,
                                         int position)

Empty implementation created to allow the client code to extend this class without override getView method.

This method is called before render the Renderer and can be used in RendererAdapter extension to add extra info to the renderer created like the position in the ListView/RecyclerView.

Parameters:

content - to be rendered.

renderer - to be used to paint the content.

position - of the content.

diffUpdate

public void diffUpdate(java.util.List<T> newList)

Provides a ready to use diff update for our adapter based on the implementation of the standard equals method from Object.

Parameters:

newList - to refresh our content