HeaderItem

class HeaderItem


A header item describes the metadata of a Row, such as a category of media items. May be subclassed to add more information.

Summary

Public constructors

Create a header item.

HeaderItem(id: Long, name: String!)

Create a header item.

Public functions

CharSequence!

Returns optional content description for the HeaderItem.

CharSequence!

Returns the description for the current row.

Long

Returns a unique identifier for this item.

String!

Returns the name of this header item.

Unit
setContentDescription(contentDescription: CharSequence!)

Sets optional content description for the HeaderItem.

Unit

Sets the description for the current header item.

Public constructors

HeaderItem

Added in 1.1.0
HeaderItem(name: String!)

Create a header item.

HeaderItem

Added in 1.1.0
HeaderItem(id: Long, name: String!)

Create a header item. All fields are optional.

Public functions

getContentDescription

Added in 1.1.0
fun getContentDescription(): CharSequence!

Returns optional content description for the HeaderItem. When it is null, getName should be used for the content description.

Returns
CharSequence!

Content description for the HeaderItem.

getDescription

Added in 1.1.0
fun getDescription(): CharSequence!

Returns the description for the current row.

getId

Added in 1.1.0
fun getId(): Long

Returns a unique identifier for this item.

getName

Added in 1.1.0
fun getName(): String!

Returns the name of this header item.

setContentDescription

Added in 1.1.0
fun setContentDescription(contentDescription: CharSequence!): Unit

Sets optional content description for the HeaderItem.

Parameters
contentDescription: CharSequence!

Content description sets on the HeaderItem.

setDescription

Added in 1.1.0
fun setDescription(description: CharSequence!): Unit

Sets the description for the current header item. This will be visible when the row receives focus.