io.github.luizgrp.sectionedrecyclerviewadapter

Class SectionAdapter

java.lang.Object

io.github.luizgrp.sectionedrecyclerviewadapter.SectionAdapter

public class SectionAdapter
extends java.lang.Object

This class represents a Section in the SectionedRecyclerViewAdapter.

It provides helper methods for:

• identifying position of this Section's items in the SectionedRecyclerViewAdapter
• identifying position of the SectionedRecyclerViewAdapter in this Section
• notifying SectionedRecyclerViewAdapter of item changes in this Section

Method Summary

Modifier and Type	Method and Description
int	getFooterPosition() Helper method that returns the position of footer in the adapter.
int	getHeaderPosition() Helper method that returns the position of header in the adapter.
int	getPositionInAdapter(int position) Helper method that receives position in relation to the section, and returns the position in the adapter.
int	getPositionInSection(int position) Return the item position in the section.
int	getSectionPosition() Return the section position in the adapter.
void	notifyAllItemsChanged() Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).
void	notifyAllItemsChanged(java.lang.Object payload) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).
void	notifyAllItemsInserted() Helper method that calculates the relative position of all items of this section in the adapter and calls RecyclerView.Adapter.notifyItemRangeInserted(int, int).
void	notifyFooterChanged() Helper method that calculates the relative footer position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyFooterChanged(java.lang.Object payload) Helper method that calculates the relative footer position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyFooterInserted() Helper method that calls RecyclerView.Adapter.notifyItemInserted(int) with the position of the section's footer in the adapter.
void	notifyFooterRemoved() Helper method that calls RecyclerView.Adapter.notifyItemRemoved(int) with the position of the section's footer in the adapter.
void	notifyHeaderChanged() Helper method that calculates the relative header position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyHeaderChanged(java.lang.Object payload) Helper method that calculates the relative header position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyHeaderInserted() Helper method that calls RecyclerView.Adapter.notifyItemInserted(int) with the position of the section's header in the adapter.
void	notifyHeaderRemoved() Helper method that calls RecyclerView.Adapter.notifyItemRemoved(int) with the position of the section's header in the adapter.
void	notifyItemChanged(int position) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyItemChanged(int position, java.lang.Object payload) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).
void	notifyItemInserted(int position) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemInserted(int).
void	notifyItemMoved(int fromPosition, int toPosition) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemMoved(int, int).
void	notifyItemRangeChanged(int positionStart, int itemCount) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).
void	notifyItemRangeChanged(int positionStart, int itemCount, java.lang.Object payload) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).
void	notifyItemRangeInserted(int positionStart, int itemCount) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeInserted(int, int).
void	notifyItemRangeRemoved(int positionStart, int itemCount) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeRemoved(int, int).
void	notifyItemRemoved(int position) Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRemoved(int).
void	notifyNotLoadedStateChanged(Section.State previousState) Helper method that calls RecyclerView.Adapter.notifyItemChanged(int) with the position of the Section.State view holder in the adapter.
void	notifySectionChangedToInvisible(int previousSectionPosition) Helper method that calls RecyclerView.Adapter.notifyItemRangeInserted(int, int) with the position of the section in the adapter.
void	notifySectionChangedToVisible() Helper method that calls RecyclerView.Adapter.notifyItemRangeInserted(int, int) with the position of the section in the adapter.
void	notifyStateChangedFromLoaded(int previousContentItemsCount) Helper method that calls RecyclerView.Adapter.notifyItemRangeRemoved(int, int) and RecyclerView.Adapter.notifyItemChanged(int) with the position of the Section.State view holder in the adapter.
void	notifyStateChangedToLoaded(Section.State previousState) Helper method that calls RecyclerView.Adapter.notifyItemChanged(int) and RecyclerView.Adapter.notifyItemInserted(int) with the position of the Section.State view holder in the adapter.

Methods inherited from class java.lang.Object

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

Method Detail

getHeaderPosition

public int getHeaderPosition()

Helper method that returns the position of header in the adapter.

Returns:

position of the header in the adapter

getFooterPosition

public int getFooterPosition()

Helper method that returns the position of footer in the adapter.

Returns:

position of the footer in the adapter

getSectionPosition

public int getSectionPosition()

Return the section position in the adapter.

Returns:

position of the section in the adapter

getPositionInAdapter

public int getPositionInAdapter(int position)

Helper method that receives position in relation to the section, and returns the position in the adapter.

Parameters:

position - position of the item in the section

Returns:

position of the item in the adapter

getPositionInSection

public int getPositionInSection(int position)

Return the item position in the section.

Parameters:

position - position of the item in the adapter

Returns:

position of the item in the section

notifyItemInserted

public void notifyItemInserted(int position)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemInserted(int).

Parameters:

position - position of the item in the section

notifyAllItemsInserted

public void notifyAllItemsInserted()

Helper method that calculates the relative position of all items of this section in the adapter and calls RecyclerView.Adapter.notifyItemRangeInserted(int, int).

notifyItemRangeInserted

public void notifyItemRangeInserted(int positionStart,
                                    int itemCount)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeInserted(int, int).

Parameters:

positionStart - position of the first item that was inserted in the section

itemCount - number of items inserted in the section

notifyItemRemoved

public void notifyItemRemoved(int position)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRemoved(int).

Parameters:

position - position of the item in the section

notifyItemRangeRemoved

public void notifyItemRangeRemoved(int positionStart,
                                   int itemCount)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeRemoved(int, int).

Parameters:

positionStart - previous position of the first item that was removed from the section

itemCount - number of items removed from the section

notifyHeaderChanged

public void notifyHeaderChanged()

Helper method that calculates the relative header position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

notifyHeaderChanged

public void notifyHeaderChanged(@Nullable
                                java.lang.Object payload)

Helper method that calculates the relative header position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

Parameters:

payload - optional parameter, use null to identify a "full" update

notifyFooterChanged

public void notifyFooterChanged()

Helper method that calculates the relative footer position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

notifyFooterChanged

public void notifyFooterChanged(@Nullable
                                java.lang.Object payload)

Helper method that calculates the relative footer position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

Parameters:

payload - optional parameter, use null to identify a "full" update

notifyItemChanged

public void notifyItemChanged(int position)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

Parameters:

position - position of the item in the section

notifyItemChanged

public void notifyItemChanged(int position,
                              @Nullable
                              java.lang.Object payload)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemChanged(int).

Parameters:

position - position of the item in the section

payload - optional parameter, use null to identify a "full" update

notifyAllItemsChanged

public void notifyAllItemsChanged()

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).

notifyAllItemsChanged

public void notifyAllItemsChanged(@Nullable
                                  java.lang.Object payload)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).

Parameters:

payload - optional parameter, use null to identify a "full" update

notifyItemRangeChanged

public void notifyItemRangeChanged(int positionStart,
                                   int itemCount)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).

Parameters:

positionStart - position of the first item that was changed in the section

itemCount - number of items changed in the section

notifyItemRangeChanged

public void notifyItemRangeChanged(int positionStart,
                                   int itemCount,
                                   @Nullable
                                   java.lang.Object payload)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemRangeChanged(int, int).

Parameters:

positionStart - position of the first item that was inserted in the section

itemCount - number of items inserted in the section

payload - optional parameter, use null to identify a "full" update

notifyItemMoved

public void notifyItemMoved(int fromPosition,
                            int toPosition)

Helper method that receives position in relation to the section, calculates the relative position in the adapter and calls RecyclerView.Adapter.notifyItemMoved(int, int).

Parameters:

fromPosition - previous position of the item in the section

toPosition - new position of the item in the section

notifyNotLoadedStateChanged

public void notifyNotLoadedStateChanged(Section.State previousState)

Helper method that calls RecyclerView.Adapter.notifyItemChanged(int) with the position of the Section.State view holder in the adapter. Useful to be called after changing the State from LOADING/FAILED/EMPTY to LOADING/FAILED/EMPTY.

Parameters:

previousState - previous state of section

notifyStateChangedToLoaded

public void notifyStateChangedToLoaded(Section.State previousState)

Helper method that calls RecyclerView.Adapter.notifyItemChanged(int) and RecyclerView.Adapter.notifyItemInserted(int) with the position of the Section.State view holder in the adapter. Useful to be called after changing the State from LOADING/FAILED/EMPTY to LOADED.

Parameters:

previousState - previous state of section

notifyStateChangedFromLoaded

public void notifyStateChangedFromLoaded(int previousContentItemsCount)

Helper method that calls RecyclerView.Adapter.notifyItemRangeRemoved(int, int) and RecyclerView.Adapter.notifyItemChanged(int) with the position of the Section.State view holder in the adapter. Useful to be called after changing the State from LOADED to LOADING/FAILED/EMPTY.

Parameters:

previousContentItemsCount - previous content items count of section

notifyHeaderInserted

public void notifyHeaderInserted()

Helper method that calls RecyclerView.Adapter.notifyItemInserted(int) with the position of the section's header in the adapter. Useful to be called after changing the visibility of the section's header to visible with Section.setHasHeader(boolean).

notifyFooterInserted

public void notifyFooterInserted()

Helper method that calls RecyclerView.Adapter.notifyItemInserted(int) with the position of the section's footer in the adapter. Useful to be called after changing the visibility of the section's footer to visible with Section.setHasFooter(boolean).

notifyHeaderRemoved

public void notifyHeaderRemoved()

Helper method that calls RecyclerView.Adapter.notifyItemRemoved(int) with the position of the section's header in the adapter. Useful to be called after changing the visibility of the section's header to invisible with Section.setHasHeader(boolean).

notifyFooterRemoved

public void notifyFooterRemoved()

Helper method that calls RecyclerView.Adapter.notifyItemRemoved(int) with the position of the section's footer in the adapter. Useful to be called after changing the visibility of the section's footer to invisible with Section.setHasFooter(boolean).

notifySectionChangedToVisible

public void notifySectionChangedToVisible()

Helper method that calls RecyclerView.Adapter.notifyItemRangeInserted(int, int) with the position of the section in the adapter. Useful to be called after changing the visibility of the section to visible with Section.setVisible(boolean).

notifySectionChangedToInvisible

public void notifySectionChangedToInvisible(int previousSectionPosition)

Helper method that calls RecyclerView.Adapter.notifyItemRangeInserted(int, int) with the position of the section in the adapter. Useful to be called after changing the visibility of the section to invisible with Section.setVisible(boolean).

Parameters:

previousSectionPosition - previous section position