mva2.adapter

Class MultiViewAdapter

java.lang.Object

<any>

mva2.adapter.MultiViewAdapter

public class MultiViewAdapter
extends <any>

MultiViewAdapter lets you write complex RecyclerView adapters easily.

MultiViewAdapter consists of Sections and ItemBinders. Both are modular and composable meaning that they can be used in any adapter and you can use as many of them inside a single adapter.

Apart from this MultiViewAdapter has lot of other features like,

• Selection
• Expansion (Item level)
• Expansion (Section level)
• Decoration

Constructor Summary

Constructors

Constructor and Description
MultiViewAdapter() No-arg constructor for MultiViewAdapter.

Method Summary

Modifier and Type	Method and Description
void	addSection(Section section) Add a section to this adapter.
void	clearAllSelections() Clears all the selected items inside the adapter.
void	collapseAllItems() Collapses all the items inside the adapter.
void	collapseAllSections() Collapses all the sections inside the adapter.
void	drawDecoration(android.graphics.Canvas canvas, RecyclerView parent, RecyclerView.State state, android.view.View child, int adapterPosition)
void	getDecorationOffset(android.graphics.Rect outRect, android.view.View view, RecyclerView parent, RecyclerView.State state, int adapterPosition)
int	getItemCount()
RecyclerView.ItemDecoration	getItemDecoration() If you would like to use the decoration feature of the adapter, use this method to get ItemDecoration and add it to your recyclerview.
ItemTouchHelper	getItemTouchHelper() Get the ItemTouchHelper which resolves the swipe and drag gestures for the adapter's individual ItemBinder.
int	getItemViewType(int adapterPosition)
int	getPositionType(RecyclerView parent, int adapterPosition) Returns the positionType of the item inside the layout manager.
SectionPositionType	getSectionPositionType(int adapterPosition) Returns the SectionPositionType for the giver adapter position.
int	getSpanSize(int adapterPosition)
GridLayoutManager.SpanSizeLookup	getSpanSizeLookup() Return the span size lookup used by this adapter.
void	onBindViewHolder(ItemViewHolder holder, int adapterPosition)
void	onBindViewHolder(ItemViewHolder holder, int adapterPosition, java.util.List<java.lang.Object> payloads)
ItemViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType)
void	onItemDismiss(int adapterPosition)
void	onMove(int initialPosition, int targetPosition)
void	registerItemBinders(ItemBinder... itemBinders) Register an ItemBinder to the adapter.
void	removeAllSections() Remove all the sections added to the adapter
void	setExpansionMode(Mode expansionMode) Set the expansion mode for this adapter.
void	setInfiniteLoadingHelper(InfiniteLoadingHelper infiniteLoadingHelper) By setting an infiniteLoadingHelper, you can add infinite scrolling feature to the adapter.
void	setSectionExpansionMode(Mode sectionExpansionMode) Set the section expansion mode for this adapter.
void	setSelectionMode(Mode selectionMode) Set the selection mode for this adapter.
void	setSpanCount(int spanCount) Set the span count for the adapter.
void	startActionMode() Helper method to set the adapter is in contextual action mode.
void	stopActionMode() Helper method to set the adapter has exited contextual action mode.
void	unRegisterAllItemBinders() Removes all the ItemBinders which were registered to this adapter.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiViewAdapter

public MultiViewAdapter()

No-arg constructor for MultiViewAdapter. Initializes the MultiViewAdapter class.

Method Detail

addSection

public void addSection(Section section)

Add a section to this adapter. You can add any number of section to the adapter. If null is being set, then this method returns silently. If the section was already added to a parent, and you are adding it again, then IllegalStateException will be thrown.

Parameters:

section - Section to be added to this adapter.

Throws:

java.lang.IllegalStateException - If the section already has a parent.

clearAllSelections

public void clearAllSelections()

Clears all the selected items inside the adapter.

collapseAllItems

public void collapseAllItems()

Collapses all the items inside the adapter.

collapseAllSections

public void collapseAllSections()

Collapses all the sections inside the adapter.

getItemDecoration

public RecyclerView.ItemDecoration getItemDecoration()

If you would like to use the decoration feature of the adapter, use this method to get ItemDecoration and add it to your recyclerview.

Usage : recyclerView.addItemDecoration(adapter.getItemDecoration());

Returns:

The ItemDecoration for this adapter

getItemTouchHelper

public ItemTouchHelper getItemTouchHelper()

Get the ItemTouchHelper which resolves the swipe and drag gestures for the adapter's individual ItemBinder.

Returns:

ItemTouchHelper which needs to be attached with RecyclerView

