Added in API level 11
Deprecated in API level 28

ListFragment

Kotlin |Java

open class ListFragment : Fragment

kotlin.Any
↳	android.app.Fragment
	↳	android.app.ListFragment

A fragment that displays a list of items by binding to a data source such as an array or Cursor, and exposes event handlers when the user selects an item.

ListFragment hosts a ListView object that can be bound to different data sources, typically either an array or a Cursor holding query results. Binding, screen layout, and row layout are discussed in the following sections.

Screen Layout

ListFragment has a default layout that consists of a single list view. However, if you desire, you can customize the fragment layout by returning your own view hierarchy from onCreateView. To do this, your view hierarchy must contain a ListView object with the id "@android:id/list" (or android.R.id#list if it's in code)

Optionally, your view hierarchy can contain another view object of any type to display when the list view is empty. This "empty list" notifier must have an id "android:empty". Note that when an empty view is present, the list view will be hidden when there is no data to display.

The following code demonstrates an (ugly) custom list layout. It has a list with a green background, and an alternate red "no data" message.

<?xml version="1.0" encoding="utf-8"?>
  <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
          android:orientation="vertical"
          android:layout_width="match_parent"
          android:layout_height="match_parent"
          android:paddingLeft="8dp"
          android:paddingRight="8dp">
 
      <ListView android:id="@id/android:list"
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                android:background="#00FF00"
                android:layout_weight="1"
                android:drawSelectorOnTop="false"/>
 
      <TextView android:id="@id/android:empty"
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                android:background="#FF0000"
                android:text="No data"/>
  </LinearLayout>

Row Layout

You can specify the layout of individual rows in the list. You do this by specifying a layout resource in the ListAdapter object hosted by the fragment (the ListAdapter binds the ListView to the data; more on this later).

A ListAdapter constructor takes a parameter that specifies a layout resource for each row. It also has two additional parameters that let you specify which data field to associate with which object in the row layout resource. These two parameters are typically parallel arrays.

Android provides some standard row layout resources. These are in the android.R.layout class, and have names such as simple_list_item_1, simple_list_item_2, and two_line_list_item. The following layout XML is the source for the resource two_line_list_item, which displays two data fields,one above the other, for each list row.

<?xml version="1.0" encoding="utf-8"?>
  <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:orientation="vertical">
 
      <TextView android:id="@+id/text1"
          android:textSize="16sp"
          android:textStyle="bold"
          android:layout_width="match_parent"
          android:layout_height="wrap_content"/>
 
      <TextView android:id="@+id/text2"
          android:textSize="16sp"
          android:layout_width="match_parent"
          android:layout_height="wrap_content"/>
  </LinearLayout>

You must identify the data bound to each TextView object in this layout. The syntax for this is discussed in the next section.

Binding to Data

You bind the ListFragment's ListView object to data using a class that implements the ListAdapter interface. Android provides two standard list adapters: SimpleAdapter for static data (Maps), and SimpleCursorAdapter for Cursor query results.

You must use ListFragment.setListAdapter() to associate the list with an adapter. Do not directly call ListView.setAdapter() or else important initialization will be skipped.

Summary

Inherited constants

From class ComponentCallbacks2

`Int`	`TRIM_MEMORY_BACKGROUND` Level for `onTrimMemory(int)`: the process has gone on to the LRU list. This is a good opportunity to clean up resources that can efficiently and quickly be re-built if the user returns to the app.
`Int`	`TRIM_MEMORY_COMPLETE` Level for `onTrimMemory(int)`: the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
`Int`	`TRIM_MEMORY_MODERATE` Level for `onTrimMemory(int)`: the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
`Int`	`TRIM_MEMORY_RUNNING_CRITICAL` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running. Your running process should free up as many non-critical resources as it can to allow that memory to be used elsewhere. The next thing that will happen after this is `onLowMemory()` called to report that nothing at all can be kept in the background, a situation that can start to notably impact the user.
`Int`	`TRIM_MEMORY_RUNNING_LOW` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running low on memory. Your running process should free up unneeded resources to allow that memory to be used elsewhere.
`Int`	`TRIM_MEMORY_RUNNING_MODERATE` Level for `onTrimMemory(int)`: the process is not an expendable background process, but the device is running moderately low on memory. Your running process may want to release some unneeded resources for use elsewhere.
`Int`	`TRIM_MEMORY_UI_HIDDEN` Level for `onTrimMemory(int)`: the process had been showing a user interface, and is no longer doing so. Large allocations with the UI should be released at this point to allow memory to be better managed.

Public constructors
`ListFragment()`

Public methods
open ListAdapter!	`getListAdapter()` Get the ListAdapter associated with this fragment's ListView.
open ListView!	`getListView()` Get the fragment's list view widget.
open Long	`getSelectedItemId()` Get the cursor row ID of the currently selected list item.
open Int	`getSelectedItemPosition()` Get the position of the currently selected list item.
open View?	`onCreateView(inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle!)` Provide default implementation to return a simple list view.
open Unit	`onDestroyView()` Detach from list view.
open Unit	`onListItemClick(l: ListView!, v: View!, position: Int, id: Long)` This method will be called when an item in the list is selected.
open Unit	`onViewCreated(view: View!, savedInstanceState: Bundle?)` Attach to list view once the view hierarchy has been created.
open Unit	`setEmptyText(text: CharSequence!)` The default content for a ListFragment has a TextView that can be shown when the list is empty.
open Unit	`setListAdapter(adapter: ListAdapter!)` Provide the cursor for the list view.
open Unit	`setListShown(shown: Boolean)` Control whether the list is being displayed.
open Unit	`setListShownNoAnimation(shown: Boolean)` 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

From class Fragment

`Unit`	`dump(prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)` Print the Fragments's state into the given stream.
`Boolean`	`equals(other: Any?)` Subclasses can not override equals().
`Activity!`	`getActivity()` Return the Activity this fragment is currently associated with.
`Boolean`	`getAllowEnterTransitionOverlap()` Returns whether the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Boolean`	`getAllowReturnTransitionOverlap()` Returns whether the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Bundle!`	`getArguments()` Return the arguments supplied to `setArguments`, if any.
`FragmentManager!`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context!`	`getContext()` Return the `Context` this fragment is currently associated with.
`Transition!`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View.INVISIBLE` to `View.VISIBLE`.
`Transition!`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If transition is null, the views will remain unaffected.
`FragmentManager!`	`getFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity. Note that this will be non-null slightly before `getActivity()`, during the time from when the fragment is placed in a `FragmentTransaction` until it is committed and attached to its activity. If this Fragment is a child of another Fragment, the FragmentManager returned here will be the parent's `getChildFragmentManager()`.
`Any?`	`getHost()` Return the host object of this fragment. May return `null` if the fragment isn't currently being hosted.
`Int`	`getId()` Return the identifier this fragment is known by. This is either the android:id value supplied in a layout or the container view ID supplied when adding the fragment.
`LayoutInflater!`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment. If `onGetLayoutInflater(android.os.Bundle)` has not been called `onGetLayoutInflater(android.os.Bundle)` will be called with a `null` argument and that value will be cached. The cached LayoutInflater will be replaced immediately prior to `onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)` and cleared immediately after `onDetach()`.
`LoaderManager!`	`getLoaderManager()` Return the LoaderManager for this fragment, creating it if needed.
`Fragment!`	`getParentFragment()` Returns the parent Fragment containing this Fragment. If this Fragment is attached directly to an Activity, returns null.
`Transition!`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as `setExitTransition(android.transition.Transition)`.
`Resources!`	`getResources()` Return `getActivity().getResources()`.
`Boolean`	`getRetainInstance()`
`Transition!`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If `transition` is null, entering Views will remain unaffected.
`Transition!`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.
`Transition!`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(android.transition.Transition)`.
`String!`	`getString(resId: Int)` Return a localized string from the application's package's default string table.
`String!`	`getString(resId: Int, vararg formatArgs: Any!)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and java.lang.String#format.
`String!`	`getTag()` Get the tag name of the fragment, if specified.
`Fragment!`	`getTargetFragment()` Return the target fragment set by `setTargetFragment`.
`Int`	`getTargetRequestCode()` Return the target request code set by `setTargetFragment`.
`CharSequence!`	`getText(resId: Int)` Return a localized, styled CharSequence from the application's package's default string table.
`Boolean`	`getUserVisibleHint()`
`View?`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`Int`	`hashCode()` Subclasses can not override hashCode().
`Fragment!`	`instantiate(context: Context!, fname: String!)` Like `instantiate(android.content.Context,java.lang.String,android.os.Bundle)` but with a null argument Bundle.
`Fragment!`	`instantiate(context: Context!, fname: String!, args: Bundle?)` Create a new instance of a Fragment with the given class name. This is the same as calling its empty constructor.
`Boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`Boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI. That is, `FragmentTransaction.detach(Fragment)` has been used on it.
`Boolean`	`isHidden()` Return true if the fragment has been hidden. By default fragments are shown. You can find out about changes to this state with `onHiddenChanged`. Note that the hidden state is orthogonal to other states -- that is, to be visible to the user, a fragment must be both started and not hidden.
`Boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. This will always be true when fragments are created through the <fragment> tag, except in the case where an old fragment is restored from a previous state and it does not appear in the layout of the current state.
`Boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity. This is not whether its activity is finishing, but rather whether it is in the process of being removed from its activity.
`Boolean`	`isResumed()` Return true if the fragment is in the resumed state. This is true for the duration of `onResume()` and `onPause()` as well.
`Boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host. Any operations that would change saved state should not be performed if this method returns true, and some operations such as `setArguments(android.os.Bundle)` will fail.
`Boolean`	`isVisible()` Return true if the fragment is currently visible to the user. This means it: (1) has been added, (2) has its view attached to the window, and (3) is not hidden.
`Unit`	`onActivityCreated(savedInstanceState: Bundle?)` Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. It can be used to do final initialization once these pieces are in place, such as retrieving views or restoring state. It is also useful for fragments that use `setRetainInstance(boolean)` to retain their instance, as this callback tells the fragment when it is fully associated with the new activity instance. This is called after `onCreateView` and before `onViewStateRestored(android.os.Bundle)`. If you override this method you must call through to the superclass implementation.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)` Receive the result from a previous call to `startActivityForResult(android.content.Intent,int)`. This follows the related Activity API as described there in `Activity.onActivityResult(int, int, Intent)`.
`Unit`	`onAttach(activity: Activity!)` If you override this method you must call through to the superclass implementation.
`Unit`	`onAttach(context: Context!)` Called when a fragment is first attached to its context. `onCreate(android.os.Bundle)` will be called after this. If you override this method you must call through to the superclass implementation.
`Unit`	`onAttachFragment(childFragment: Fragment!)` Called when a fragment is attached as a child of this fragment. This is called after the attached fragment's `onAttach` and before the attached fragment's `onCreate` if the fragment has not yet had a previous call to `onCreate`.
`Unit`	`onConfigurationChanged(newConfig: Configuration)` Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources. At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration. For more information, read Handling Runtime Changes. If you override this method you must call through to the superclass implementation.
`Boolean`	`onContextItemSelected(item: MenuItem!)` This hook is called whenever an item in a context menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Use `MenuItem.getMenuInfo()` to get extra information set by the View that added this menu item. Derived classes should call through to the base class for it to perform the default menu handling.
`Unit`	`onCreate(savedInstanceState: Bundle?)` Called to do initial creation of a fragment. This is called after `onAttach(android.app.Activity)` and before `onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`, but is not called if the fragment instance is retained across Activity re-creation (see `setRetainInstance(boolean)`). Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see `onActivityCreated(android.os.Bundle)`. If your app's `targetSdkVersion` is `android.os.Build.VERSION_CODES#M` or lower, child fragments being restored from the savedInstanceState are restored after `onCreate` returns. When targeting `android.os.Build.VERSION_CODES#N` or above and running on an N or newer platform version they are restored by `Fragment.onCreate`. If you override this method you must call through to the superclass implementation.
`Animator!`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` Called when a fragment loads an animation.
`Unit`	`onCreateContextMenu(menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo!)` Called when a context menu for the `view` is about to be shown. Unlike `onCreateOptionsMenu`, this will be called every time the context menu is about to be shown and should be populated for the view (or item inside the view for `AdapterView` subclasses, this can be found in the `menuInfo`)). Use `onContextItemSelected(android.view.MenuItem)` to know when an item has been selected. The default implementation calls up to `Activity.onCreateContextMenu`, though you can not call this implementation if you don't want that behavior. It is not safe to hold onto the context menu after this method returns. Called when the context menu for this view is being built. It is not safe to hold onto the menu after this method returns.
`Unit`	`onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` Initialize the contents of the Activity's standard options menu. You should place your menu items in to menu. For this method to be called, you must have first called `setHasOptionsMenu`. See `Activity.onCreateOptionsMenu` for more information.
`Unit`	`onDestroy()` Called when the fragment is no longer in use. This is called after `onStop()` and before `onDetach()`. If you override this method you must call through to the superclass implementation.
`Unit`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu. Receiving this call means that the menu needed to be rebuilt, but this fragment's items were not included in the newly built menu (its `onCreateOptionsMenu(android.view.Menu,android.view.MenuInflater)` was not called).
`Unit`	`onDetach()` Called when the fragment is no longer attached to its activity. This is called after `onDestroy()`, except in the cases where the fragment instance is retained across Activity re-creation (see `setRetainInstance(boolean)`), in which case it is called after `onStop()`. If you override this method you must call through to the superclass implementation.
`LayoutInflater!`	`onGetLayoutInflater(savedInstanceState: Bundle!)` Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached.
`Unit`	`onHiddenChanged(hidden: Boolean)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed. Fragments start out not hidden; this will be called whenever the fragment changes state from that.
`Unit`	`onInflate(activity: Activity!, attrs: AttributeSet!, savedInstanceState: Bundle!)` If you override this method you must call through to the superclass implementation.
`Unit`	`onInflate(context: Context!, attrs: AttributeSet!, savedInstanceState: Bundle!)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. This may be called immediately after the fragment is created from a tag in a layout file. Note this is before the fragment's `onAttach(android.app.Activity)` has been called; all you should do here is parse the attributes and save them away. This is called every time the fragment is inflated, even if it is being inflated into a new instance with saved state. It typically makes sense to re-parse the parameters each time, to allow them to change with different configurations. Here is a typical implementation of a fragment that can take parameters both through attributes supplied here as well from `getArguments()`: Note that parsing the XML attributes uses a "styleable" resource. The declaration for the styleable used here is: The fragment can then be declared within its activity's content layout through a tag like this: This fragment can also be created dynamically from arguments given at runtime in the arguments Bundle; here is an example of doing so at creation of the containing activity: If you override this method you must call through to the superclass implementation.
`Unit`	`onInflate(attrs: AttributeSet!, savedInstanceState: Bundle!)` If you override this method you must call through to the superclass implementation.
`Unit`	`onLowMemory()` This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing. If you override this method you must call through to the superclass implementation.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to android.app.Activity#onMultiWindowModeChanged of the containing Activity.
`Unit`	`onMultiWindowModeChanged(isInMultiWindowMode: Boolean, newConfig: Configuration!)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. This is generally tied to android.app.Activity#onMultiWindowModeChanged of the containing Activity. This method provides the same configuration that will be sent in the following `onConfigurationChanged(android.content.res.Configuration)` call after the activity enters this mode.
`Boolean`	`onOptionsItemSelected(item: MenuItem!)` This hook is called whenever an item in your options menu is selected. The default implementation simply returns false to have the normal processing happen (calling the item's Runnable or sending a message to its Handler as appropriate). You can use this method for any items for which you would like to do processing without those other facilities. Derived classes should call through to the base class for it to perform the default menu handling.
`Unit`	`onOptionsMenuClosed(menu: Menu!)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`Unit`	`onPause()` Called when the Fragment is no longer resumed. This is generally tied to `Activity.onPause` of the containing Activity's lifecycle. If you override this method you must call through to the superclass implementation.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)` Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to android.app.Activity#onPictureInPictureModeChanged of the containing Activity.
`Unit`	`onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean, newConfig: Configuration!)` Called by the system when the activity changes to and from picture-in-picture mode. This is generally tied to android.app.Activity#onPictureInPictureModeChanged of the containing Activity. This method provides the same configuration that will be sent in the following `onConfigurationChanged(android.content.res.Configuration)` call after the activity enters this mode.
`Unit`	`onPrepareOptionsMenu(menu: Menu!)` Prepare the Screen's standard options menu to be displayed. This is called right before the menu is shown, every time it is shown. You can use this method to efficiently enable/disable items or otherwise dynamically modify the contents. See `Activity.onPrepareOptionsMenu` for more information.
`Unit`	`onRequestPermissionsResult(requestCode: Int, permissions: Array<String!>, grantResults: IntArray)` Callback for the result from requesting permissions. This method is invoked for every call on `requestPermissions(java.lang.String[],int)`. Note: It is possible that the permissions request interaction with the user is interrupted. In this case you will receive empty permissions and results arrays which should be treated as a cancellation.
`Unit`	`onResume()` Called when the fragment is visible to the user and actively running. This is generally tied to `Activity.onResume` of the containing Activity's lifecycle. If you override this method you must call through to the superclass implementation.
`Unit`	`onSaveInstanceState(outState: Bundle!)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to `onCreate(android.os.Bundle)`, `onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`, and `onActivityCreated(android.os.Bundle)`. This corresponds to `Activity.onSaveInstanceState(Bundle)` and most of the discussion there applies here as well. Note however: this method may be called at any time before `onDestroy()`. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.
`Unit`	`onStart()` Called when the Fragment is visible to the user. This is generally tied to `Activity.onStart` of the containing Activity's lifecycle. If you override this method you must call through to the superclass implementation.
`Unit`	`onStop()` Called when the Fragment is no longer started. This is generally tied to `Activity.onStop` of the containing Activity's lifecycle. If you override this method you must call through to the superclass implementation.
`Unit`	`onTrimMemory(level: Int)` Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. You should never compare to exact values of the level, since new intermediate values may be added -- you will typically want to compare if the value is greater or equal to a level you are interested in. To retrieve the processes current trim level at any point, you can use `ActivityManager.getMyMemoryState(RunningAppProcessInfo)`. If you override this method you must call through to the superclass implementation.
`Unit`	`onViewStateRestored(savedInstanceState: Bundle!)` Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after `onActivityCreated(android.os.Bundle)` and before `onStart()`. If you override this method you must call through to the superclass implementation.
`Unit`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager.executePendingTransactions()` has been called. This method gives the Fragment the ability to delay Fragment animations until all data is loaded. Until then, the added, shown, and attached Fragments will be INVISIBLE and removed, hidden, and detached Fragments won't be have their Views removed. The transaction runs when all postponed added Fragments in the transaction have called `startPostponedEnterTransition()`. This method should be called before being added to the FragmentTransaction or in `onCreate(android.os.Bundle)`, `onAttach(android.content.Context)`, or `onCreateView(android.view.LayoutInflater,android.view.ViewGroup,android.os.Bundle)`}. `startPostponedEnterTransition()` must be called to allow the Fragment to start the transitions. When a FragmentTransaction is started that may affect a postponed FragmentTransaction, based on which containers are in their operations, the postponed FragmentTransaction will have its start triggered. The early triggering may result in faulty or nonexistent animations in the postponed transaction. FragmentTransactions that operate only on independent containers will not interfere with each other's postponement. Calling postponeEnterTransition on Fragments with a null View will not postpone the transition. Likewise, postponement only works if FragmentTransaction optimizations are enabled.
`Unit`	`registerForContextMenu(view: View!)` Registers a context menu to be shown for the given view (multiple views can show the context menu). This method will set the `OnCreateContextMenuListener` on the view to this fragment, so `onCreateContextMenu(android.view.ContextMenu,android.view.View,android.view.ContextMenu.ContextMenuInfo)` will be called when it is time to show the context menu.
`Unit`	`requestPermissions(permissions: Array<String!>, requestCode: Int)` Requests permissions to be granted to this application. These permissions must be requested in your manifest, they should not be granted to your app, and they should have protection level `#PROTECTION_DANGEROUS dangerous`, regardless whether they are declared by the platform or a third-party app. Normal permissions `android.content.pm.PermissionInfo#PROTECTION_NORMAL` are granted at install time if requested in the manifest. Signature permissions `android.content.pm.PermissionInfo#PROTECTION_SIGNATURE` are granted at install time if requested in the manifest and the signature of your app matches the signature of the app declaring the permissions. Call `shouldShowRequestPermissionRationale(java.lang.String)` before calling this API to check if the system recommends to show a rationale UI before asking for a permission. If your app does not have the requested permissions the user will be presented with UI for accepting them. After the user has accepted or rejected the requested permissions you will receive a callback on `onRequestPermissionsResult(int,java.lang.String[],int[])` reporting whether the permissions were granted or not. Note that requesting a permission does not guarantee it will be granted and your app should be able to run without having this permission. This method may start an activity allowing the user to choose which permissions to grant and which to reject. Hence, you should be prepared that your activity may be paused and resumed. Further, granting some permissions may require a restart of you application. In such a case, the system will recreate the activity stack before delivering the result to `onRequestPermissionsResult(int,java.lang.String[],int[])`. When checking whether you have a permission you should use `android.content.Context#checkSelfPermission(String)`. Calling this API for permissions already granted to your app would show UI to the user to decide whether the app can still hold these permissions. This can be useful if the way your app uses data guarded by the permissions changes significantly. You cannot request a permission if your activity sets `noHistory` to `true` because in this case the activity would not receive result callbacks including `onRequestPermissionsResult(int,java.lang.String[],int[])`.
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` Sets whether the exit transition and enter transition overlap or not. When true, the enter transition will start as soon as possible. When false, the enter transition will wait until the exit transition completes before starting.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` Sets whether the return transition and reenter transition overlap or not. When true, the reenter transition will start as soon as possible. When false, the reenter transition will wait until the return transition completes before starting.
`Unit`	`setArguments(args: Bundle!)` Supply the construction arguments for this fragment. The arguments supplied here will be retained across fragment destroy and creation. This method cannot be called if the fragment is added to a FragmentManager and if `isStateSaved()` would return true. Prior to `Build.VERSION_CODES.O`, this method may only be called if the fragment has not yet been added to a FragmentManager.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback!)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`Unit`	`setEnterTransition(transition: Transition!)` Sets the Transition that will be used to move Views into the initial scene. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View.INVISIBLE` to `View.VISIBLE`. If `transition` is null, entering Views will remain unaffected.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback!)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`Unit`	`setExitTransition(transition: Transition!)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If transition is null, the views will remain unaffected.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu` and related methods.
`Unit`	`setInitialSavedState(state: Fragment.SavedState!)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` Set a hint for whether this fragment's menu should be visible. This is useful if you know that a fragment has been placed in your view hierarchy so that the user can not currently seen it, so any menu items it has should also not be shown.
`Unit`	`setReenterTransition(transition: Transition!)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. The entering Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as exiting is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If transition is null, the views will remain unaffected. If nothing is set, the default will be to use the same transition as `setExitTransition(android.transition.Transition)`.
`Unit`	`setRetainInstance(retain: Boolean)` Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). This can only be used with fragments not in the back stack. If set, the fragment lifecycle will be slightly different when an activity is recreated: `onDestroy()` will not be called (but `onDetach()` still will be, because the fragment is being detached from its current activity). `onCreate(android.os.Bundle)` will not be called since the fragment is not being re-created. `onAttach(android.app.Activity)` and `onActivityCreated(android.os.Bundle)` will still be called.
`Unit`	`setReturnTransition(transition: Transition!)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. The exiting Views will be those that are regular Views or ViewGroups that have `ViewGroup.isTransitionGroup` return true. Typical Transitions will extend `android.transition.Visibility` as entering is governed by changing visibility from `View.VISIBLE` to `View.INVISIBLE`. If `transition` is null, entering Views will remain unaffected. If nothing is set, the default will be to use the same value as set in `setEnterTransition(android.transition.Transition)`.
`Unit`	`setSharedElementEnterTransition(transition: Transition!)` Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position.
`Unit`	`setSharedElementReturnTransition(transition: Transition!)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. This Transition acts in the leaving Fragment. Typical Transitions will affect size and location, such as `android.transition.ChangeBounds`. A null value will cause transferred shared elements to blink to the final position. If no value is set, the default will be to use the same value as `setSharedElementEnterTransition(android.transition.Transition)`.
`Unit`	`setTargetFragment(fragment: Fragment!, requestCode: Int)` Optional target for this fragment. This may be used, for example, if this fragment is being started by another, and when done wants to give a result back to the first. The target set here is retained across instances via `FragmentManager.putFragment()`.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` Set a hint to the system about whether this fragment's UI is currently visible to the user. This hint defaults to true and is persistent across fragment instance state save and restore. An app may set this to false to indicate that the fragment's UI is scrolled out of visibility or is otherwise not directly visible to the user. This may be used by the system to prioritize operations such as fragment lifecycle updates or loader ordering behavior. Note: This method may be called outside of the fragment lifecycle and thus has no ordering guarantees with regard to fragment lifecycle method calls. Note: Prior to Android N there was a platform bug that could cause `setUserVisibleHint` to bring a fragment up to the started state before its `FragmentTransaction` had been committed. As some apps relied on this behavior, it is preserved for apps that declare a `targetSdkVersion` of 23 or lower.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String)` Gets whether you should show UI with rationale before requesting a permission.
`Unit`	`startActivity(intent: Intent!)` Call android.app.Activity#startActivity(android.content.Intent) from the fragment's containing Activity.
`Unit`	`startActivity(intent: Intent!, options: Bundle!)` Call android.app.Activity#startActivity(android.content.Intent,android.os.Bundle) from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` Call `Activity.startActivityForResult(Intent, int)` from the fragment's containing Activity.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int, options: Bundle!)` Call `Activity.startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
`Unit`	`startIntentSenderForResult(intent: IntentSender!, requestCode: Int, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle!)` Call `Activity.startIntentSenderForResult(IntentSender, int, Intent, int, int, int,` from the fragment's containing Activity.
`Unit`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called. If postponeEnterTransition() was called, you must call startPostponedEnterTransition() or `FragmentManager.executePendingTransactions()` to complete the FragmentTransaction. If postponement was interrupted with `FragmentManager.executePendingTransactions()`, before `startPostponedEnterTransition()`, animations may not run or may execute improperly.
`String`	`toString()`
`Unit`	`unregisterForContextMenu(view: View!)` Prevents a context menu to be shown for the given view. This method will remove the `OnCreateContextMenuListener` on the view.

