com.devbrackets.android.recyclerext.adapter

Class RecyclerHeaderCursorAdapter<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter<VH>

com.devbrackets.android.recyclerext.adapter.RecyclerCursorAdapter<android.support.v7.widget.RecyclerView.ViewHolder>

com.devbrackets.android.recyclerext.adapter.RecyclerHeaderCursorAdapter<H,C>

Type Parameters:

H - The Header RecyclerView.ViewHolder

C - The Child or content RecyclerView.ViewHolder

All Implemented Interfaces:

HeaderApi<H,C>, CursorFilter.CursorFilterClient

public abstract class RecyclerHeaderCursorAdapter<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>
extends RecyclerCursorAdapter<android.support.v7.widget.RecyclerView.ViewHolder>
implements HeaderApi<H,C>

A RecyclerView adapter that adds support for dynamically placing headers in the view using a cursor.

Field Summary

Fields

Modifier and Type	Field and Description
protected HeaderCore	core Contains the base processing for the header adapters

Fields inherited from class com.devbrackets.android.recyclerext.adapter.RecyclerCursorAdapter

cursor, cursorFilter, DEFAULT_ID_COLUMN_NAME, filterQueryProvider, idColumn, internalChangeObserver, internalDataSetObserver, isValidData

Fields inherited from interface com.devbrackets.android.recyclerext.adapter.header.HeaderApi

HEADER_VIEW_TYPE_MASK

Constructor Summary

Constructors

Constructor and Description
RecyclerHeaderCursorAdapter(Cursor cursor)
RecyclerHeaderCursorAdapter(Cursor cursor, java.lang.String idColumnName)

Method Summary

Modifier and Type	Method and Description
int	determineChildPosition(int viewPosition) Determines the child position given the position in the RecyclerView
int	getChildCount() Returns the total number of children in the data set held by the adapter.
int	getChildCount(long headerId) Returns the total number of views that are associated with the specified header id.
int	getChildViewType(int childPosition) Retrieves the view type for the child view at the specified childPosition.
int	getCustomStickyHeaderViewId() Retrieves the resource id for the view in the header view holder to make sticky.
long	getHeaderId(int childPosition) Return the stable ID for the header at childPosition.
int	getHeaderPosition(long headerId) Determines the position for the header associated with the headerId
int	getHeaderViewType(int childPosition) Retrieves the view type for the header whos first child view has the childPosition.
int	getItemCount() Returns the total number of items in the data set hold by the adapter, this includes both the Headers and the Children views
int	getItemViewType(int position) Retrieves the view type for the specified position.
protected void	init() Initializes the non-super components for the Adapter
void	onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView) When the RecyclerView is attached a data observer is registered in order to determine when to re-calculate the headers
abstract void	onBindChildViewHolder(C holder, Cursor cursor, int childPosition) Called to display the child information with the childPosition being the position of the child, excluding headers.
abstract void	onBindHeaderViewHolder(H holder, Cursor cursor, int firstChildPosition) Called to display the header information with the firstChildPosition being the position of the first child after this header.
void	onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder, Cursor cursor, int position) This method shouldn't be used directly, instead use #onBindHeaderViewHolder(ViewHolder, Cursor, int) and #onBindChildViewHolder(ViewHolder, Cursor, int)
android.support.v7.widget.RecyclerView.ViewHolder	onCreateViewHolder(ViewGroup parent, int viewType) This method shouldn't be used directly, instead use HeaderApi.onCreateHeaderViewHolder(ViewGroup, int) and HeaderApi.onCreateChildViewHolder(ViewGroup, int)
void	onDetachedFromRecyclerView(android.support.v7.widget.RecyclerView recyclerView) When the RecyclerView is detached the registered data observer will be unregistered.
void	showHeaderAsChild(boolean enabled) When enabled the headers will not be counted separately from the children.

Methods inherited from class com.devbrackets.android.recyclerext.adapter.RecyclerCursorAdapter

changeCursor, convertToString, getCursor, getCursor, getFilter, getFilterQueryProvider, getItemId, onBindViewHolder, onContentChanged, runQueryOnBackgroundThread, setFilterQueryProvider, swapCursor

Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onBindViewHolder, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devbrackets.android.recyclerext.adapter.header.HeaderApi

onCreateChildViewHolder, onCreateHeaderViewHolder

Field Detail

core

protected HeaderCore core

Contains the base processing for the header adapters

Constructor Detail

RecyclerHeaderCursorAdapter

public RecyclerHeaderCursorAdapter(Cursor cursor)

Parameters:

cursor - The cursor from which to get the data.

RecyclerHeaderCursorAdapter

public RecyclerHeaderCursorAdapter(Cursor cursor,
                                   java.lang.String idColumnName)

Parameters:

cursor - The cursor from which to get the data.

idColumnName - The name for the id column to use when calling RecyclerCursorAdapter.getItemId(int) [default: ]

Method Detail

onBindHeaderViewHolder

public abstract void onBindHeaderViewHolder(H holder,
                                            Cursor cursor,
                                            int firstChildPosition)

Called to display the header information with the firstChildPosition being the position of the first child after this header.

Parameters:

holder - The ViewHolder which should be updated

cursor - The cursor representing the first child for the header

firstChildPosition - The position of the child immediately after this header

onBindChildViewHolder

