io.github.luizgrp.sectionedrecyclerviewadapter

Class Section

java.lang.Object

io.github.luizgrp.sectionedrecyclerviewadapter.Section

public abstract class Section
extends java.lang.Object

Abstract Section to be used with SectionedRecyclerViewAdapter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Section.State

Constructor Summary

Constructors

Constructor and Description
Section(SectionParameters sectionParameters) Create a Section object based on SectionParameters.

Method Summary

Modifier and Type	Method and Description
abstract int	getContentItemsTotal() Return the total of items of this Section.
java.lang.Integer	getEmptyResourceId() Return the layout resource id of the empty view.
android.view.View	getEmptyView(android.view.ViewGroup parent) Creates the View for the Empty state.
androidx.recyclerview.widget.RecyclerView.ViewHolder	getEmptyViewHolder(android.view.View view) Return the ViewHolder for the Empty state of this Section.
java.lang.Integer	getFailedResourceId() Return the layout resource id of the failed view.
android.view.View	getFailedView(android.view.ViewGroup parent) Creates the View for the Failed state.
androidx.recyclerview.widget.RecyclerView.ViewHolder	getFailedViewHolder(android.view.View view) Return the ViewHolder for the Failed state of this Section.
java.lang.Integer	getFooterResourceId() Return the layout resource id of the footer.
android.view.View	getFooterView(android.view.ViewGroup parent) Creates the View for the Footer.
androidx.recyclerview.widget.RecyclerView.ViewHolder	getFooterViewHolder(android.view.View view) Return the ViewHolder for the Footer of this Section.
java.lang.Integer	getHeaderResourceId() Return the layout resource id of the header.
android.view.View	getHeaderView(android.view.ViewGroup parent) Creates the View for the Header.
androidx.recyclerview.widget.RecyclerView.ViewHolder	getHeaderViewHolder(android.view.View view) Return the ViewHolder for the Header of this Section.
java.lang.Integer	getItemResourceId() Return the layout resource id of the item.
android.view.View	getItemView(android.view.ViewGroup parent) Creates the View for a single Item.
abstract androidx.recyclerview.widget.RecyclerView.ViewHolder	getItemViewHolder(android.view.View view) Return the ViewHolder for a single Item of this Section.
java.lang.Integer	getLoadingResourceId() Return the layout resource id of the loading view.
android.view.View	getLoadingView(android.view.ViewGroup parent) Creates the View for the Loading state.
androidx.recyclerview.widget.RecyclerView.ViewHolder	getLoadingViewHolder(android.view.View view) Return the ViewHolder for the Loading state of this Section.
int	getSectionItemsTotal() Return the total of items of this Section, including content items (according to the section state) plus header and footer.
Section.State	getState() Return the current State of this Section.
boolean	hasFooter() Check if this Section has a footer.
boolean	hasHeader() Check if this Section has a header.
boolean	isEmptyViewWillBeProvided() Return whether the empty view is provided through getEmptyView(ViewGroup).
boolean	isFailedViewWillBeProvided() Return whether the failed view is provided through getFailedView(ViewGroup).
boolean	isFooterViewWillBeProvided() Return whether the footer view is provided through getFooterView(ViewGroup).
boolean	isHeaderViewWillBeProvided() Return whether the header view is provided through getHeaderView(ViewGroup).
boolean	isItemViewWillBeProvided() Return whether the item view is provided through getItemView(ViewGroup).
boolean	isLoadingViewWillBeProvided() Return whether the loading view is provided through getLoadingView(ViewGroup).
boolean	isVisible() Check if this Section is visible.
void	onBindEmptyViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder) Bind the data to the ViewHolder for the Empty state of this Section.
void	onBindEmptyViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for the Empty state of this Section.
void	onBindFailedViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder) Bind the data to the ViewHolder for the Failed state of this Section.
void	onBindFailedViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for the Failed state of this Section.
void	onBindFooterViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder) Bind the data to the ViewHolder for the Footer of this Section.
void	onBindFooterViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for the Footer of this Section.
void	onBindHeaderViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder) Bind the data to the ViewHolder for the Header of this Section.
void	onBindHeaderViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for the Header of this Section.
abstract void	onBindItemViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, int position) Bind the data to the ViewHolder for an Item of this Section.
void	onBindItemViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, int position, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for an Item of this Section.
void	onBindLoadingViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder) Bind the data to the ViewHolder for Loading state of this Section.
void	onBindLoadingViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder, java.util.List<java.lang.Object> payloads) Bind the data to the ViewHolder for Loading state of this Section.
void	setHasFooter(boolean hasFooter) Set if this Section has footer.
void	setHasHeader(boolean hasHeader) Set if this Section has header.
void	setState(Section.State state) Set the State of this Section.
void	setVisible(boolean visible) Set if this Section is visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

public Section(@NonNull
               SectionParameters sectionParameters)

Create a Section object based on SectionParameters.

Parameters:

sectionParameters - section parameters

Method Detail

