public
class
ListFragment
extends Fragment
java.lang.Object | ||
↳ | android.support.v4.app.Fragment | |
↳ | android.support.v4.app.ListFragment |
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.
Public constructors | |
---|---|
ListFragment()
|
Public methods | |
---|---|
ListAdapter
|
getListAdapter()
Get the ListAdapter associated with this fragment's ListView. |
ListView
|
getListView()
Get the fragment'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 |
void
|
setSelection(int position)
Set the currently selected list item to the specified position with the adapter's data |
Inherited methods | |
---|---|
From
class
android.support.v4.app.Fragment
| |
From
class
java.lang.Object
| |
From
interface
android.content.ComponentCallbacks
| |
From
interface
android.view.View.OnCreateContextMenuListener
|
ListFragment ()
ListAdapter getListAdapter ()
Get the ListAdapter associated with this fragment's ListView.
Returns | |
---|---|
ListAdapter |
long getSelectedItemId ()
Get the cursor row ID of the currently selected list item.
Returns | |
---|---|
long |
int getSelectedItemPosition ()
Get the position of the currently selected list item.
Returns | |
---|---|
int |
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 |
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. |
Returns | |
---|---|
View |
Return the View for the fragment's UI, or null. |
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. 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
|
void onViewCreated (View view, Bundle savedInstanceState)
Attach to list view once the view hierarchy has been created.
Parameters | |
---|---|
view |
View :
The View returned by onCreateView(LayoutInflater, ViewGroup, Bundle) . |
savedInstanceState |
Bundle :
If non-null, this fragment is being re-constructed
from a previous saved state as given here.
|
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.
Parameters | |
---|---|
text |
CharSequence
|
void setListAdapter (ListAdapter adapter)
Provide the cursor for the list view.
Parameters | |
---|---|
adapter |
ListAdapter
|
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 |
boolean :
If true, the list view is shown; if false, the progress
indicator. The initial value is true.
|
void setListShownNoAnimation (boolean shown)
Like setListShown(boolean)
, but no animation is used when
transitioning from the previous state.
Parameters | |
---|---|
shown |
boolean
|
void setSelection (int position)
Set the currently selected list item to the specified position with the adapter's data