From class ComponentCallbacks

Unit

onConfigurationChanged(newConfig: Configuration)

Called by the system when the device configuration changes while your component is running. Note that, unlike activities, other components are never restarted when a configuration changes: they must always deal with the results of the change, such as by re-retrieving resources.

At the time that this function has been called, your Resources object will have been updated to return resource values matching the new configuration.

For more information, read Handling Runtime Changes.

Unit

onLowMemory()

This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. While the exact point at which this will be called is not defined, generally it will happen when all background process have been killed. That is, before reaching the point of killing processes hosting service and foreground UI that we would like to avoid killing.

Public constructors

ListFragment

Added in API level 11

ListFragment()

Public methods

getListAdapter

Added in API level 11

open fun getListAdapter(): ListAdapter!

Deprecated: Deprecated in Java.

Get the ListAdapter associated with this fragment's ListView.

getListView

Added in API level 11

open fun getListView(): ListView!

Deprecated: Deprecated in Java.

Get the fragment's list view widget.

getSelectedItemId

Added in API level 11

open fun getSelectedItemId(): Long

Deprecated: Deprecated in Java.

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

getSelectedItemPosition

Added in API level 11

open fun getSelectedItemPosition(): Int

Deprecated: Deprecated in Java.

Get the position of the currently selected list item.

