| <html devsite="true"> |
| <head> |
| <title>PagedListAdapter</title> |
| {% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <h1>PagedListAdapter</h1> |
| {% setvar page_path %}androidx/paging/PagedListAdapter.html{% endsetvar %} |
| {% setvar can_switch %}1{% endsetvar %} |
| {% include "reference/_java_switcher2.md" %} |
| <p> |
| <pre>public abstract class PagedListAdapter<T extends <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>, VH extends @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>></pre> |
| </p> |
| <hr> |
| <aside class="caution"><strong>This class is deprecated.</strong><br>PagedListAdapter is deprecated and has been replaced by PagingDataAdapter</aside> |
| <p><a href="[RecyclerView.Adapter]">RecyclerView.Adapter</a> base class for presenting paged data from <code><a href="/reference/androidx/paging/PagedList.html">androidx.paging.PagedList</a></code>s in a <a href="[RecyclerView]">RecyclerView</a>.</p> |
| <p>This class is a convenience wrapper around <code><a href="/reference/androidx/paging/AsyncPagedListDiffer.html">AsyncPagedListDiffer</a></code> that implements common default behavior for item counting, and listening to PagedList update callbacks.</p> |
| <p>While using a LiveData<PagedList> is an easy way to provide data to the adapter, it isn't required - you can use <code><a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList)">submitList</a></code> when new lists are available.</p> |
| <p>PagedListAdapter listens to PagedList loading callbacks as pages are loaded, and uses DiffUtil on a background thread to compute fine grained updates as new PagedLists are received.</p> |
| <p>Handles both the internal paging of the list as more data is loaded, and updates in the form of new PagedLists.</p> |
| <p>A complete usage pattern with Room would look like this:</p> |
| <pre class="prettyprint">@Dao<br>interface UserDao {<br> @Query("SELECT * FROM user ORDER BY lastName ASC")<br> public abstract DataSource.Factory<Integer, User> usersByLastName();<br>}<br><br>class MyViewModel extends ViewModel {<br> public final LiveData<PagedList<User>> usersList;<br> public MyViewModel(UserDao userDao) {<br> usersList = new LivePagedListBuilder&lt;>(<br> userDao.usersByLastName(), /* page size */20).build();<br> }<br>}<br><br>class MyActivity extends AppCompatActivity {<br> @Override<br> public void onCreate(Bundle savedState) {<br> super.onCreate(savedState);<br> MyViewModel viewModel = new ViewModelProvider(this).get(MyViewModel.class);<br> RecyclerView recyclerView = findViewById(R.id.user_list);<br> UserAdapter&lt;User> adapter = new UserAdapter();<br> viewModel.usersList.observe(this, pagedList -> adapter.submitList(pagedList));<br> recyclerView.setAdapter(adapter);<br> }<br>}<br><br>class UserAdapter extends PagedListAdapter<User, UserViewHolder> {<br> public UserAdapter() {<br> super(DIFF_CALLBACK);<br> }<br> @Override<br> public void onBindViewHolder(UserViewHolder holder, int position) {<br> User user = getItem(position);<br> if (user != null) {<br> holder.bindTo(user);<br> } else {<br> // Null defines a placeholder item - PagedListAdapter will automatically invalidate<br> // this row when the actual object is loaded from the database<br> holder.clear();<br> }<br> }<br> public static final DiffUtil.ItemCallback&lt;User> DIFF_CALLBACK =<br> new DiffUtil.ItemCallback<User>() {<br> @Override<br> public boolean areItemsTheSame(@NonNull User oldUser, @NonNull User newUser) {<br> // User properties may have changed if reloaded from the DB, but ID is fixed<br> return oldUser.getId() == newUser.getId();<br> }<br> @Override<br> public boolean areContentsTheSame(@NonNull User oldUser, @NonNull User newUser) {<br> // NOTE: if you use equals, your object must properly override Object#equals()<br> // Incorrectly returning false here will result in too many animations.<br> return oldUser.equals(newUser);<br> }<br> }<br>}</pre> |
| <p>Advanced users that wish for more control over adapter behavior, or to provide a specific base class should refer to <code><a href="/reference/androidx/paging/AsyncPagedListDiffer.html">AsyncPagedListDiffer</a></code>, which provides the mapping from paging events to adapter-friendly callbacks.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><T extends <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>></code></td> |
| <td width="100%"> |
| <p>Type of the PagedLists this Adapter will receive.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code><VH extends @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>></code></td> |
| <td width="100%"> |
| <p>A class that extends ViewHolder that will be used by the adapter.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <h2>Summary</h2> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2"><h3>Public fields</h3></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#currentList()">currentList</a></code></div> |
| <p>Returns the <code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code> currently being displayed by the <code><a href="/reference/androidx/paging/PagedListAdapter.html">PagedListAdapter</a></code>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2"><h3>Public methods</h3></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#addLoadStateListener(kotlin.Function2)">addLoadStateListener</a>(Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener)</code></div> |
| <p>Add a <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> listener to observe the loading state of the current <code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>int</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#getItemCount()">getItemCount</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><span><del><a href="/reference/androidx/paging/PagedListAdapter.html#onCurrentListChanged(androidx.paging.PagedList)">onCurrentListChanged</a></del></span>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList)</code></div> |
| <p><strong>This method is deprecated.</strong> Use the two argument variant instead.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#onCurrentListChanged(androidx.paging.PagedList,androidx.paging.PagedList)">onCurrentListChanged</a>(<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> previousList,<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList<br>)</code></div> |
| <p>Called when the current PagedList is updated.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#removeLoadStateListener(kotlin.Function2)">removeLoadStateListener</a>(Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener)</code></div> |
| <p>Remove a previously registered <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> listener.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList)">submitList</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList)</code></div> |
| <p>Set the new list to be displayed.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>void</code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList,java.lang.Runnable)">submitList</a>(<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList,<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Runnable.html">Runnable</a> commitCallback<br>)</code></div> |
| <p>Set the new list to be displayed.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateFooter(androidx.paging.LoadStateAdapter)">withLoadStateFooter</a>(<a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> footer)</code></div> |
| <p>Create a ConcatAdapter with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadState.html">LoadType.PREPEND</a></code> as a list item at the start of the presented list.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateHeader(androidx.paging.LoadStateAdapter)">withLoadStateHeader</a>(<a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> header)</code></div> |
| <p>Create a ConcatAdapter with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadState.html">LoadType.APPEND</a></code> as a list item at the end of the presented list.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateHeaderAndFooter(androidx.paging.LoadStateAdapter,androidx.paging.LoadStateAdapter)">withLoadStateHeaderAndFooter</a>(<br> <a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> header,<br> <a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> footer<br>)</code></div> |
| <p>Create a ConcatAdapter with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadType.PREPEND.html">LoadType.PREPEND</a></code> and <code><a href="/reference/androidx/paging/LoadState.html">LoadType.APPEND</a></code>s as list items at the start and end respectively.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <h2>Public fields</h2> |
| <div><a name="getCurrentList()"></a><a name="setCurrentList()"></a><a name="getCurrentList--"></a><a name="setCurrentList--"></a> |
| <h3 class="api-name" id="currentList()">currentList</h3> |
| <pre class="api-signature no-pretty-print">@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a><br>public @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> <a href="/reference/androidx/paging/PagedListAdapter.html#currentList()">currentList</a></pre> |
| <p>Returns the <code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code> currently being displayed by the <code><a href="/reference/androidx/paging/PagedListAdapter.html">PagedListAdapter</a></code>.</p> |
| <p>This is not necessarily the most recent list passed to <code><a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList)">submitList</a></code>, because a diff is computed asynchronously between the new list and the current list before updating the currentList value. May be null if no PagedList is being presented.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Returns</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T></code></td> |
| <td width="100%"> |
| <p>The list currently being displayed.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">See also</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><a href="/reference/androidx/paging/PagedListAdapter.html#onCurrentListChanged(androidx.paging.PagedList)">onCurrentListChanged</a></code></td> |
| <td width="100%"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <h2>Public methods</h2> |
| <div><a name="addLoadStateListener-kotlin.Function2-"></a> |
| <h3 class="api-name" id="addLoadStateListener(kotlin.Function2)">addLoadStateListener</h3> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/paging/PagedListAdapter.html#addLoadStateListener(kotlin.Function2)">addLoadStateListener</a>(Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener)</pre> |
| <p>Add a <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> listener to observe the loading state of the current <code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code>.</p> |
| <p>As new PagedLists are submitted and displayed, the listener will be notified to reflect current <code><a href="/reference/androidx/paging/LoadType.REFRESH.html">LoadType.REFRESH</a></code>, <code><a href="/reference/androidx/paging/LoadType.PREPEND.html">LoadType.PREPEND</a></code>, and <code><a href="/reference/androidx/paging/LoadType.APPEND.html">LoadType.APPEND</a></code> states.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener</code></td> |
| <td width="100%"> |
| <p>Listener to receive <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> updates.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">See also</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><a href="/reference/androidx/paging/PagedListAdapter.html#removeLoadStateListener(kotlin.Function2)">removeLoadStateListener</a></code></td> |
| <td width="100%"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="getItemCount--"></a> |
| <h3 class="api-name" id="getItemCount()">getItemCount</h3> |
| <pre class="api-signature no-pretty-print">public int <a href="/reference/androidx/paging/PagedListAdapter.html#getItemCount()">getItemCount</a>()</pre> |
| </div> |
| <div><a name="onCurrentListChanged-androidx.paging.PagedList-"></a> |
| <h3 class="api-name" id="onCurrentListChanged(androidx.paging.PagedList)">onCurrentListChanged</h3> |
| <pre class="api-signature no-pretty-print">public void <span><del><a href="/reference/androidx/paging/PagedListAdapter.html#onCurrentListChanged(androidx.paging.PagedList)">onCurrentListChanged</a></del></span>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList)</pre> |
| <aside class="caution"><strong>This method is deprecated.</strong><br>Use the two argument variant instead.</aside> |
| <p>Called when the current PagedList is updated.</p> |
| <p>This may be dispatched as part of <a href="[.submitList]">.submitList</a> if a background diff isn't needed (such as when the first list is passed, or the list is cleared). In either case, PagedListAdapter will simply call <a href="[.notifyItemRangeInserted]">.notifyItemRangeInserted</a>.</p> |
| <p>This method will <em>not</em>be called when the Adapter switches from presenting a PagedList to a snapshot version of the PagedList during a diff. This means you cannot observe each PagedList via this method.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList</code></td> |
| <td width="100%"> |
| <p>new PagedList being displayed, may be null.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">See also</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><a href="/reference/androidx/paging/PagedListAdapter.html#currentList()">currentList</a></code></td> |
| <td width="100%"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="onCurrentListChanged(androidx.paging.PagedList, androidx.paging.PagedList)"></a><a name="onCurrentListChanged-androidx.paging.PagedList-androidx.paging.PagedList-"></a> |
| <h3 class="api-name" id="onCurrentListChanged(androidx.paging.PagedList,androidx.paging.PagedList)">onCurrentListChanged</h3> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/paging/PagedListAdapter.html#onCurrentListChanged(androidx.paging.PagedList,androidx.paging.PagedList)">onCurrentListChanged</a>(<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> previousList,<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList<br>)</pre> |
| <p>Called when the current PagedList is updated.</p> |
| <p>This may be dispatched as part of <a href="[.submitList]">.submitList</a> if a background diff isn't needed (such as when the first list is passed, or the list is cleared). In either case, PagedListAdapter will simply call <a href="[notifyItemRangeInserted]">notifyItemRangeInserted</a>.</p> |
| <p>This method will <em>not</em>be called when the Adapter switches from presenting a PagedList to a snapshot version of the PagedList during a diff. This means you cannot observe each PagedList via this method.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> previousList</code></td> |
| <td width="100%"> |
| <p><code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code> that was previously displayed, may be null.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> currentList</code></td> |
| <td width="100%"> |
| <p>new <code><a href="/reference/androidx/paging/PagedList.html">PagedList</a></code> being displayed, may be null.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">See also</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><a href="/reference/androidx/paging/PagedListAdapter.html#currentList()">currentList</a></code></td> |
| <td width="100%"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="removeLoadStateListener-kotlin.Function2-"></a> |
| <h3 class="api-name" id="removeLoadStateListener(kotlin.Function2)">removeLoadStateListener</h3> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/paging/PagedListAdapter.html#removeLoadStateListener(kotlin.Function2)">removeLoadStateListener</a>(Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener)</pre> |
| <p>Remove a previously registered <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> listener.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>Function2<<a href="/reference/androidx/paging/LoadType.html">LoadType</a>, <a href="/reference/androidx/paging/LoadState.html">LoadState</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> listener</code></td> |
| <td width="100%"> |
| <p>Previously registered listener.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">See also</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code><a href="/reference/androidx/paging/PagedListAdapter.html#addLoadStateListener(kotlin.Function2)">addLoadStateListener</a></code></td> |
| <td width="100%"></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="submitList-androidx.paging.PagedList-"></a> |
| <h3 class="api-name" id="submitList(androidx.paging.PagedList)">submitList</h3> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList)">submitList</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList)</pre> |
| <p>Set the new list to be displayed.</p> |
| <p>If a list is already being displayed, a diff will be computed on a background thread, which will dispatch Adapter.notifyItem events on the main thread.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList</code></td> |
| <td width="100%"> |
| <p>The new list to be displayed.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="submitList(androidx.paging.PagedList, java.lang.Runnable)"></a><a name="submitList-androidx.paging.PagedList-java.lang.Runnable-"></a> |
| <h3 class="api-name" id="submitList(androidx.paging.PagedList,java.lang.Runnable)">submitList</h3> |
| <pre class="api-signature no-pretty-print">public void <a href="/reference/androidx/paging/PagedListAdapter.html#submitList(androidx.paging.PagedList,java.lang.Runnable)">submitList</a>(<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList,<br> @<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Runnable.html">Runnable</a> commitCallback<br>)</pre> |
| <p>Set the new list to be displayed.</p> |
| <p>If a list is already being displayed, a diff will be computed on a background thread, which will dispatch Adapter.notifyItem events on the main thread.</p> |
| <p>The commit callback can be used to know when the PagedList is committed, but note that it may not be executed. If PagedList B is submitted immediately after PagedList A, and is committed directly, the callback associated with PagedList A will not be run.</p> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <thead> |
| <tr> |
| <th colspan="2">Parameters</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="/reference/androidx/paging/PagedList.html">PagedList</a><T> pagedList</code></td> |
| <td width="100%"> |
| <p>The new list to be displayed.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/Runnable.html">Runnable</a> commitCallback</code></td> |
| <td width="100%"> |
| <p>Optional runnable that is executed when the PagedList is committed, if it is committed.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div><a name="withLoadStateFooter-androidx.paging.LoadStateAdapter-"></a> |
| <h3 class="api-name" id="withLoadStateFooter(androidx.paging.LoadStateAdapter)">withLoadStateFooter</h3> |
| <pre class="api-signature no-pretty-print">public final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a> <a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateFooter(androidx.paging.LoadStateAdapter)">withLoadStateFooter</a>(<a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> footer)</pre> |
| <p>Create a <a href="[ConcatAdapter]">ConcatAdapter</a> with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadState.html">LoadType.PREPEND</a></code> as a list item at the start of the presented list.</p> |
| </div> |
| <div><a name="withLoadStateHeader-androidx.paging.LoadStateAdapter-"></a> |
| <h3 class="api-name" id="withLoadStateHeader(androidx.paging.LoadStateAdapter)">withLoadStateHeader</h3> |
| <pre class="api-signature no-pretty-print">public final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a> <a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateHeader(androidx.paging.LoadStateAdapter)">withLoadStateHeader</a>(<a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> header)</pre> |
| <p>Create a <a href="[ConcatAdapter]">ConcatAdapter</a> with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadState.html">LoadType.APPEND</a></code> as a list item at the end of the presented list.</p> |
| </div> |
| <div><a name="withLoadStateHeaderAndFooter(androidx.paging.LoadStateAdapter, androidx.paging.LoadStateAdapter)"></a><a name="withLoadStateHeaderAndFooter-androidx.paging.LoadStateAdapter-androidx.paging.LoadStateAdapter-"></a> |
| <h3 class="api-name" id="withLoadStateHeaderAndFooter(androidx.paging.LoadStateAdapter,androidx.paging.LoadStateAdapter)">withLoadStateHeaderAndFooter</h3> |
| <pre class="api-signature no-pretty-print">public final <a href="/reference/[JVM root]/<ERROR CLASS>.html"><ERROR CLASS></a> <a href="/reference/androidx/paging/PagedListAdapter.html#withLoadStateHeaderAndFooter(androidx.paging.LoadStateAdapter,androidx.paging.LoadStateAdapter)">withLoadStateHeaderAndFooter</a>(<br> <a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> header,<br> <a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a><?> footer<br>)</pre> |
| <p>Create a <a href="[ConcatAdapter]">ConcatAdapter</a> with the provided <code><a href="/reference/androidx/paging/LoadStateAdapter.html">LoadStateAdapter</a></code>s displaying the <code><a href="/reference/androidx/paging/LoadType.PREPEND.html">LoadType.PREPEND</a></code> and <code><a href="/reference/androidx/paging/LoadState.html">LoadType.APPEND</a></code>s as list items at the start and end respectively.</p> |
| </div> |
| </body> |
| </html> |
