io.github.luizgrp.sectionedrecyclerviewadapter

Class SectionedRecyclerViewAdapter

java.lang.Object

androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

io.github.luizgrp.sectionedrecyclerviewadapter.SectionedRecyclerViewAdapter

Direct Known Subclasses:

SectionedRecyclerViewAdapterV2Compat

public class SectionedRecyclerViewAdapter
extends androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

A custom RecyclerView Adapter that allows Sections to be added to it. Sections are displayed in the same order they were added.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VIEW_TYPE_EMPTY
static int	VIEW_TYPE_FAILED
static int	VIEW_TYPE_FOOTER
static int	VIEW_TYPE_HEADER
static int	VIEW_TYPE_ITEM_LOADED
static int	VIEW_TYPE_LOADING

Constructor Summary

Constructors

Constructor and Description
SectionedRecyclerViewAdapter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addSection(int index, Section section) Add a section at the specific position to this adapter with a random tag.
void	addSection(int index, java.lang.String tag, Section section) Add a section to this adapter at the specific index.
java.lang.String	addSection(Section section) Add a section to this adapter with a random tag.
void	addSection(java.lang.String tag, Section section) Add a section to this adapter.
SectionAdapter	getAdapterForSection(Section section)
SectionAdapter	getAdapterForSection(java.lang.String tag)
java.util.Map<java.lang.String,Section>	getCopyOfSectionsMap() Return a copy of the map with all sections of this adapter.
int	getItemCount()
int	getItemViewType(int position)
int	getPositionInSection(int position) Return the item position relative to the section.
Section	getSection(int index) Return the Section at the provided index in the adapter.
Section	getSection(java.lang.String tag) Return the section with the tag provided.
int	getSectionCount() Return the number of sections of this adapter.
Section	getSectionForPosition(int position) Returns the Section object for a position in the adapter.
int	getSectionIndex(Section section) Returns the index of the first occurrence of the specified section in this adapter, or -1 if this adapter does not contain the section.
int	getSectionItemViewType(int position) Returns the Section ViewType of an item based on the position in the adapter.
static int	getSectionItemViewTypeForAdapterViewType(int itemViewType) Calculates the section adapter item view type from a view type from the adapter.
android.view.View	inflate(int layoutResourceId, android.view.ViewGroup parent)
void	onBindViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, int position)
void	onBindViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, int position, java.util.List<java.lang.Object> payloads)
androidx.recyclerview.widget.RecyclerView.ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType)
void	removeAllSections() Remove all sections from this adapter.
void	removeSection(Section section) Remove section from this adapter.
void	removeSection(java.lang.String tag) Remove section from this adapter.

Methods inherited from class androidx.recyclerview.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, getItemId, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onDetachedFromRecyclerView, 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

Field Detail

VIEW_TYPE_HEADER

public static final int VIEW_TYPE_HEADER

See Also:

Constant Field Values

VIEW_TYPE_FOOTER

public static final int VIEW_TYPE_FOOTER

See Also:

Constant Field Values

VIEW_TYPE_ITEM_LOADED

public static final int VIEW_TYPE_ITEM_LOADED

See Also:

Constant Field Values

VIEW_TYPE_LOADING

public static final int VIEW_TYPE_LOADING

See Also:

Constant Field Values

VIEW_TYPE_FAILED

public static final int VIEW_TYPE_FAILED

See Also:

Constant Field Values

VIEW_TYPE_EMPTY

public static final int VIEW_TYPE_EMPTY

See Also:

Constant Field Values

Constructor Detail

SectionedRecyclerViewAdapter

public SectionedRecyclerViewAdapter()

Method Detail

onCreateViewHolder

@NonNull
public androidx.recyclerview.widget.RecyclerView.ViewHolder onCreateViewHolder(@NonNull
                                                                                        android.view.ViewGroup parent,
                                                                                        int viewType)

Specified by:

onCreateViewHolder in class androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

addSection

public java.lang.String addSection(Section section)

Add a section to this adapter with a random tag.

Parameters:

section - section to be added

Returns:

generated tag

addSection

public void addSection(java.lang.String tag,
                       Section section)

Add a section to this adapter.

Parameters:

tag - unique identifier of the section

section - section to be added

addSection

public void addSection(int index,
                       java.lang.String tag,
                       Section section)

Add a section to this adapter at the specific index.

