com.paginate.recycler

Class RecyclerPaginate.Builder

java.lang.Object

com.paginate.recycler.RecyclerPaginate.Builder

Enclosing class:

RecyclerPaginate

public static class RecyclerPaginate.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RecyclerPaginate.Builder(RecyclerView recyclerView, Paginate.Callbacks callbacks)

Method Summary

Methods

Modifier and Type	Method and Description
RecyclerPaginate.Builder	addLoadingListItem(boolean addLoadingListItem) Setup loading row.
Paginate	build() Create pagination functionality upon RecyclerView.
RecyclerPaginate.Builder	setLoadingListItemCreator(LoadingListItemCreator creator) Set custom loading list item creator.
RecyclerPaginate.Builder	setLoadingListItemSpanSizeLookup(LoadingListItemSpanLookup loadingListItemSpanLookup) Set custom SpanSizeLookup for loading list item.
RecyclerPaginate.Builder	setLoadingTriggerThreshold(int threshold) Set the offset from the end of the list at which the load more event needs to be triggered.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecyclerPaginate.Builder

public RecyclerPaginate.Builder(RecyclerView recyclerView,
                        Paginate.Callbacks callbacks)

Method Detail

setLoadingTriggerThreshold

public RecyclerPaginate.Builder setLoadingTriggerThreshold(int threshold)

Set the offset from the end of the list at which the load more event needs to be triggered. Default offset if 5.

Parameters:

threshold - number of items from the end of the list.

Returns:

RecyclerPaginate.Builder

addLoadingListItem

public RecyclerPaginate.Builder addLoadingListItem(boolean addLoadingListItem)

Setup loading row. If loading row is used original adapter set on RecyclerView will be wrapped with internal adapter that will add loading row as the last item in the list. Paginate will observer the changes upon original adapter and remove loading row if there is no more data to load. By default loading row will be added.

Parameters:

addLoadingListItem - true if loading row needs to be added, false otherwise.

Returns:

RecyclerPaginate.Builder

See Also:

com.paginate.Paginate.Callbacks#hasLoadedAllItems()}, com.paginate.recycler.RecyclerPaginate.Builder#setLoadingListItemCreator(LoadingListItemCreator)}

setLoadingListItemCreator

public RecyclerPaginate.Builder setLoadingListItemCreator(LoadingListItemCreator creator)

Set custom loading list item creator. If no creator is set default one will be used.

Parameters:

creator - Creator that will ne called for inflating and binding loading list item.

Returns:

RecyclerPaginate.Builder

setLoadingListItemSpanSizeLookup

public RecyclerPaginate.Builder setLoadingListItemSpanSizeLookup(LoadingListItemSpanLookup loadingListItemSpanLookup)

Set custom SpanSizeLookup for loading list item. Use this when GridLayoutManager is used and loading list item needs to have custom span. Full span of GridLayoutManager is used by default.

Parameters:

loadingListItemSpanLookup - LoadingListItemSpanLookup that will be called for loading list item span.

Returns:

RecyclerPaginate.Builder

build

public Paginate build()

Create pagination functionality upon RecyclerView.

Returns:

Paginate instance.