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(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. 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(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!)` Swap in a new Cursor, returning the old Cursor.

Inherited functions

From class BaseAdapter

`Boolean`	`areAllItemsEnabled()` Indicates whether all the items in this adapter are enabled. If the value returned by this method changes over time, there is no guarantee it will take effect. If true, it means all items are selectable and clickable (there is no separator.)
`Array<CharSequence!>?`	`getAutofillOptions()` Gets a string representation of the adapter data that can help `android.service.autofill.AutofillService` autofill the view backed by the adapter. It should only be set (i.e., non-`null` if the values do not represent PII (Personally Identifiable Information - sensitive data such as email addresses, credit card numbers, passwords, etc...). For example, it's ok to return a list of month names, but not a list of usernames. A good rule of thumb is that if the adapter data comes from static resources, such data is not PII - see `android.view.ViewStructure#setDataIsSensitive(boolean)` for more info.
`Int`	`getItemViewType(position: Int)` Get the type of View that will be created by `getView` for the specified item.
`Int`	`getViewTypeCount()` Returns the number of types of Views that will be created by `getView`. Each type represents a set of views that can be converted in `getView`. If the adapter always returns the same type of View for all items, this method should return 1. This method will only be called when the adapter is set on the `AdapterView`.
`Boolean`	`isEmpty()`
`Boolean`	`isEnabled(position: Int)` Returns true if the item at the specified position is not a separator. (A separator is a non-selectable, non-clickable item). The result is unspecified if position is invalid. An `ArrayIndexOutOfBoundsException` should be thrown in that case for fast failure.
`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!)` Register an observer that is called when changes happen to the data used by this adapter.
`Unit`	`setAutofillOptions(vararg options: CharSequence!)` Sets the value returned by `getAutofillOptions()`
`Unit`	`unregisterDataSetObserver(observer: DataSetObserver!)` Unregister an observer that has previously been registered with this adapter via `registerDataSetObserver`.

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!)` Gets a `android.view.View` that displays in the drop down popup the data at the specified position in the data set.
`Resources.Theme?`	`getDropDownViewTheme()` Returns the value previously set by a call to `setDropDownViewTheme(Theme)`.
`Filter!`	`getFilter()` Returns a filter that can be used to constrain data with a filtering pattern. This method is usually implemented by `android.widget.Adapter` classes.
`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()` Indicates whether the item ids are stable across changes to the underlying data.
`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(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(Cursor)`, the returned old Cursor is not closed.

From class ResourceCursorAdapter

`View!`	`newDropDownView(context: Context!, cursor: Cursor!, parent: ViewGroup!)` Makes a new drop down view to hold the data pointed to by cursor.
`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