onCreateView

Added in API level 11

open fun onCreateView(
    inflater: LayoutInflater!, 
    container: ViewGroup?, 
    savedInstanceState: Bundle!
): View?

Deprecated: Deprecated in Java.

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`	ViewGroup?: 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`	Bundle!: 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

Added in API level 11

open fun onDestroyView(): Unit

Deprecated: Deprecated in Java.

Detach from list view.

onListItemClick

Added in API level 11

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

Deprecated: Deprecated in Java.

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`	View!: The view that was clicked within the ListView
`position`	Int: The position of the view in the list
`id`	Long: The row id of the item that was clicked

onViewCreated

Added in API level 13
Deprecated in API level 28

open fun onViewCreated(
    view: View!, 
    savedInstanceState: Bundle?
): Unit

Deprecated: Deprecated in Java.

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

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

setEmptyText

Added in API level 11

open fun setEmptyText(text: CharSequence!): Unit

Deprecated: Deprecated in Java.

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

Added in API level 11

open fun setListAdapter(adapter: ListAdapter!): Unit

Deprecated: Deprecated in Java.

Provide the cursor for the list view.

setListShown

Added in API level 11

open fun setListShown(shown: Boolean): Unit

Deprecated: Deprecated in Java.

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(android.widget.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

Added in API level 11

open fun setListShownNoAnimation(shown: Boolean): Unit

Deprecated: Deprecated in Java.

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

setSelection

Added in API level 11

open fun setSelection(position: Int): Unit

Deprecated: Deprecated in Java.

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

Parameters
`position`	Int: