com.mikepenz.fastadapter_extensions.scroll

Class EndlessScrollHelper<Model>

java.lang.Object

android.support.v7.widget.RecyclerView.OnScrollListener

com.mikepenz.fastadapter_extensions.scroll.EndlessRecyclerOnScrollListener

com.mikepenz.fastadapter_extensions.scroll.EndlessScrollHelper<Model>

public class EndlessScrollHelper<Model>
extends EndlessRecyclerOnScrollListener

This is an extension of EndlessRecyclerOnScrollListener, providing a more powerful API for endless scrolling. This class exposes 2 callbacks to separate the loading logic from delivering the results:

• OnLoadMoreHandler
• OnNewItemsListener

This class also takes care of other various stuffs like:

• Ensuring the results are delivered on the RecyclerView's handler – which also ensures that the results are delivered only when the RecyclerView is attached to the window, see View.post(Runnable).
• Prevention of memory leaks when implemented properly (i.e. OnLoadMoreHandler should be implemented via static classes or lambda expressions).
• An easier way to deliver results to an IItemAdapter or ModelAdapter.

Created by jayson on 3/26/2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndlessScrollHelper.OnLoadMoreHandler<Model>
static interface	EndlessScrollHelper.OnNewItemsListener<Model>
static interface	EndlessScrollHelper.ResultReceiver<Model> A callback interface provided by the EndlessScrollHelper where onLoadMore() results are to be delivered.

Constructor Summary

Constructors

Constructor and Description
EndlessScrollHelper()
EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager)
EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager, int visibleThreshold)
EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager, int visibleThreshold, com.mikepenz.fastadapter.adapters.ItemAdapter footerAdapter)

Method Summary

Modifier and Type	Method and Description
EndlessScrollHelper<Model>	addTo(android.support.v7.widget.RecyclerView recyclerView)
protected void	onLoadMore(EndlessScrollHelper.ResultReceiver<Model> out, int currentPage) The default implementation takes care of calling the previously set OnLoadMoreHandler.
void	onLoadMore(int currentPage)
protected void	onNewItems(java.util.List<Model> newItems, int page) The default implementation takes care of calling the previously set OnNewItemsListener.
<Item extends com.mikepenz.fastadapter.IItem> EndlessScrollHelper<Model>	withNewItemsDeliveredTo(com.mikepenz.fastadapter.IItemAdapter<?,Item> itemAdapter, com.mikepenz.fastadapter.IInterceptor<Model,Item> itemFactory) Registers an OnNewItemsListener that delivers results to the specified IItemAdapter.
<Item extends com.mikepenz.fastadapter.IItem> EndlessScrollHelper<Model>	withNewItemsDeliveredTo(com.mikepenz.fastadapter.IItemAdapter<?,Item> itemAdapter, com.mikepenz.fastadapter.IInterceptor<Model,Item> itemFactory, EndlessScrollHelper.OnNewItemsListener<Model> extraOnNewItemsListener) An overload of withNewItemsDeliveredTo() that allows additional callbacks.
EndlessScrollHelper<Model>	withNewItemsDeliveredTo(com.mikepenz.fastadapter.adapters.ModelAdapter<Model,?> modelItemAdapter) Registers an OnNewItemsListener that delivers results to the specified ModelAdapter through its ModelAdapter.add(Model...) method.
EndlessScrollHelper<Model>	withNewItemsDeliveredTo(com.mikepenz.fastadapter.adapters.ModelAdapter<Model,?> modelItemAdapter, EndlessScrollHelper.OnNewItemsListener<Model> extraOnNewItemsListener) An overload of withNewItemsDeliveredTo() that allows additional callbacks.
EndlessScrollHelper<Model>	withOnLoadMoreHandler(EndlessScrollHelper.OnLoadMoreHandler<Model> onLoadMoreHandler) Define the OnLoadMoreHandler which will be used for loading new items.
EndlessScrollHelper<Model>	withOnNewItemsListener(EndlessScrollHelper.OnNewItemsListener<Model> onNewItemsListener) Define the OnNewItemsListener which will receive the new items loaded by onLoadMore().

Methods inherited from class com.mikepenz.fastadapter_extensions.scroll.EndlessRecyclerOnScrollListener

disable, enable, getCurrentPage, getFirstVisibleItem, getLayoutManager, getTotalItemCount, getVisibleItemCount, onScrolled, resetPageCount, resetPageCount

Methods inherited from class android.support.v7.widget.RecyclerView.OnScrollListener

onScrollStateChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

EndlessScrollHelper

public EndlessScrollHelper()

EndlessScrollHelper

public EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager)

EndlessScrollHelper

public EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager,
                           int visibleThreshold)

EndlessScrollHelper

public EndlessScrollHelper(android.support.v7.widget.RecyclerView.LayoutManager layoutManager,
                           int visibleThreshold,
                           com.mikepenz.fastadapter.adapters.ItemAdapter footerAdapter)

Parameters:

layoutManager -

visibleThreshold -

footerAdapter - the itemAdapter used to host Footer items

Method Detail

addTo

public EndlessScrollHelper<Model> addTo(android.support.v7.widget.RecyclerView recyclerView)

withOnLoadMoreHandler

public EndlessScrollHelper<Model> withOnLoadMoreHandler(@NonNull
                                                        EndlessScrollHelper.OnLoadMoreHandler<Model> onLoadMoreHandler)

Define the OnLoadMoreHandler which will be used for loading new items.

Parameters:

onLoadMoreHandler -

Returns:

withOnNewItemsListener

public EndlessScrollHelper<Model> withOnNewItemsListener(@NonNull
                                                         EndlessScrollHelper.OnNewItemsListener<Model> onNewItemsListener)

Define the OnNewItemsListener which will receive the new items loaded by onLoadMore().

Parameters:

onNewItemsListener -

Returns:

See Also:

withNewItemsDeliveredTo(IItemAdapter, IInterceptor), withNewItemsDeliveredTo(ModelAdapter)

withNewItemsDeliveredTo

public <Item extends com.mikepenz.fastadapter.IItem> EndlessScrollHelper<Model> withNewItemsDeliveredTo(@NonNull
                                                                                                        com.mikepenz.fastadapter.IItemAdapter<?,Item> itemAdapter,
                                                                                                        @NonNull
                                                                                                        com.mikepenz.fastadapter.IInterceptor<Model,Item> itemFactory)

Registers an OnNewItemsListener that delivers results to the specified IItemAdapter. Converting each result to an IItem using the given itemFactory.

Type Parameters:

Item -

Parameters:

itemAdapter -

itemFactory -

Returns:

See Also:

withNewItemsDeliveredTo(IItemAdapter, IInterceptor, OnNewItemsListener)

withNewItemsDeliveredTo

public EndlessScrollHelper<Model> withNewItemsDeliveredTo(@NonNull
                                                          com.mikepenz.fastadapter.adapters.ModelAdapter<Model,?> modelItemAdapter)

Registers an OnNewItemsListener that delivers results to the specified ModelAdapter through its ModelAdapter.add(Model...) method.

Parameters:

modelItemAdapter -

Returns:

See Also:

withNewItemsDeliveredTo(ModelAdapter, OnNewItemsListener)

withNewItemsDeliveredTo

public <Item extends com.mikepenz.fastadapter.IItem> EndlessScrollHelper<Model> withNewItemsDeliveredTo(@NonNull
                                                                                                        com.mikepenz.fastadapter.IItemAdapter<?,Item> itemAdapter,
                                                                                                        @NonNull
                                                                                                        com.mikepenz.fastadapter.IInterceptor<Model,Item> itemFactory,
                                                                                                        @NonNull
                                                                                                        EndlessScrollHelper.OnNewItemsListener<Model> extraOnNewItemsListener)

An overload of withNewItemsDeliveredTo() that allows additional callbacks.

Type Parameters:

Item -

Parameters:

itemAdapter -

itemFactory -

extraOnNewItemsListener -

Returns:

withNewItemsDeliveredTo

public EndlessScrollHelper<Model> withNewItemsDeliveredTo(@NonNull
                                                          com.mikepenz.fastadapter.adapters.ModelAdapter<Model,?> modelItemAdapter,
                                                          @NonNull
                                                          EndlessScrollHelper.OnNewItemsListener<Model> extraOnNewItemsListener)

An overload of withNewItemsDeliveredTo() that allows additional callbacks.

Parameters:

modelItemAdapter -

extraOnNewItemsListener -

Returns:

onLoadMore

protected void onLoadMore(@NonNull
                          EndlessScrollHelper.ResultReceiver<Model> out,
                          int currentPage)

The default implementation takes care of calling the previously set OnLoadMoreHandler.

Parameters:

out -

currentPage -

See Also:

withOnLoadMoreHandler(OnLoadMoreHandler)

onNewItems

protected void onNewItems(@NonNull
                          java.util.List<Model> newItems,
                          int page)

The default implementation takes care of calling the previously set OnNewItemsListener.

Parameters:

newItems -

page -

See Also:

withOnNewItemsListener(OnNewItemsListener)

onLoadMore

public void onLoadMore(int currentPage)

Specified by:

onLoadMore in class EndlessRecyclerOnScrollListener