setState

public final void setState(Section.State state)

Set the State of this Section.

Parameters:

state - state of this section

getState

public final Section.State getState()

Return the current State of this Section.

Returns:

current state of this section

isVisible

public final boolean isVisible()

Check if this Section is visible.

Returns:

true if this Section is visible

setVisible

public final void setVisible(boolean visible)

Set if this Section is visible.

Parameters:

visible - true if this Section is visible

hasHeader

public final boolean hasHeader()

Check if this Section has a header.

Returns:

true if this Section has a header

setHasHeader

public final void setHasHeader(boolean hasHeader)

Set if this Section has header.

Parameters:

hasHeader - true if this Section has a header

hasFooter

public final boolean hasFooter()

Check if this Section has a footer.

Returns:

true if this Section has a footer

setHasFooter

public final void setHasFooter(boolean hasFooter)

Set if this Section has footer.

Parameters:

hasFooter - true if this Section has a footer

isItemViewWillBeProvided

public final boolean isItemViewWillBeProvided()

Return whether the item view is provided through getItemView(ViewGroup). If false, the item view is inflated using the resource from getItemResourceId().

Returns:

whether the item view is provided through getItemView(ViewGroup).

getItemResourceId

public final java.lang.Integer getItemResourceId()

Return the layout resource id of the item.

Returns:

layout resource id of the item

isHeaderViewWillBeProvided

public final boolean isHeaderViewWillBeProvided()

Return whether the header view is provided through getHeaderView(ViewGroup). If false, the header view is inflated using the resource from getHeaderResourceId().

Returns:

whether the header view is provided through getHeaderView(ViewGroup).

getHeaderResourceId

public final java.lang.Integer getHeaderResourceId()

Return the layout resource id of the header.

Returns:

layout resource id of the header

isFooterViewWillBeProvided

public final boolean isFooterViewWillBeProvided()

Return whether the footer view is provided through getFooterView(ViewGroup). If false, the footer view is inflated using the resource from getFooterResourceId().

Returns:

whether the footer view is provided through getFooterView(ViewGroup).

getFooterResourceId

public final java.lang.Integer getFooterResourceId()

Return the layout resource id of the footer.

Returns:

layout resource id of the footer

isLoadingViewWillBeProvided

public final boolean isLoadingViewWillBeProvided()

Return whether the loading view is provided through getLoadingView(ViewGroup). If false, the loading view is inflated using the resource from getLoadingResourceId().

Returns:

whether the loading view is provided through getLoadingView(ViewGroup).

getLoadingResourceId

public final java.lang.Integer getLoadingResourceId()

Return the layout resource id of the loading view.

Returns:

layout resource id of the loading view

isFailedViewWillBeProvided

public final boolean isFailedViewWillBeProvided()

Return whether the failed view is provided through getFailedView(ViewGroup). If false, the failed view is inflated using the resource from getFailedResourceId().

Returns:

whether the failed view is provided through getFailedView(ViewGroup).

getFailedResourceId

public final java.lang.Integer getFailedResourceId()

Return the layout resource id of the failed view.

Returns:

layout resource id of the failed view

isEmptyViewWillBeProvided

public final boolean isEmptyViewWillBeProvided()

Return whether the empty view is provided through getEmptyView(ViewGroup). If false, the empty view is inflated using the resource from getEmptyResourceId().

Returns:

whether the empty view is provided through getEmptyView(ViewGroup).

getEmptyResourceId

public final java.lang.Integer getEmptyResourceId()

Return the layout resource id of the empty view.

Returns:

layout resource id of the empty view

getSectionItemsTotal

public final int getSectionItemsTotal()

Return the total of items of this Section, including content items (according to the section state) plus header and footer.

Returns:

total of items of this section

getContentItemsTotal

public abstract int getContentItemsTotal()

Return the total of items of this Section.

Returns:

total of items of this Section

getItemView

public android.view.View getItemView(android.view.ViewGroup parent)

Creates the View for a single Item. This must be implemented if and only if isItemViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for an Item of this Section.

getItemViewHolder

public abstract androidx.recyclerview.widget.RecyclerView.ViewHolder getItemViewHolder(android.view.View view)

Return the ViewHolder for a single Item of this Section.

Parameters:

view - View created by getItemView or inflated resource returned by getItemResourceId

Returns:

ViewHolder for the Item of this Section

onBindItemViewHolder

public abstract void onBindItemViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                          int position)

Bind the data to the ViewHolder for an Item of this Section.

Parameters:

holder - ViewHolder for the Item of this Section

position - position of the item in the Section, not in the RecyclerView

onBindItemViewHolder

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

Bind the data to the ViewHolder for an Item of this Section.

Parameters:

holder - ViewHolder for the Item of this Section

position - position of the item in the Section, not in the RecyclerView

payloads - A non-null and non-empty list of merged payloads.

getHeaderView

public android.view.View getHeaderView(android.view.ViewGroup parent)

Creates the View for the Header. This must be implemented if and only if isHeaderViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for the Header of this Section.