getPositionType

public int getPositionType(RecyclerView parent,
                           int adapterPosition)

Returns the positionType of the item inside the layout manager.

What is positionType? Position type lets you know the edges for the item. For example, inside LinearLayoutManager, item 0 will be at top edge, left edge and right edge. Inside GridLayoutManager, item 0 will be at top edge and left edge. This information can be retrieved with the help of Decorator. Ex : Decorator.isItemOnLeftEdge(int) etc.,

By knowing this information you can draw the decorations creatively.

Parameters:

parent - RecyclerView where this adapter is attached.

adapterPosition - Position of the item inside the adapter.

Returns:

PositionType for the adapterPosition

getSectionPositionType

public SectionPositionType getSectionPositionType(int adapterPosition)

Returns the SectionPositionType for the giver adapter position.

SectionPositionType lets you know whether the Section is at the TOP, MIDDLE or BOTTOM of the adapter. By knowing this information you can draw the decorations creatively.

Parameters:

adapterPosition - Position of the item inside the adapter.

Returns:

SectionPositionType for the adapterPosition

getSpanSizeLookup

public GridLayoutManager.SpanSizeLookup getSpanSizeLookup()

Return the span size lookup used by this adapter. Make sure to set this SpanSizeLookup to your grid layout manager.

Returns:

Span size lookup used in this adapter

registerItemBinders

public void registerItemBinders(ItemBinder... itemBinders)

Register an ItemBinder to the adapter.

Each ItemBinder can create and bind ViewHolders for a model. If no ItemBinders are registered with adapter, IllegalStateException will be thrown.

removeAllSections

public void removeAllSections()

Remove all the sections added to the adapter

setExpansionMode

public void setExpansionMode(Mode expansionMode)

Set the expansion mode for this adapter. This will be used by all the section unless the section has its own expansion mode.

Parameters:

expansionMode - Mode to be set as expansion mode

setInfiniteLoadingHelper

public void setInfiniteLoadingHelper(InfiniteLoadingHelper infiniteLoadingHelper)

By setting an infiniteLoadingHelper, you can add infinite scrolling feature to the adapter.

Usage : InfiniteLoadingHelper helper = new InfiniteLoadingHelper(recyclerView, R.layout.item_infinite_loader);
adapter.setInfiniteLoadingHelper(helper);

Parameters:

infiniteLoadingHelper - Helper object to be set

See Also:

InfiniteLoadingHelper

setSectionExpansionMode

public void setSectionExpansionMode(Mode sectionExpansionMode)

Set the section expansion mode for this adapter. This will be used by all the section unless the section has its own section expansion mode.

Parameters:

sectionExpansionMode - Mode to be set as section expansion mode

setSelectionMode

public void setSelectionMode(Mode selectionMode)

Set the selection mode for this adapter. This will be used by all the section unless the section has its own selection mode.

Parameters:

selectionMode - Mode to be set as selection mode

setSpanCount

public void setSpanCount(int spanCount)

Set the span count for the adapter. This will be used for all the section unless the section has its own span count.

Parameters:

spanCount - Span count to be set

startActionMode

public void startActionMode()

Helper method to set the adapter is in contextual action mode.

See Also:

To get the state of action mode

stopActionMode

public void stopActionMode()

Helper method to set the adapter has exited contextual action mode.

See Also:

To get the state of action mode

unRegisterAllItemBinders

public void unRegisterAllItemBinders()

Removes all the ItemBinders which were registered to this adapter. Make sure that new ItemBinders are registered to this adapter.

getSpanSize

public final int getSpanSize(int adapterPosition)

drawDecoration

public final void drawDecoration(android.graphics.Canvas canvas,
                                 RecyclerView parent,
                                 RecyclerView.State state,
                                 android.view.View child,
                                 int adapterPosition)

getDecorationOffset

public final void getDecorationOffset(android.graphics.Rect outRect,
                                      android.view.View view,
                                      RecyclerView parent,
                                      RecyclerView.State state,
                                      int adapterPosition)

onItemDismiss

public final void onItemDismiss(int adapterPosition)

onMove

public final void onMove(int initialPosition,
                         int targetPosition)

onCreateViewHolder

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

onBindViewHolder

public final void onBindViewHolder(ItemViewHolder holder,
                                   int adapterPosition)

onBindViewHolder

public final void onBindViewHolder(ItemViewHolder holder,
                                   int adapterPosition,
                                   java.util.List<java.lang.Object> payloads)

getItemViewType

public final int getItemViewType(int adapterPosition)

getItemCount

public final int getItemCount()