Added in API level 1

SimpleCursorAdapter

---

Kotlin |Java

open class SimpleCursorAdapter : ResourceCursorAdapter

kotlin.Any
↳	android.widget.BaseAdapter
	↳	android.widget.CursorAdapter
		↳	android.widget.ResourceCursorAdapter
			↳	android.widget.SimpleCursorAdapter

An easy adapter to map columns from a cursor to TextViews or ImageViews defined in an XML file. You can specify which columns you want, which views you want to display the columns, and the XML file that defines the appearance of these views. Binding occurs in two phases. First, if a android.widget.SimpleCursorAdapter.ViewBinder is available, ViewBinder#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(android.widget.TextView,java.lang.String) is invoked. If the returned value is false and the view to bind is an ImageView, setViewImage(android.widget.ImageView,java.lang.String) is invoked. If no appropriate binding can be found, an IllegalStateException is thrown. If this adapter is used with filtering, for instance in an android.widget.AutoCompleteTextView, you can use the android.widget.SimpleCursorAdapter.CursorToStringConverter and the android.widget.FilterQueryProvider interfaces to get control over the filtering process. You can refer to convertToString(android.database.Cursor) and runQueryOnBackgroundThread(java.lang.CharSequence) for more information.

Summary

Nested classes
abstract	CursorToStringConverter This class can be used by external clients of SimpleCursorAdapter to define how the Cursor should be converted to a String.
abstract	ViewBinder This class can be used by external clients of SimpleCursorAdapter to bind values fom the Cursor to views.

Inherited constants

From class CursorAdapter Int FLAG_AUTO_REQUERY If set the adapter will call requery() on the cursor whenever a content change notification is delivered. Implies FLAG_REGISTER_CONTENT_OBSERVER. Int FLAG_REGISTER_CONTENT_OBSERVER If set the adapter will register a content observer on the cursor and will call onContentChanged() when a notification comes in. Be careful when using this flag: you will need to unset the current Cursor from the adapter to avoid leaks due to its registered observers. This flag is not needed when using a CursorAdapter with a android.content.CursorLoader.

Public constructors
SimpleCursorAdapter(context: Context!, layout: Int, c: Cursor!, from: Array<String!>!, to: IntArray!) Constructor the enables auto-requery.
SimpleCursorAdapter(context: Context!, layout: Int, c: Cursor!, from: Array<String!>!, to: IntArray!, flags: Int) Standard constructor.

Public methods
open Unit	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.
open Unit	changeCursorAndColumns(c: Cursor!, from: Array<String!>!, to: IntArray!) Change the cursor and change the column-to-view mappings at the same time.
open CharSequence!	convertToString(cursor: Cursor!) Returns a CharSequence representation of the specified Cursor as defined by the current CursorToStringConverter.
open SimpleCursorAdapter.CursorToStringConverter!	getCursorToStringConverter() Returns the converter used to convert the filtering Cursor into a String.
open Int	getStringConversionColumn() Return the index of the column used to get a String representation of the Cursor.
open SimpleCursorAdapter.ViewBinder!	getViewBinder() Returns the ViewBinder used to bind data to views.
open Unit	setCursorToStringConverter(cursorToStringConverter: SimpleCursorAdapter.CursorToStringConverter!) Sets the converter used to convert the filtering Cursor into a String.
open Unit	setStringConversionColumn(stringConversionColumn: Int) Defines the index of the column in the Cursor used to get a String representation of that Cursor.
open Unit	setViewBinder(viewBinder: SimpleCursorAdapter.ViewBinder!) Sets the binder used to bind data to views.
open Unit	setViewImage(v: ImageView!, value: String!) 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.
open Unit	setViewText(v: TextView!, text: String!) 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.
open Cursor!	swapCursor(c: Cursor!)

Inherited functions
From class BaseAdapter Boolean areAllItemsEnabled() Array<CharSequence!>? getAutofillOptions() Int getItemViewType(position: Int) Int getViewTypeCount() Boolean isEmpty() Boolean isEnabled(position: Int) Unit notifyDataSetChanged() Notifies the attached observers that the underlying data has been changed and any View reflecting the data set should refresh itself. Unit notifyDataSetInvalidated() Notifies the attached observers that the underlying data is no longer valid or available. Once invoked this adapter is no longer valid and should not report further data set changes. Unit registerDataSetObserver(observer: DataSetObserver!) Unit setAutofillOptions(vararg options: CharSequence!) Sets the value returned by getAutofillOptions() Unit unregisterDataSetObserver(observer: DataSetObserver!)
From class CursorAdapter Unit bindView(view: View!, context: Context!, cursor: Cursor!) Bind an existing view to the data pointed to by cursor Unit changeCursor(cursor: Cursor!) Change the underlying cursor to a new cursor. If there is an existing cursor it will be closed. CharSequence! convertToString(cursor: Cursor!) Converts the cursor into a CharSequence. Subclasses should override this method to convert their results. The default implementation returns an empty String for null values or the default String representation of the value. Int getCount() Cursor! getCursor() Returns the cursor. View! getDropDownView(position: Int, convertView: View!, parent: ViewGroup!) Resources.Theme? getDropDownViewTheme() Filter! getFilter() FilterQueryProvider! getFilterQueryProvider() Returns the query filter provider used for filtering. When the provider is null, no filtering occurs. Any! getItem(position: Int) Long getItemId(position: Int) View! getView(position: Int, convertView: View!, parent: ViewGroup!) Boolean hasStableIds() Unit init(context: Context!, c: Cursor!, autoRequery: Boolean) Unit onContentChanged() Called when the ContentObserver on the cursor receives a change notification. The default implementation provides the auto-requery logic, but may be overridden by sub classes. Cursor! runQueryOnBackgroundThread(constraint: CharSequence!) Runs a query with the specified constraint. This query is requested by the filter attached to this adapter. The query is provided by a android.widget.FilterQueryProvider. If no provider is specified, the current cursor is not filtered and returned. After this method returns the resulting cursor is passed to changeCursor(android.database.Cursor) and the previous cursor is closed. This method is always executed on a background thread, not on the application's main thread (or UI thread.) Contract: when constraint is null or empty, the original results, prior to any filtering, must be returned. This method may take several seconds to complete, so it should only be called from a worker thread. Unit setFilterQueryProvider(filterQueryProvider: FilterQueryProvider!) Sets the query filter provider used to filter the current Cursor. The provider's android.widget.FilterQueryProvider#runQuery(CharSequence) method is invoked when filtering is requested by a client of this adapter. Cursor! swapCursor(newCursor: Cursor!) Swap in a new Cursor, returning the old Cursor. Unlike changeCursor(android.database.Cursor), the returned old Cursor is not closed.
From class ResourceCursorAdapter View! newDropDownView(context: Context!, cursor: Cursor!, parent: ViewGroup!) View! newView(context: Context!, cursor: Cursor!, parent: ViewGroup!) Inflates view(s) from the specified XML file. Unit setDropDownViewResource(dropDownLayout: Int) Sets the layout resource of the drop down views. Unit setDropDownViewTheme(theme: Resources.Theme?) Sets the android.content.res.Resources.Theme against which drop-down views are inflated. By default, drop-down views are inflated against the theme of the Context passed to the adapter's constructor. Unit setViewResource(layout: Int) Sets the layout resource of the item views.

Public constructors

SimpleCursorAdapter

Added in API level 1

SimpleCursorAdapter(
    context: Context!, 
    layout: Int, 
    c: Cursor!, 
    from: Array<String!>!, 
    to: IntArray!)

Deprecated: 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 android.app.LoaderManager with a android.content.CursorLoader.

Constructor the enables auto-requery.

SimpleCursorAdapter

Added in API level 11