getHeaderViewHolder

public androidx.recyclerview.widget.RecyclerView.ViewHolder getHeaderViewHolder(android.view.View view)

Return the ViewHolder for the Header of this Section.

Parameters:

view - View inflated by resource returned by getHeaderResourceId

Returns:

ViewHolder for the Header of this Section

onBindHeaderViewHolder

public void onBindHeaderViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder)

Bind the data to the ViewHolder for the Header of this Section.

Parameters:

holder - ViewHolder for the Header of this Section

onBindHeaderViewHolder

public void onBindHeaderViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                   java.util.List<java.lang.Object> payloads)

Bind the data to the ViewHolder for the Header of this Section.

Parameters:

holder - ViewHolder for the Header of this Section

payloads - A non-null and non-empty list of merged payloads.

getFooterView

public android.view.View getFooterView(android.view.ViewGroup parent)

Creates the View for the Footer. This must be implemented if and only if isFooterViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for the Footer of this Section.

getFooterViewHolder

public androidx.recyclerview.widget.RecyclerView.ViewHolder getFooterViewHolder(android.view.View view)

Return the ViewHolder for the Footer of this Section.

Parameters:

view - View inflated by resource returned by getFooterResourceId

Returns:

ViewHolder for the Footer of this Section

onBindFooterViewHolder

public void onBindFooterViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder)

Bind the data to the ViewHolder for the Footer of this Section.

Parameters:

holder - ViewHolder for the Footer of this Section

onBindFooterViewHolder

public void onBindFooterViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                   java.util.List<java.lang.Object> payloads)

Bind the data to the ViewHolder for the Footer of this Section.

Parameters:

holder - ViewHolder for the Footer of this Section

payloads - A non-null and non-empty list of merged payloads.

getLoadingView

public android.view.View getLoadingView(android.view.ViewGroup parent)

Creates the View for the Loading state. This must be implemented if and only if isLoadingViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for the Loading state of this Section.

getLoadingViewHolder

public androidx.recyclerview.widget.RecyclerView.ViewHolder getLoadingViewHolder(android.view.View view)

Return the ViewHolder for the Loading state of this Section.

Parameters:

view - View inflated by resource returned by getItemResourceId

Returns:

ViewHolder for the Loading state of this Section

onBindLoadingViewHolder

public void onBindLoadingViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder)

Bind the data to the ViewHolder for Loading state of this Section.

Parameters:

holder - ViewHolder for the Loading state of this Section

onBindLoadingViewHolder

public void onBindLoadingViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                    java.util.List<java.lang.Object> payloads)

Bind the data to the ViewHolder for Loading state of this Section.

Parameters:

holder - ViewHolder for the Loading state of this Section

payloads - A non-null and non-empty list of merged payloads.

getFailedView

public android.view.View getFailedView(android.view.ViewGroup parent)

Creates the View for the Failed state. This must be implemented if and only if isFailedViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for the Failed state of this Section.

getFailedViewHolder

public androidx.recyclerview.widget.RecyclerView.ViewHolder getFailedViewHolder(android.view.View view)

Return the ViewHolder for the Failed state of this Section.

Parameters:

view - View inflated by resource returned by getItemResourceId

Returns:

ViewHolder for the Failed of this Section

onBindFailedViewHolder

public void onBindFailedViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder)

Bind the data to the ViewHolder for the Failed state of this Section.

Parameters:

holder - ViewHolder for the Failed state of this Section

onBindFailedViewHolder

public void onBindFailedViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                   java.util.List<java.lang.Object> payloads)

Bind the data to the ViewHolder for the Failed state of this Section.

Parameters:

holder - ViewHolder for the Failed state of this Section

payloads - A non-null and non-empty list of merged payloads.

getEmptyView

public android.view.View getEmptyView(android.view.ViewGroup parent)

Creates the View for the Empty state. This must be implemented if and only if isEmptyViewWillBeProvided() is true.

Parameters:

parent - The parent view. Note that there is no need to attach the new view.

Returns:

View for the Empty state of this Section.

getEmptyViewHolder

public androidx.recyclerview.widget.RecyclerView.ViewHolder getEmptyViewHolder(android.view.View view)

Return the ViewHolder for the Empty state of this Section.

Parameters:

view - View inflated by resource returned by getItemResourceId

Returns:

ViewHolder for the Empty of this Section

onBindEmptyViewHolder

public void onBindEmptyViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder)

Bind the data to the ViewHolder for the Empty state of this Section.

Parameters:

holder - ViewHolder for the Empty state of this Section

onBindEmptyViewHolder

public void onBindEmptyViewHolder(androidx.recyclerview.widget.RecyclerView.ViewHolder holder,
                                  java.util.List<java.lang.Object> payloads)

Bind the data to the ViewHolder for the Empty state of this Section.

Parameters:

holder - ViewHolder for the Empty state of this Section

payloads - A non-null and non-empty list of merged payloads.