com.thoughtbot.expandablerecyclerview

Class ExpandableRecyclerViewAdapter<GVH extends GroupViewHolder,CVH extends ChildViewHolder>

java.lang.Object

RecyclerView.Adapter

com.thoughtbot.expandablerecyclerview.ExpandableRecyclerViewAdapter<GVH,CVH>

All Implemented Interfaces:

ExpandCollapseListener, OnGroupClickListener

Direct Known Subclasses:

MultiTypeExpandableRecyclerViewAdapter

public abstract class ExpandableRecyclerViewAdapter<GVH extends GroupViewHolder,CVH extends ChildViewHolder>
extends RecyclerView.Adapter
implements ExpandCollapseListener, OnGroupClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected ExpandableList	expandableList

Constructor Summary

Constructors

Constructor and Description
ExpandableRecyclerViewAdapter(java.util.List<? extends ExpandableGroup> groups)

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends ExpandableGroup>	getGroups() The full list of ExpandableGroup backing this RecyclerView
int	getItemCount()
int	getItemViewType(int position) Gets the view type of the item at the given position.
boolean	isGroupExpanded(ExpandableGroup group)
boolean	isGroupExpanded(int flatPos)
abstract void	onBindChildViewHolder(CVH holder, int flatPosition, ExpandableGroup group, int childIndex) Called from onBindViewHolder(RecyclerView.ViewHolder, int) when the list item bound to is a child.
abstract void	onBindGroupViewHolder(GVH holder, int flatPosition, ExpandableGroup group) Called from onBindViewHolder(RecyclerView.ViewHolder, int) when the list item bound to is a group
void	onBindViewHolder(ViewHolder holder, int position) Implementation of Adapter.onBindViewHolder(RecyclerView.ViewHolder, int) that determines if the list item is a group or a child and calls through to the appropriate implementation of either onBindGroupViewHolder(GroupViewHolder, int, ExpandableGroup) or onBindChildViewHolder(ChildViewHolder, int, ExpandableGroup, int).
abstract CVH	onCreateChildViewHolder(android.view.ViewGroup parent, int viewType) Called from onCreateViewHolder(ViewGroup, int) when the list item created is a child
abstract GVH	onCreateGroupViewHolder(android.view.ViewGroup parent, int viewType) Called from onCreateViewHolder(ViewGroup, int) when the list item created is a group
ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType) Implementation of Adapter.onCreateViewHolder(ViewGroup, int) that determines if the list item is a group or a child and calls through to the appropriate implementation of either onCreateGroupViewHolder(ViewGroup, int) or onCreateChildViewHolder(ViewGroup, int)}.
boolean	onGroupClick(int flatPos) Triggered by a click on a GroupViewHolder
void	onGroupCollapsed(int positionStart, int itemCount) Called when a group is collapsed
void	onGroupExpanded(int positionStart, int itemCount) Called when a group is expanded
void	onRestoreInstanceState(android.os.Bundle savedInstanceState) Fetches the expandable state map from the saved instance state Bundle and restores the expanded states of all of the list items.
void	onSaveInstanceState(android.os.Bundle savedInstanceState) Stores the expanded state map across state loss.
void	setOnGroupClickListener(OnGroupClickListener listener)
void	setOnGroupExpandCollapseListener(GroupExpandCollapseListener listener)
boolean	toggleGroup(ExpandableGroup group)
boolean	toggleGroup(int flatPos)

Methods inherited from class java.lang.Object

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

Field Detail

expandableList

protected ExpandableList expandableList

Constructor Detail

ExpandableRecyclerViewAdapter

public ExpandableRecyclerViewAdapter(java.util.List<? extends ExpandableGroup> groups)

Method Detail

onCreateViewHolder

public ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                     int viewType)

Implementation of Adapter.onCreateViewHolder(ViewGroup, int) that determines if the list item is a group or a child and calls through to the appropriate implementation of either onCreateGroupViewHolder(ViewGroup, int) or onCreateChildViewHolder(ViewGroup, int)}.

Parameters:

parent - The ViewGroup into which the new View will be added after it is bound to an adapter position.

viewType - The view type of the new android.view.View.

Returns:

Either a new GroupViewHolder or a new ChildViewHolder that holds a android.view.View of the given view type.

onBindViewHolder

