com.bignerdranch.expandablerecyclerview

Class ParentViewHolder<P extends Parent<C>,C>

java.lang.Object

RecyclerView.ViewHolder

com.bignerdranch.expandablerecyclerview.ParentViewHolder<P,C>

All Implemented Interfaces:

android.view.View.OnClickListener

public class ParentViewHolder<P extends Parent<C>,C>
extends RecyclerView.ViewHolder
implements android.view.View.OnClickListener

ViewHolder for a Parent Keeps track of expanded state and holds callbacks which can be used to trigger expansion-based events.

Since:

5/27/2015

Constructor Summary

Constructors

Constructor and Description
ParentViewHolder(android.view.View itemView) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	collapseView() Triggers collapse of the parent.
protected void	expandView() Triggers expansion of the parent.
P	getParent()
int	getParentAdapterPosition() Returns the adapter position of the Parent associated with this ParentViewHolder
boolean	isExpanded() Returns expanded state for the Parent corresponding to this ParentViewHolder.
void	onClick(android.view.View v) View.OnClickListener to listen for click events on the entire parent View.
void	onExpansionToggled(boolean expanded) Callback triggered when expansion state is changed, but not during initialization.
void	setExpanded(boolean expanded) Setter method for expanded state, used for initialization of expanded state.
void	setMainItemClickToExpand() Sets a View.OnClickListener on the entire parent view to trigger expansion.
boolean	shouldItemViewClickToggleExpansion() Used to determine whether a click in the entire parent View should trigger row expansion.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentViewHolder

@UiThread
public ParentViewHolder(@NonNull
                                  android.view.View itemView)

Default constructor.

Parameters:

itemView - The View being hosted in this ViewHolder

Method Detail

getParent

@UiThread
public P getParent()

Returns:

the Parent associated with this ViewHolder

getParentAdapterPosition

@UiThread
public int getParentAdapterPosition()

Returns the adapter position of the Parent associated with this ParentViewHolder

Returns:

The adapter position of the Parent if it still exists in the adapter. RecyclerView.NO_POSITION if item has been removed from the adapter, RecyclerView.Adapter.notifyDataSetChanged() has been called after the last layout pass or the ViewHolder has already been recycled.

setMainItemClickToExpand

@UiThread
public void setMainItemClickToExpand()

Sets a View.OnClickListener on the entire parent view to trigger expansion.

isExpanded

@UiThread
public boolean isExpanded()

Returns expanded state for the Parent corresponding to this ParentViewHolder.

Returns:

true if expanded, false if not

setExpanded

@UiThread
public void setExpanded(boolean expanded)

Setter method for expanded state, used for initialization of expanded state. changes to the state are given in onExpansionToggled(boolean)

Parameters:

expanded - true if expanded, false if not

onExpansionToggled

@UiThread
public void onExpansionToggled(boolean expanded)

Callback triggered when expansion state is changed, but not during initialization.

Useful for implementing animations on expansion.

Parameters:

expanded - true if view is expanded before expansion is toggled, false if not

onClick

@UiThread
public void onClick(android.view.View v)

View.OnClickListener to listen for click events on the entire parent View.

Only registered if shouldItemViewClickToggleExpansion() is true.

Specified by:

onClick in interface android.view.View.OnClickListener

Parameters:

v - The View that is the trigger for expansion

shouldItemViewClickToggleExpansion

@UiThread
public boolean shouldItemViewClickToggleExpansion()

Used to determine whether a click in the entire parent View should trigger row expansion.

If you return false, you can call expandView() to trigger an expansion in response to a another event or collapseView() to trigger a collapse.

Returns:

true to set an View.OnClickListener on the item view

expandView

@UiThread
protected void expandView()

Triggers expansion of the parent.

collapseView

@UiThread
protected void collapseView()

Triggers collapse of the parent.