Added in API level 1

BaseAdapter


abstract class BaseAdapter : ListAdapter, SpinnerAdapter
kotlin.Any
   ↳ android.widget.BaseAdapter

Common base class of common implementation for an Adapter that can be used in both ListView (by implementing the specialized ListAdapter interface) and Spinner (by implementing the specialized SpinnerAdapter interface).

Summary

Public constructors

Public methods
open Boolean

Indicates whether all the items in this adapter are enabled.

open Array<CharSequence!>?

Gets a string representation of the adapter data that can help android.service.autofill.AutofillService autofill the view backed by the adapter.

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

open Int
getItemViewType(position: Int)

Get the type of View that will be created by getView for the specified item.

open Int

Returns the number of types of Views that will be created by getView.

open Boolean

Indicates whether the item ids are stable across changes to the underlying data.

open Boolean

open Boolean
isEnabled(position: Int)

Returns true if the item at the specified position is not a separator.

open Unit

Notifies the attached observers that the underlying data has been changed and any View reflecting the data set should refresh itself.

open Unit

Notifies the attached observers that the underlying data is no longer valid or available.

open Unit

Register an observer that is called when changes happen to the data used by this adapter.

open Unit
setAutofillOptions(vararg options: CharSequence!)

Sets the value returned by getAutofillOptions()

open Unit

Unregister an observer that has previously been registered with this adapter via registerDataSetObserver.

Public constructors

BaseAdapter

BaseAdapter()

Public methods

areAllItemsEnabled

Added in API level 1
open fun areAllItemsEnabled(): Boolean

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

Return
Boolean True if all items are enabled, false otherwise.

getAutofillOptions

Added in API level 26
open fun getAutofillOptions(): Array<CharSequence!>?

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.

Return
Array<CharSequence!>? null by default, unless implementations override it.

getDropDownView

Added in API level 1
open fun getDropDownView(
    position: Int,
    convertView: View!,
    parent: ViewGroup!
): View!

Gets a android.view.View that displays in the drop down popup the data at the specified position in the data set.

Parameters
position Int: index of the item whose view we want.
convertView View!: the old view to reuse, if possible. Note: You should check that this view is non-null and of an appropriate type before using. If it is not possible to convert this view to display the correct data, this method can create a new view.
parent ViewGroup!: the parent that this view will eventually be attached to
Return
View! a android.view.View corresponding to the data at the specified position.

getItemViewType

Added in API level 1
open fun getItemViewType(position: Int): Int

Get the type of View that will be created by getView for the specified item.

Parameters
position Int: The position of the item within the adapter's data set whose view type we want.
Return
Int An integer representing the type of View. Two views should share the same type if one can be converted to the other in getView. Note: Integers must be in the range 0 to getViewTypeCount - 1. IGNORE_ITEM_VIEW_TYPE can also be returned.

getViewTypeCount

Added in API level 1
open fun getViewTypeCount(): Int

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.

Return
Int The number of types of Views that will be created by this adapter

hasStableIds

Added in API level 1
open fun hasStableIds(): Boolean

Indicates whether the item ids are stable across changes to the underlying data.

Return
Boolean True if the same id always refers to the same object.

isEmpty

Added in API level 1
open fun isEmpty(): Boolean
Return
Boolean true if this adapter doesn't contain any data. This is used to determine whether the empty view should be displayed. A typical implementation will return getCount() == 0 but since getCount() includes the headers and footers, specialized adapters might want a different behavior.

isEnabled

Added in API level 1
open fun isEnabled(position: Int): Boolean

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.

Parameters
position Int: Index of the item
Return
Boolean True if the item is not a separator

notifyDataSetChanged

Added in API level 1
open fun notifyDataSetChanged(): Unit

Notifies the attached observers that the underlying data has been changed and any View reflecting the data set should refresh itself.

notifyDataSetInvalidated

Added in API level 1
open fun notifyDataSetInvalidated(): Unit

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.

registerDataSetObserver

Added in API level 1
open fun registerDataSetObserver(observer: DataSetObserver!): Unit

Register an observer that is called when changes happen to the data used by this adapter.

Parameters
observer DataSetObserver!: the object that gets notified when the data set changes.

setAutofillOptions

Added in API level 27
open fun setAutofillOptions(vararg options: CharSequence!): Unit

Sets the value returned by getAutofillOptions()

Parameters
options CharSequence!: This value may be null.

unregisterDataSetObserver

Added in API level 1
open fun unregisterDataSetObserver(observer: DataSetObserver!): Unit

Unregister an observer that has previously been registered with this adapter via registerDataSetObserver.

Parameters
observer DataSetObserver!: the object to unregister.