added in version 22.1.0
belongs to Maven artifact com.android.support:cursoradapter:28.0.0-alpha1
Summary: Nested Classes | Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

SimpleCursorAdapter

public class SimpleCursorAdapter
extends ResourceCursorAdapter

java.lang.Object
   ↳ android.widget.BaseAdapter
     ↳ android.support.v4.widget.CursorAdapter
       ↳ android.support.v4.widget.ResourceCursorAdapter
         ↳ android.support.v4.widget.SimpleCursorAdapter

Static library support version of the framework's SimpleCursorAdapter. 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

Nested classes

interface SimpleCursorAdapter.CursorToStringConverter

This class can be used by external clients of SimpleCursorAdapter to define how the Cursor should be converted to a String. 

interface SimpleCursorAdapter.ViewBinder

This class can be used by external clients of SimpleCursorAdapter to bind values fom the Cursor to views. 

Inherited constants

From class android.support.v4.widget.CursorAdapter
From interface android.widget.Adapter

Public constructors

SimpleCursorAdapter(Context context, int layout, Cursor c, String[] from, int[] to)

This constructor was deprecated in API level 22.1.0. This option is discouraged, as it results in Cursor queries being performed on the application's UI thread and thus can cause poor responsiveness or even Application Not Responding errors. As an alternative, use LoaderManager with a CursorLoader.

SimpleCursorAdapter(Context context, int layout, Cursor c, String[] from, int[] to, int flags)

Standard constructor.

Public methods

void bindView(View view, Context context, Cursor cursor)

Binds all of the field names passed into the "to" parameter of the constructor with their corresponding cursor columns as specified in the "from" parameter.

void changeCursorAndColumns(Cursor c, String[] from, int[] to)

Change the cursor and change the column-to-view mappings at the same time.

CharSequence convertToString(Cursor cursor)

Returns a CharSequence representation of the specified Cursor as defined by the current CursorToStringConverter.

SimpleCursorAdapter.CursorToStringConverter getCursorToStringConverter()

Returns the converter used to convert the filtering Cursor into a String.

int getStringConversionColumn()

Return the index of the column used to get a String representation of the Cursor.

SimpleCursorAdapter.ViewBinder getViewBinder()

Returns the SimpleCursorAdapter.ViewBinder used to bind data to views.

void setCursorToStringConverter(SimpleCursorAdapter.CursorToStringConverter cursorToStringConverter)

Sets the converter used to convert the filtering Cursor into a String.

void setStringConversionColumn(int stringConversionColumn)

Defines the index of the column in the Cursor used to get a String representation of that Cursor.

void setViewBinder(SimpleCursorAdapter.ViewBinder viewBinder)

Sets the binder used to bind data to views.

void setViewImage(ImageView v, String value)

Called by bindView() to set the image for an ImageView but only if there is no existing ViewBinder or if the existing ViewBinder cannot handle binding to an ImageView.

void setViewText(TextView v, String text)

Called by bindView() to set the text for a TextView but only if there is no existing ViewBinder or if the existing ViewBinder cannot handle binding to a TextView.

Cursor swapCursor(Cursor c)

Swap in a new Cursor, returning the old Cursor.

Inherited methods

From class android.support.v4.widget.ResourceCursorAdapter
From class android.support.v4.widget.CursorAdapter
From class android.widget.BaseAdapter
From class java.lang.Object
From interface android.widget.Filterable
From interface android.widget.ListAdapter
From interface android.widget.SpinnerAdapter
From interface android.widget.Adapter

Public constructors

SimpleCursorAdapter

added in version 22.1.0
SimpleCursorAdapter (Context context, 
                int layout, 
                Cursor c, 
                String[] from, 
                int[] to)

This constructor was deprecated in API level 22.1.0.
This option is discouraged, as it results in Cursor queries being performed on the application's UI thread and thus can cause poor responsiveness or even Application Not Responding errors. As an alternative, use LoaderManager with a CursorLoader.

Constructor the enables auto-requery.

Parameters
context Context

layout int

c Cursor

from String

to int

SimpleCursorAdapter

added in version 22.1.0
SimpleCursorAdapter (Context context, 
                int layout, 
                Cursor c, 
                String[] from, 
                int[] to, 
                int flags)

Standard constructor.

Parameters
context Context: The context where the ListView associated with this SimpleListItemFactory is running
layout int: resource identifier of a layout file that defines the views for this list item. The layout file should include at least those named views defined in "to"
c Cursor: The database cursor. Can be null if the cursor is not available yet.
from String: A list of column names representing the data to bind to the UI. Can be null if the cursor is not available yet.
to int: The views that should display column in the "from" parameter. These should all be TextViews. The first N views in this list are given the values of the first N columns in the from parameter. Can be null if the cursor is not available yet.
flags int: Flags used to determine the behavior of the adapter, as per CursorAdapter(Context, Cursor, int).

Public methods

bindView

added in version 22.1.0
void bindView (View view, 
                Context context, 
                Cursor cursor)

Binds all of the field names passed into the "to" parameter of the constructor with their corresponding cursor columns as specified in the "from" parameter. Binding occurs in two phases. First, if a SimpleCursorAdapter.ViewBinder is available, setViewValue(android.view.View, android.database.Cursor, int) is invoked. If the returned value is true, binding has occured. If the returned value is false and the view to bind is a TextView, setViewText(TextView, String) is invoked. If the returned value is false and the view to bind is an ImageView, setViewImage(ImageView, String) is invoked. If no appropriate binding can be found, an IllegalStateException is thrown.

Parameters
view View: Existing view, returned earlier by newView
context Context: Interface to application's global information
cursor Cursor: The cursor from which to get the data. The cursor is already moved to the correct position.

Throws
IllegalStateException if binding cannot occur

changeCursorAndColumns

added in version 22.1.0
void changeCursorAndColumns (Cursor c, 
                String[] from, 
                int[] to)

Change the cursor and change the column-to-view mappings at the same time.

Parameters
c Cursor: The database cursor. Can be null if the cursor is not available yet.
from String: A list of column names representing the data to bind to the UI. Can be null if the cursor is not available yet.
to int: The views that should display column in the "from" parameter. These should all be TextViews. The first N views in this list are given the values of the first N columns in the from parameter. Can be null if the cursor is not available yet.

convertToString

added in version 22.1.0
CharSequence convertToString (Cursor cursor)

Returns a CharSequence representation of the specified Cursor as defined by the current CursorToStringConverter. If no CursorToStringConverter has been set, the String conversion column is used instead. If the conversion column is -1, the returned String is empty if the cursor is null or Cursor.toString().

Parameters
cursor Cursor: the Cursor to convert to a CharSequence
Returns
CharSequence a non-null CharSequence representing the cursor

getCursorToStringConverter

added in version 22.1.0
SimpleCursorAdapter.CursorToStringConverter getCursorToStringConverter ()

Returns the converter used to convert the filtering Cursor into a String.

Returns
SimpleCursorAdapter.CursorToStringConverter null if the converter does not exist or an instance of SimpleCursorAdapter.CursorToStringConverter

getStringConversionColumn

added in version 22.1.0
int getStringConversionColumn ()

Return the index of the column used to get a String representation of the Cursor.

Returns
int a valid index in the current Cursor or -1

getViewBinder

added in version 22.1.0
SimpleCursorAdapter.ViewBinder getViewBinder ()

Returns the SimpleCursorAdapter.ViewBinder used to bind data to views.

Returns
SimpleCursorAdapter.ViewBinder a ViewBinder or null if the binder does not exist

setCursorToStringConverter

added in version 22.1.0
void setCursorToStringConverter (SimpleCursorAdapter.CursorToStringConverter cursorToStringConverter)

Sets the converter used to convert the filtering Cursor into a String.

Parameters
cursorToStringConverter SimpleCursorAdapter.CursorToStringConverter: the Cursor to String converter, or null to remove the converter

setStringConversionColumn

added in version 22.1.0
void setStringConversionColumn (int stringConversionColumn)

Defines the index of the column in the Cursor used to get a String representation of that Cursor. The column is used to convert the Cursor to a String only when the current CursorToStringConverter is null.

Parameters
stringConversionColumn int: a valid index in the current Cursor or -1 to use the default conversion mechanism

setViewBinder

added in version 22.1.0
void setViewBinder (SimpleCursorAdapter.ViewBinder viewBinder)

Sets the binder used to bind data to views.

Parameters
viewBinder SimpleCursorAdapter.ViewBinder: the binder used to bind data to views, can be null to remove the existing binder

setViewImage

added in version 22.1.0
void setViewImage (ImageView v, 
                String value)

Called by bindView() to set the image for an ImageView but only if there is no existing ViewBinder or if the existing ViewBinder cannot handle binding to an ImageView. By default, the value will be treated as an image resource. If the value cannot be used as an image resource, the value is used as an image Uri. Intended to be overridden by Adapters that need to filter strings retrieved from the database.

Parameters
v ImageView: ImageView to receive an image
value String: the value retrieved from the cursor

setViewText

added in version 22.1.0
void setViewText (TextView v, 
                String text)

Called by bindView() to set the text for a TextView but only if there is no existing ViewBinder or if the existing ViewBinder cannot handle binding to a TextView. Intended to be overridden by Adapters that need to filter strings retrieved from the database.

Parameters
v TextView: TextView to receive text
text String: the text to be set for the TextView

swapCursor

added in version 22.1.0
Cursor swapCursor (Cursor c)

Swap in a new Cursor, returning the old Cursor. Unlike changeCursor(Cursor), the returned old Cursor is not closed.

Parameters
c Cursor: The new cursor to be used.
Returns
Cursor Returns the previously set Cursor, or null if there was not one. If the given new Cursor is the same instance is the previously set Cursor, null is also returned.