Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

ListFragment

extends Fragment

java.lang.Object
↳	android.support.v4.app.Fragment
	↳	android.support.v4.app.ListFragment

Class Overview

Static library support version of the framework's 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
	ListFragment ()

Public Methods
ListAdapter	getListAdapter () Get the ListAdapter associated with this activity's ListView.
ListView	getListView () Get the activity's list view widget.
long	getSelectedItemId () Get the cursor row ID of the currently selected list item.
int	getSelectedItemPosition () Get the position of the currently selected list item.
View	onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Provide default implementation to return a simple list view.
void	onDestroyView () Detach from list view.
void	onListItemClick ( ListView l, View v, int position, long id) This method will be called when an item in the list is selected.
void	onViewCreated ( View view, Bundle savedInstanceState) Attach to list view once the view hierarchy has been created.
void	setEmptyText ( CharSequence text) The default content for a ListFragment has a TextView that can be shown when the list is empty.
void	setListAdapter ( ListAdapter adapter) Provide the cursor for the list view.
void	setListShown (boolean shown) Control whether the list is being displayed.
void	setListShownNoAnimation (boolean shown) Like `setListShown(boolean)` , but no animation is used when transitioning from the previous state.
void	setSelection (int position) Set the currently selected list item to the specified position with the adapter's data

[Expand]

Inherited Methods

From class android.support.v4.app.Fragment

void	dump ( String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Fragments's state into the given stream.
final boolean	equals ( Object o) Subclasses can not override equals().
final FragmentActivity	getActivity () Return the Activity this fragment is currently associated with.
final Bundle	getArguments () Return the arguments supplied when the fragment was instantiated, if any.
final FragmentManager	getChildFragmentManager () Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
final FragmentManager	getFragmentManager () Return the FragmentManager for interacting with fragments associated with this fragment's activity.
final int	getId () Return the identifier this fragment is known by.
LoaderManager	getLoaderManager () Return the LoaderManager for this fragment, creating it if needed.
final Fragment	getParentFragment () Returns the parent Fragment containing this Fragment.
final Resources	getResources () Return `getActivity().getResources()` .
final boolean	getRetainInstance ()
final String	getString (int resId) Return a localized string from the application's package's default string table.
final String	getString (int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)` .
final String	getTag () Get the tag name of the fragment, if specified.
final Fragment	getTargetFragment () Return the target fragment set by `setTargetFragment(Fragment, int)` .
final int	getTargetRequestCode () Return the target request code set by `setTargetFragment(Fragment, int)` .
final CharSequence	getText (int resId) 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(LayoutInflater, ViewGroup, Bundle)` ), if provided.
final int	hashCode () Subclasses can not override hashCode().
static Fragment	instantiate ( Context context, String fname) Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
static Fragment	instantiate ( Context context, String fname, Bundle args) Create a new instance of a Fragment with the given class name.
final boolean	isAdded () Return true if the fragment is currently added to its activity.
final boolean	isDetached () Return true if the fragment has been explicitly detached from the UI.
final boolean	isHidden () Return true if the fragment has been hidden.
final boolean	isInLayout () Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
final boolean	isRemoving () Return true if this fragment is currently being removed from its activity.
final boolean	isResumed () Return true if the fragment is in the resumed state.
final boolean	isVisible () Return true if the fragment is currently visible to the user.
void	onActivityCreated ( Bundle savedInstanceState) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
void	onActivityResult (int requestCode, int resultCode, Intent data) Receive the result from a previous call to `startActivityForResult(Intent, int)` .
void	onAttach ( Activity activity) Called when a fragment is first attached to its activity.
void	onConfigurationChanged ( Configuration newConfig) Called by the system when the device configuration changes while your component is running.
boolean	onContextItemSelected ( MenuItem item) This hook is called whenever an item in a context menu is selected.
void	onCreate ( Bundle savedInstanceState) Called to do initial creation of a fragment.
Animation	onCreateAnimation (int transit, boolean enter, int nextAnim) Called when a fragment loads an animation.
void	onCreateContextMenu ( ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) Called when a context menu for the `view` is about to be shown.
void	onCreateOptionsMenu ( Menu menu, MenuInflater inflater) Initialize the contents of the Activity's standard options menu.
View	onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view.
void	onDestroy () Called when the fragment is no longer in use.
void	onDestroyOptionsMenu () Called when this fragment's option menu items are no longer being included in the overall options menu.
void	onDestroyView () Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
void	onDetach () Called when the fragment is no longer attached to its activity.
void	onHiddenChanged (boolean hidden) Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
void	onInflate ( Activity activity, AttributeSet attrs, Bundle savedInstanceState) Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
void	onLowMemory () This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
boolean	onOptionsItemSelected ( MenuItem item) This hook is called whenever an item in your options menu is selected.
void	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).
void	onPause () Called when the Fragment is no longer resumed.
void	onPrepareOptionsMenu ( Menu menu) Prepare the Screen's standard options menu to be displayed.
void	onResume () Called when the fragment is visible to the user and actively running.
void	onSaveInstanceState ( Bundle outState) 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.
void	onStart () Called when the Fragment is visible to the user.
void	onStop () Called when the Fragment is no longer started.
void	onViewCreated ( View view, Bundle savedInstanceState) Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
void	onViewStateRestored ( Bundle savedInstanceState) Called when all saved state has been restored into the view hierarchy of the fragment.
void	registerForContextMenu ( View view) Registers a context menu to be shown for the given view (multiple views can show the context menu).
void	setArguments ( Bundle args) Supply the construction arguments for this fragment.
void	setHasOptionsMenu (boolean hasMenu) Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
void	setInitialSavedState ( Fragment.SavedState state) Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState` .
void	setMenuVisibility (boolean menuVisible) Set a hint for whether this fragment's menu should be visible.
void	setRetainInstance (boolean retain) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
void	setTargetFragment ( Fragment fragment, int requestCode) Optional target for this fragment.
void	setUserVisibleHint (boolean isVisibleToUser) Set a hint to the system about whether this fragment's UI is currently visible to the user.
void	startActivity ( Intent intent) Call `startActivity(Intent)` on the fragment's containing Activity.
void	startActivityForResult ( Intent intent, int requestCode) Call `startActivityForResult(Intent, int)` on the fragment's containing Activity.
String	toString () Returns a string containing a concise, human-readable description of this object.
void	unregisterForContextMenu ( View view) Prevents a context menu to be shown for the given view.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

From interface android.view.View.OnCreateContextMenuListener

Public Constructors

public ListFragment ()

Public Methods

public ListAdapter getListAdapter ()

Get the ListAdapter associated with this activity's ListView.

public ListView getListView ()

Get the activity's list view widget.

public long getSelectedItemId ()

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

public int getSelectedItemPosition ()

Get the position of the currently selected list item.

public View onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

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 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	The LayoutInflater object that can be used to inflate any views in the fragment,
container	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	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns

Return the View for the fragment's UI, or null.

public void onDestroyView ()

Detach from list view.

public void onListItemClick ( ListView l, View v, int position, long id)

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	The ListView where the click happened
v	The view that was clicked within the ListView
position	The position of the view in the list
id	The row id of the item that was clicked

public void onViewCreated ( View view, Bundle savedInstanceState)

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

Parameters

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

public void setEmptyText ( CharSequence text)

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.

public void setListAdapter ( ListAdapter adapter)

Provide the cursor for the list view.

public void setListShown (boolean shown)

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	If true, the list view is shown; if false, the progress indicator. The initial value is true.

public void setListShownNoAnimation (boolean shown)

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

public void setSelection (int position)

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

Results

Interfaces

Classes

Exceptions

ListFragment

Class Overview

Summary

Public Constructors

public ListFragment ()

Public Methods

public ListAdapter getListAdapter ()

public ListView getListView ()

public long getSelectedItemId ()

public int getSelectedItemPosition ()

public View onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Parameters

Returns

public void onDestroyView ()

public void onListItemClick ( ListView l, View v, int position, long id)

Parameters

public void onViewCreated ( View view, Bundle savedInstanceState)

Parameters

public void setEmptyText ( CharSequence text)

public void setListAdapter ( ListAdapter adapter)

public void setListShown (boolean shown)

Parameters

public void setListShownNoAnimation (boolean shown)

public void setSelection (int position)