com.paginate.abslistview

Class AbsListViewPaginate.Builder

java.lang.Object

com.paginate.abslistview.AbsListViewPaginate.Builder

Enclosing class:

AbsListViewPaginate

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

Constructor Summary

Constructors

Constructor and Description
AbsListViewPaginate.Builder(android.widget.AbsListView absListView, Paginate.Callbacks callbacks)

Method Summary

Methods

Modifier and Type	Method and Description
AbsListViewPaginate.Builder	addLoadingListItem(boolean addLoadingListItem) Setup loading row.
Paginate	build() Create pagination functionality upon AbsListView.
AbsListViewPaginate.Builder	setLoadingListItemCreator(LoadingListItemCreator loadingListItemCreator) Set custom loading list item creator.
AbsListViewPaginate.Builder	setLoadingTriggerThreshold(int threshold) Set the offset from the end of the list at which the load more event needs to be triggered.
AbsListViewPaginate.Builder	setOnScrollListener(android.widget.AbsListView.OnScrollListener onScrollListener) Paginate is using OnScrollListener in order to detect when list is scrolled near the end.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbsListViewPaginate.Builder

public AbsListViewPaginate.Builder(android.widget.AbsListView absListView,
                           Paginate.Callbacks callbacks)

Method Detail

setLoadingTriggerThreshold

public AbsListViewPaginate.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:

AbsListViewPaginate.Builder

setOnScrollListener

public AbsListViewPaginate.Builder setOnScrollListener(android.widget.AbsListView.OnScrollListener onScrollListener)

Paginate is using OnScrollListener in order to detect when list is scrolled near the end. That means that internal listener is attached on AbsListView. Since AbsListView can have only one OnScrollListener it is needed to use this method to add additional OnScrollListener (as delegate).

Parameters:

onScrollListener - that will be called when list is scrolled.

Returns:

AbsListViewPaginate.Builder

addLoadingListItem

public AbsListViewPaginate.Builder addLoadingListItem(boolean addLoadingListItem)

Setup loading row. If loading row is used original adapter set on AbsListView 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:

AbsListViewPaginate.Builder

See Also:

com.paginate.Paginate.Callbacks#hasLoadedAllItems()}, com.paginate.abslistview.AbsListViewPaginate.Builder#setLoadingListItemCreator(LoadingListItemCreator)}

setLoadingListItemCreator

public AbsListViewPaginate.Builder setLoadingListItemCreator(LoadingListItemCreator loadingListItemCreator)

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

Parameters:

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

Returns:

AbsListViewPaginate.Builder

build

public Paginate build()

Create pagination functionality upon AbsListView.

Returns:

Paginate instance.