public void onBindViewHolder(ViewHolder holder,
                             int position)

Implementation of Adapter.onBindViewHolder(RecyclerView.ViewHolder, int) that determines if the list item is a group or a child and calls through to the appropriate implementation of either onBindGroupViewHolder(GroupViewHolder, int, ExpandableGroup) or onBindChildViewHolder(ChildViewHolder, int, ExpandableGroup, int).

Parameters:

holder - Either the GroupViewHolder or the ChildViewHolder to bind data to

position - The flat position (or index in the list of ExpandableList.getVisibleItemCount() in the list at which to bind

getItemCount

public int getItemCount()

Returns:

the number of group and child objects currently expanded

See Also:

ExpandableList.getVisibleItemCount()

getItemViewType

public int getItemViewType(int position)

Gets the view type of the item at the given position.

Parameters:

position - The flat position in the list to get the view type of

Returns:

or

Throws:

java.lang.RuntimeException - if the item at the given position in the list is not found

onGroupExpanded

public void onGroupExpanded(int positionStart,
                            int itemCount)

Called when a group is expanded

Specified by:

onGroupExpanded in interface ExpandCollapseListener

Parameters:

positionStart - the flat position of the first child in the ExpandableGroup

itemCount - the total number of children in the ExpandableGroup

onGroupCollapsed

public void onGroupCollapsed(int positionStart,
                             int itemCount)

Called when a group is collapsed

Specified by:

onGroupCollapsed in interface ExpandCollapseListener

Parameters:

positionStart - the flat position of the first child in the ExpandableGroup

itemCount - the total number of children in the ExpandableGroup

onGroupClick

public boolean onGroupClick(int flatPos)

Triggered by a click on a GroupViewHolder

Specified by:

onGroupClick in interface OnGroupClickListener

Parameters:

flatPos - the flat position of the GroupViewHolder that was clicked

Returns:

false if click expanded group, true if click collapsed group

toggleGroup

public boolean toggleGroup(int flatPos)

Parameters:

flatPos - The flat list position of the group

Returns:

true if the group is expanded, *after* the toggle, false if the group is now collapsed

toggleGroup

public boolean toggleGroup(ExpandableGroup group)

Parameters:

group - the ExpandableGroup being toggled

Returns:

true if the group is expanded, *after* the toggle, false if the group is now collapsed

isGroupExpanded

public boolean isGroupExpanded(int flatPos)

Parameters:

flatPos - the flattened position of an item in the list

Returns:

true if group is expanded, false if it is collapsed

isGroupExpanded

public boolean isGroupExpanded(ExpandableGroup group)

Parameters:

group - the ExpandableGroup being checked for its collapsed state

Returns:

true if group is expanded, false if it is collapsed

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle savedInstanceState)

Stores the expanded state map across state loss.

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

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

Parameters:

savedInstanceState - The Bundle into which to store the expanded state map

onRestoreInstanceState

public void onRestoreInstanceState(android.os.Bundle savedInstanceState)

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

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

Parameters:

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

setOnGroupClickListener

public void setOnGroupClickListener(OnGroupClickListener listener)

setOnGroupExpandCollapseListener

public void setOnGroupExpandCollapseListener(GroupExpandCollapseListener listener)

getGroups

public java.util.List<? extends ExpandableGroup> getGroups()

The full list of ExpandableGroup backing this RecyclerView

Returns:

the list of ExpandableGroup that this object was instantiated with

onCreateGroupViewHolder

public abstract GVH onCreateGroupViewHolder(android.view.ViewGroup parent,
                                            int viewType)

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

Parameters:

viewType - an int returned by getItemViewType(int)

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

Returns:

A GVH corresponding to the group list item with the ViewGroup parent

onCreateChildViewHolder

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

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

Parameters:

viewType - an int returned by getItemViewType(int)

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

Returns:

A CVH corresponding to child list item with the ViewGroup parent

onBindChildViewHolder

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

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

Bind data to the CVH here.

Parameters:

holder - The CVH to bind data to

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

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

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

onBindGroupViewHolder

public abstract void onBindGroupViewHolder(GVH holder,
                                           int flatPosition,
                                           ExpandableGroup group)

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

Bind data to the GVH here.

Parameters:

holder - The GVH to bind data to

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

group - The ExpandableGroup to be used to bind data to this GVH