Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

ListFragment

open class ListFragment : Fragment
kotlin.Any
   ↳ androidx.fragment.app.Fragment
   ↳ androidx.fragment.app.ListFragment

Static library support version of the framework's android.app.ListFragment. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Summary

Public constructors

Public methods

open ListAdapter?

Get the ListAdapter associated with this fragment's ListView.

open ListView

Get the fragment's list view widget.

open Long

Get the cursor row ID of the currently selected list item.

open Int

Get the position of the currently selected list item.

open View?
onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?)

Provide default implementation to return a simple list view.

open Unit

Detach from list view.

open Unit
onListItemClick(@NonNull l: ListView, @NonNull v: View, position: Int, id: Long)

This method will be called when an item in the list is selected.

open Unit
onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)

Attach to list view once the view hierarchy has been created.

ListAdapter

Get the ListAdapter associated with this fragment's ListView.

open Unit
setEmptyText(@Nullable text: CharSequence?)

The default content for a ListFragment has a TextView that can be shown when the list is empty.

open Unit
setListAdapter(@Nullable adapter: ListAdapter?)

Provide the cursor for the list view.

open Unit

Control whether the list is being displayed.

open Unit

Like setListShown(boolean), but no animation is used when transitioning from the previous state.

open Unit
setSelection(position: Int)

Set the currently selected list item to the specified position with the adapter's data

Inherited functions

Public constructors

<init>

ListFragment()

Public methods

getListAdapter

@Nullable open fun getListAdapter(): ListAdapter?

Get the ListAdapter associated with this fragment's ListView.

getListView

@NonNull open fun getListView(): ListView

Get the fragment's list view widget.

getSelectedItemId

open fun getSelectedItemId(): Long

Get the cursor row ID of the currently selected list item.

getSelectedItemPosition

open fun getSelectedItemPosition(): Int

Get the position of the currently selected list item.

onCreateView

@Nullable open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?): View?

Provide default implementation to return a simple list view. Subclasses can override to replace with their own layout. If doing so, the returned view hierarchy must have a ListView whose id is android.R.id.list and can optionally have a sibling view id android.R.id.empty that is to be shown when the list is empty.

If you are overriding this method with your own custom content, consider including the standard layout android.R.layout#list_content in your layout file, so that you continue to retain all of the standard behavior of ListFragment. In particular, this is currently the only way to have the built-in indeterminant progress state be shown.

Parameters
inflater LayoutInflater: The LayoutInflater object that can be used to inflate any views in the fragment,
container LayoutInflater: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState LayoutInflater: If non-null, this fragment is being re-constructed from a previous saved state as given here.
Return
View?: Return the View for the fragment's UI, or null.

onDestroyView

open fun onDestroyView(): Unit

Detach from list view.

onListItemClick

open fun onListItemClick(@NonNull l: ListView, @NonNull v: View, position: Int, id: Long): Unit

This method will be called when an item in the list is selected. Subclasses should override. Subclasses can call getListView().getItemAtPosition(position) if they need to access the data associated with the selected item.

Parameters
l ListView: The ListView where the click happened
v ListView: The view that was clicked within the ListView
position ListView: The position of the view in the list
id ListView: The row id of the item that was clicked

onViewCreated

open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?): Unit

Attach to list view once the view hierarchy has been created.

Parameters
view View: The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle).
savedInstanceState View: If non-null, this fragment is being re-constructed from a previous saved state as given here.

requireListAdapter

@NonNull fun requireListAdapter(): ListAdapter

Get the ListAdapter associated with this fragment's ListView.

Exceptions
IllegalStateException if no ListAdapter has been set.

setEmptyText

open fun setEmptyText(@Nullable text: CharSequence?): Unit

The default content for a ListFragment has a TextView that can be shown when the list is empty. If you would like to have it shown, call this method to supply the text it should use.

setListAdapter

open fun setListAdapter(@Nullable adapter: ListAdapter?): Unit

Provide the cursor for the list view.

setListShown

open fun setListShown(shown: Boolean): Unit

Control whether the list is being displayed. You can make it not displayed if you are waiting for the initial data to show in it. During this time an indeterminant progress indicator will be shown instead.

Applications do not normally need to use this themselves. The default behavior of ListFragment is to start with the list not being shown, only showing it once an adapter is given with setListAdapter(ListAdapter). If the list at that point had not been shown, when it does get shown it will be do without the user ever seeing the hidden state.

Parameters
shown Boolean: If true, the list view is shown; if false, the progress indicator. The initial value is true.

setListShownNoAnimation

open fun setListShownNoAnimation(shown: Boolean): Unit

Like setListShown(boolean), but no animation is used when transitioning from the previous state.

setSelection

open fun setSelection(position: Int): Unit

Set the currently selected list item to the specified position with the adapter's data

Parameters
position Int: