Added in API level 1

HeaderViewListAdapter


open class HeaderViewListAdapter : Filterable, WrapperListAdapter
kotlin.Any
   ↳ android.widget.HeaderViewListAdapter

ListAdapter used when a ListView has header views. This ListAdapter wraps another one and also keeps track of the header views and their associated data objects.

This is intended as a base class; you will probably not need to use this class directly in your own code.

Summary

Public constructors

Public methods
open Boolean

Indicates whether all the items in this adapter are enabled.

open Int

How many items are in the data set represented by this Adapter.

open Filter!

Returns a filter that can be used to constrain data with a filtering pattern.

open Int

open Int

open Any!
getItem(position: Int)

Get the data item associated with the specified position in the data set.

open Long
getItemId(position: Int)

Get the row id associated with the specified position in the list.

open Int
getItemViewType(position: Int)

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

open View!
getView(position: Int, convertView: View!, parent: ViewGroup!)

Get a View that displays the data at the specified position in the data set.

open Int

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

open ListAdapter!

Returns the adapter wrapped by this list adapter.

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

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

open Boolean

open Boolean

open Unit

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

Public constructors

HeaderViewListAdapter

Added in API level 1
HeaderViewListAdapter(
    headerViewInfos: ArrayList<ListView.FixedViewInfo!>!,
    footerViewInfos: ArrayList<ListView.FixedViewInfo!>!,
    adapter: ListAdapter!)

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.

getCount

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

How many items are in the data set represented by this Adapter.

Return
Int Count of items.

getFilter

Added in API level 1
open fun getFilter(): Filter!

Returns a filter that can be used to constrain data with a filtering pattern.

This method is usually implemented by android.widget.Adapter classes.

Return
Filter! a filter used to constrain data

getFootersCount

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

getHeadersCount

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

getItem

Added in API level 1
open fun getItem(position: Int): Any!

Get the data item associated with the specified position in the data set.

Parameters
position Int: Position of the item whose data we want within the adapter's data set.
Return
Any! The data at the specified position.

getItemId

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

Get the row id associated with the specified position in the list.

Parameters
position Int: The position of the item within the adapter's data set whose row id we want.
Return
Long The id of the item 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.

getView

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

Get a View that displays the data at the specified position in the data set. You can either create a View manually or inflate it from an XML layout file. When the View is inflated, the parent View (GridView, ListView...) will apply default layout parameters unless you use android.view.LayoutInflater#inflate(int, android.view.ViewGroup, boolean) to specify a root view and to prevent attachment to the root.

Parameters
position Int: The position of the item within the adapter's data set 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. Heterogeneous lists can specify their number of view types, so that this View is always of the right type (see getViewTypeCount() and getItemViewType(int)).
parent ViewGroup!: The parent that this view will eventually be attached to
Return
View! A View corresponding to the data at the specified position.

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

getWrappedAdapter

Added in API level 1
open fun getWrappedAdapter(): ListAdapter!

Returns the adapter wrapped by this list adapter.

Return
ListAdapter! The android.widget.ListAdapter wrapped 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

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.

removeFooter

Added in API level 1
open fun removeFooter(v: View!): Boolean

removeHeader

Added in API level 1
open fun removeHeader(v: View!): Boolean

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.