Parameters:

index - the index at which the section should be inserted

tag - unique identifier of the section

section - section should be added

addSection

public java.lang.String addSection(int index,
                                   Section section)

Add a section at the specific position to this adapter with a random tag.

Parameters:

index - the index at which the section should be inserted

section - section should be added

Returns:

generated tag

getSection

public Section getSection(java.lang.String tag)

Return the section with the tag provided.

Parameters:

tag - unique identifier of the section

Returns:

section

removeSection

public void removeSection(Section section)

Remove section from this adapter.

Parameters:

section - section to be removed

removeSection

public void removeSection(java.lang.String tag)

Remove section from this adapter.

Parameters:

tag - unique identifier of the section

removeAllSections

public void removeAllSections()

Remove all sections from this adapter.

onBindViewHolder

public void onBindViewHolder(@NonNull
                             androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                             int position)

Specified by:

onBindViewHolder in class androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

onBindViewHolder

public void onBindViewHolder(@NonNull
                             androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                             int position,
                             @NonNull
                             java.util.List<java.lang.Object> payloads)

Overrides:

onBindViewHolder in class androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

getItemCount

public int getItemCount()

Specified by:

getItemCount in class androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

getItemViewType

public int getItemViewType(int position)

Overrides:

getItemViewType in class androidx.recyclerview.widget.RecyclerView.Adapter<androidx.recyclerview.widget.RecyclerView.ViewHolder>

getSectionItemViewTypeForAdapterViewType

public static int getSectionItemViewTypeForAdapterViewType(int itemViewType)

Calculates the section adapter item view type from a view type from the adapter.

Parameters:

itemViewType - adapter view type

Returns:

one of the view types:

• SectionedRecyclerViewAdapter.VIEW_TYPE_HEADER
• SectionedRecyclerViewAdapter.VIEW_TYPE_FOOTER
• SectionedRecyclerViewAdapter.VIEW_TYPE_ITEM_LOADED
• SectionedRecyclerViewAdapter.VIEW_TYPE_LOADING
• SectionedRecyclerViewAdapter.VIEW_TYPE_FAILED
• SectionedRecyclerViewAdapter.VIEW_TYPE_EMPTY

getSectionItemViewType

public int getSectionItemViewType(int position)

Returns the Section ViewType of an item based on the position in the adapter.

Parameters:

position - position in the adapter

Returns:

one of the view types:

• SectionedRecyclerViewAdapter.VIEW_TYPE_HEADER
• SectionedRecyclerViewAdapter.VIEW_TYPE_FOOTER
• SectionedRecyclerViewAdapter.VIEW_TYPE_ITEM_LOADED
• SectionedRecyclerViewAdapter.VIEW_TYPE_LOADING
• SectionedRecyclerViewAdapter.VIEW_TYPE_FAILED
• SectionedRecyclerViewAdapter.VIEW_TYPE_EMPTY

getSectionForPosition

public Section getSectionForPosition(int position)

Returns the Section object for a position in the adapter.

Parameters:

position - position in the adapter

Returns:

Section object for that position

getPositionInSection

public int getPositionInSection(int position)

Return the item position relative to the section.

Parameters:

position - position of the item in the adapter

Returns:

position of the item in the section

getCopyOfSectionsMap

@NonNull
public java.util.Map<java.lang.String,Section> getCopyOfSectionsMap()

Return a copy of the map with all sections of this adapter.

Returns:

a copy of the map with all sections

getSectionCount

public int getSectionCount()

Return the number of sections of this adapter.

Returns:

number of sections

getSection

public Section getSection(int index)

Return the Section at the provided index in the adapter.

Parameters:

index - index in the adapter

Returns:

Section at the provided index

getSectionIndex

public int getSectionIndex(Section section)

Returns the index of the first occurrence of the specified section in this adapter, or -1 if this adapter does not contain the section. Note that, the visibility of section is being ignored.

Parameters:

section - section to search for

Returns:

the index of the first occurrence of the specified section in this adapter, or -1 if this adapter does not contain the section

getAdapterForSection

public SectionAdapter getAdapterForSection(java.lang.String tag)

getAdapterForSection

public SectionAdapter getAdapterForSection(Section section)

inflate

public android.view.View inflate(@LayoutRes
                                 int layoutResourceId,
                                 android.view.ViewGroup parent)