public abstract void onBindChildViewHolder(C holder,
                                           Cursor cursor,
                                           int childPosition)

Called to display the child information with the childPosition being the position of the child, excluding headers.

Parameters:

holder - The ViewHolder which should be updated

cursor - The cursor representing child to bind

childPosition - The position of the child

onCreateViewHolder

public android.support.v7.widget.RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent,
                                                                            int viewType)

This method shouldn't be used directly, instead use HeaderApi.onCreateHeaderViewHolder(ViewGroup, int) and HeaderApi.onCreateChildViewHolder(ViewGroup, int)

Specified by:

onCreateViewHolder in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

parent - The parent ViewGroup for the ViewHolder

viewType - The type for the ViewHolder

Returns:

The correct ViewHolder for the specified viewType

onBindViewHolder

public void onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder,
                             Cursor cursor,
                             int position)

This method shouldn't be used directly, instead use #onBindHeaderViewHolder(ViewHolder, Cursor, int) and #onBindChildViewHolder(ViewHolder, Cursor, int)

Specified by:

onBindViewHolder in class RecyclerCursorAdapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

holder - The ViewHolder to update

cursor - The cursor representing the item at position

position - The position of the item to bind the holder for

getItemViewType

public int getItemViewType(int position)

Retrieves the view type for the specified position.

Overrides:

getItemViewType in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

position - The position to determine the view type for

Returns:

The type of ViewHolder for the position

onAttachedToRecyclerView

public void onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

When the RecyclerView is attached a data observer is registered in order to determine when to re-calculate the headers

Overrides:

onAttachedToRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

recyclerView - The RecyclerView that was attached

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

When the RecyclerView is detached the registered data observer will be unregistered. See onAttachedToRecyclerView(RecyclerView) for more information

Overrides:

onDetachedFromRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

recyclerView - The RecyclerView that has been detached

getItemCount

public int getItemCount()

Returns the total number of items in the data set hold by the adapter, this includes both the Headers and the Children views

NOTE: getChildCount() should be overridden instead of this method

Overrides:

getItemCount in class RecyclerCursorAdapter<android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

The total number of items in this adapter.

getHeaderViewType

public int getHeaderViewType(int childPosition)

Description copied from interface: HeaderApi

Retrieves the view type for the header whos first child view has the childPosition. This value will be |'d with the HeaderApi.HEADER_VIEW_TYPE_MASK to make sure the header and child view types don't overlap

Specified by:

getHeaderViewType in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

childPosition - The position for the fist child underneath the header

Returns:

The view type for the header view

getChildViewType

public int getChildViewType(int childPosition)

Description copied from interface: HeaderApi

Retrieves the view type for the child view at the specified childPosition. This value will be &'ed with the inverse of HeaderApi.HEADER_VIEW_TYPE_MASK to make sure the header and child view types don't overlap.

Specified by:

getChildViewType in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

childPosition - The position of the child to get the type for

Returns:

The view type for the child view

getChildCount

public int getChildCount(long headerId)

Description copied from interface: HeaderApi

Returns the total number of views that are associated with the specified header id. If the headerId doesn't exist then 0 will be returned.

Specified by:

getChildCount in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

headerId - The headerId to find the number of children for

Returns:

The number of children views associated with the given headerId

getHeaderId

public long getHeaderId(int childPosition)

Description copied from interface: HeaderApi

Return the stable ID for the header at childPosition. The default implementation of this method returns RecyclerView.NO_ID

Specified by:

getHeaderId in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

childPosition - The Adapters child position

Returns:

the stable ID of the header at childPosition

getChildCount

public int getChildCount()

Description copied from interface: HeaderApi

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

Specified by:

getChildCount in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

The total number of children in this adapter.

determineChildPosition

public int determineChildPosition(int viewPosition)

Description copied from interface: HeaderApi

Determines the child position given the position in the RecyclerView

Specified by:

determineChildPosition in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

viewPosition - The position in the RecyclerView (includes Headers and Children)

Returns:

The child index

getHeaderPosition

public int getHeaderPosition(long headerId)

Description copied from interface: HeaderApi

Determines the position for the header associated with the headerId

Specified by:

getHeaderPosition in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

headerId - The id to find the header for

Returns:

The associated headers position or RecyclerView.NO_POSITION

showHeaderAsChild

public void showHeaderAsChild(boolean enabled)

Description copied from interface: HeaderApi

When enabled the headers will not be counted separately from the children. This should be used when the headers have a slightly different display type from the other children instead of the abruptly different view. This is useful when mimicking the sticky alphabetical headers seen in the contacts app for Lollipop and Marshmallow

Specified by:

showHeaderAsChild in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Parameters:

enabled - True if the header should be treated as a child

getCustomStickyHeaderViewId

public int getCustomStickyHeaderViewId()

Description copied from interface: HeaderApi

Retrieves the resource id for the view in the header view holder to make sticky. By default this returns the invalid resource id (0) and will use the entire header view. Only use this if only a specific view should remain sticky.

NOTE: This will only be used when a StickyHeaderDecoration has been specified

Specified by:

getCustomStickyHeaderViewId in interface HeaderApi<H extends android.support.v7.widget.RecyclerView.ViewHolder,C extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

The resource id for the view that will be sticky

init

protected void init()

Initializes the non-super components for the Adapter