com.thoughtbot.expandablecheckrecyclerview

Class CheckableChildRecyclerViewAdapter<GVH extends GroupViewHolder,CCVH extends CheckableChildViewHolder>

java.lang.Object

<any>

com.thoughtbot.expandablecheckrecyclerview.CheckableChildRecyclerViewAdapter<GVH,CCVH>

All Implemented Interfaces:

OnChildCheckChangedListener, OnChildrenCheckStateChangedListener

public abstract class CheckableChildRecyclerViewAdapter<GVH extends GroupViewHolder,CCVH extends CheckableChildViewHolder>
extends <any>
implements OnChildCheckChangedListener, OnChildrenCheckStateChangedListener

Constructor Summary

Constructors

Constructor and Description
CheckableChildRecyclerViewAdapter(java.util.List<? extends CheckedExpandableGroup> groups)

Method Summary

Modifier and Type	Method and Description
void	checkChild(boolean checked, int groupIndex, int childIndex) Manually (programmatically) update the check state of a child
void	clearChoices() Clear any choices previously checked
abstract void	onBindCheckChildViewHolder(CCVH holder, int flatPosition, CheckedExpandableGroup group, int childIndex) Called from onBindViewHolder(RecyclerView.ViewHolder, int) when the list item bound to is a child.
void	onBindChildViewHolder(CCVH holder, int flatPosition, ExpandableGroup group, int childIndex)
void	onChildCheckChanged(android.view.View view, boolean checked, int flatPos)
abstract CCVH	onCreateCheckChildViewHolder(android.view.ViewGroup parent, int viewType) Called from #onCreateViewHolder(ViewGroup, int) when the list item created is a child
CCVH	onCreateChildViewHolder(android.view.ViewGroup parent, int viewType)
void	onRestoreInstanceState(android.os.Bundle savedInstanceState) Fetches the checked state map from the saved instance state Bundle and restores the checked states of all of the child list items.
void	onSaveInstanceState(android.os.Bundle outState) Stores the checked state map across state loss.
void	setChildClickListener(OnCheckChildClickListener listener)
void	updateChildrenCheckState(int firstChildFlattenedIndex, int numChildren)

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckableChildRecyclerViewAdapter

public CheckableChildRecyclerViewAdapter(java.util.List<? extends CheckedExpandableGroup> groups)

Method Detail

onCreateChildViewHolder

public CCVH onCreateChildViewHolder(android.view.ViewGroup parent,
                                    int viewType)

onBindChildViewHolder

public void onBindChildViewHolder(CCVH holder,
                                  int flatPosition,
                                  ExpandableGroup group,
                                  int childIndex)

onChildCheckChanged

public void onChildCheckChanged(android.view.View view,
                                boolean checked,
                                int flatPos)

Specified by:

onChildCheckChanged in interface OnChildCheckChangedListener

checked - The current checked state of the view

flatPos - The flat position (raw index) of the the child within the RecyclerView

updateChildrenCheckState

public void updateChildrenCheckState(int firstChildFlattenedIndex,
                                     int numChildren)

Specified by:

updateChildrenCheckState in interface OnChildrenCheckStateChangedListener

Parameters:

firstChildFlattenedIndex - the flat position of the first child in the CheckedExpandableGroup

numChildren - the total number of children in the CheckedExpandableGroup

setChildClickListener

public void setChildClickListener(OnCheckChildClickListener listener)

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Stores the checked state map across state loss.

Should be called from whatever Activity that hosts the RecyclerView that CheckableChildRecyclerViewAdapter is attached to.

This will make sure to add the checked state map as an extra to the instance state bundle to be used in onRestoreInstanceState(Bundle).

Parameters:

outState - The Bundle into which to store the chekced state map

onRestoreInstanceState

public void onRestoreInstanceState(android.os.Bundle savedInstanceState)

Fetches the checked state map from the saved instance state Bundle and restores the checked states of all of the child list items.

Should be called from Activity.onRestoreInstanceState(Bundle) in the Activity that hosts the RecyclerView that this CheckableChildRecyclerViewAdapter is attached to.

Parameters:

savedInstanceState - The Bundle from which the expanded state map is loaded

checkChild

public void checkChild(boolean checked,
                       int groupIndex,
                       int childIndex)

Manually (programmatically) update the check state of a child

Parameters:

checked - the desired check state, true will check the item, false will uncheck it if possible

groupIndex - the index of the ExpandableGroup within getGroups()

childIndex - the index of the child within it's group

clearChoices

public void clearChoices()

Clear any choices previously checked

onCreateCheckChildViewHolder

public abstract CCVH onCreateCheckChildViewHolder(android.view.ViewGroup parent,
                                                  int viewType)

Called from #onCreateViewHolder(ViewGroup, int) when the list item created is a child

Parameters:

parent - the ViewGroup in the list for which a CCVH is being created

Returns:

A CCVH corresponding to child list item with the ViewGroup parent

onBindCheckChildViewHolder

public abstract void onBindCheckChildViewHolder(CCVH holder,
                                                int flatPosition,
                                                CheckedExpandableGroup group,
                                                int childIndex)

Called from onBindViewHolder(RecyclerView.ViewHolder, int) when the list item bound to is a child.

Bind data to the CCVH here.

Parameters:

holder - The CCVH to bind data to

flatPosition - the flat position (raw index) in the list at which to bind the child

group - The CheckedExpandableGroup that the the child list item belongs to

childIndex - the index of this child within it's CheckedExpandableGroup