SimpleCursorAdapter(
    context: Context!, 
    layout: Int, 
    c: Cursor!, 
    from: Array<String!>!, 
    to: IntArray!, 
    flags: Int)

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	Array<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	IntArray!: 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#CursorAdapter(Context, Cursor, int).

Public methods

bindView

Added in API level 1

open fun bindView(
    view: View!, 
    context: Context!, 
    cursor: Cursor!
): Unit

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 android.widget.SimpleCursorAdapter.ViewBinder is available, ViewBinder#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(android.widget.TextView,java.lang.String) is invoked. If the returned value is false and the view to bind is an ImageView, setViewImage(android.widget.ImageView,java.lang.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.

Exceptions
java.lang.IllegalStateException	if binding cannot occur

See Also

• android.widget.CursorAdapter#bindView(android.view.View, * android.content.Context, android.database.Cursor)
• #getViewBinder()
• #setViewBinder(android.widget.SimpleCursorAdapter.ViewBinder)
• #setViewImage(ImageView, String)
• #setViewText(TextView, String)

changeCursorAndColumns

Added in API level 3

open fun changeCursorAndColumns(
    c: Cursor!, 
    from: Array<String!>!, 
    to: IntArray!
): Unit

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	Array<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	IntArray!: 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 API level 1

open fun convertToString(cursor: Cursor!): CharSequence!

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

Return
CharSequence!	a non-null CharSequence representing the cursor

getCursorToStringConverter

Added in API level 1

open fun getCursorToStringConverter(): SimpleCursorAdapter.CursorToStringConverter!

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

Return
SimpleCursorAdapter.CursorToStringConverter!	null if the converter does not exist or an instance of android.widget.SimpleCursorAdapter.CursorToStringConverter

See Also

• #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter)
• #getStringConversionColumn()
• #setStringConversionColumn(int)
• android.widget.CursorAdapter#convertToString(android.database.Cursor)

getStringConversionColumn

Added in API level 1

open fun getStringConversionColumn(): Int

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

Return
Int	a valid index in the current Cursor or -1

See Also

• android.widget.CursorAdapter#convertToString(android.database.Cursor)
• #setStringConversionColumn(int)
• #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter)
• #getCursorToStringConverter()

getViewBinder

Added in API level 1

open fun getViewBinder(): SimpleCursorAdapter.ViewBinder!

Returns the ViewBinder used to bind data to views.

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

See Also

• #bindView(android.view.View, android.content.Context, android.database.Cursor)
• #setViewBinder(android.widget.SimpleCursorAdapter.ViewBinder)

setCursorToStringConverter

Added in API level 1

open fun setCursorToStringConverter(cursorToStringConverter: SimpleCursorAdapter.CursorToStringConverter!): Unit

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

See Also

• #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter)
• #getStringConversionColumn()
• #setStringConversionColumn(int)
• android.widget.CursorAdapter#convertToString(android.database.Cursor)

setStringConversionColumn

Added in API level 1

open fun setStringConversionColumn(stringConversionColumn: Int): Unit

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

See Also

• android.widget.CursorAdapter#convertToString(android.database.Cursor)
• #getStringConversionColumn()
• #setCursorToStringConverter(android.widget.SimpleCursorAdapter.CursorToStringConverter)
• #getCursorToStringConverter()

setViewBinder

Added in API level 1

open fun setViewBinder(viewBinder: SimpleCursorAdapter.ViewBinder!): Unit

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

See Also

• #bindView(android.view.View, android.content.Context, android.database.Cursor)
• #getViewBinder()

setViewImage

Added in API level 1

open fun setViewImage(
    v: ImageView!, 
    value: String!
): Unit

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 API level 1

open fun setViewText(
    v: TextView!, 
    text: String!
): Unit

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 API level 11

open fun swapCursor(c: Cursor!): Cursor!

Parameters
newCursor	The new cursor to be used.

Return
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.