Summary: Ctors | Methods | Inherited Methods

HeaderItem

Kotlin |Java

public class HeaderItem
extends Object

java.lang.Object
↳	androidx.leanback.widget.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
`HeaderItem(long id, String name)` Create a header item.
`HeaderItem(String name)` Create a header item.

Public methods
`CharSequence`	`getContentDescription()` Returns optional content description for the HeaderItem.
`CharSequence`	`getDescription()` Returns the description for the current row.
`final long`	`getId()` Returns a unique identifier for this item.
`final String`	`getName()` Returns the name of this header item.
`void`	`setContentDescription(CharSequence contentDescription)` Sets optional content description for the HeaderItem.
`void`	`setDescription(CharSequence description)` Sets the description for the current header item.

From class


        
          java.lang.Object

public HeaderItem (long id, 
                String name)

Create a header item. All fields are optional.

Parameters
`id`	`long`
`name`	`String`

public HeaderItem (String name)

Create a header item.

Parameters
`name`	`String`

public CharSequence getContentDescription ()

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.

public CharSequence getDescription ()

Returns the description for the current row.

Returns
`CharSequence`

public final long getId ()

Returns a unique identifier for this item.

Returns
`long`

public final String getName ()

Returns the name of this header item.

Returns
`String`

public void setContentDescription (CharSequence contentDescription)

Sets optional content description for the HeaderItem.

Parameters
`contentDescription`	`CharSequence`: Content description sets on the HeaderItem.

public void setDescription (CharSequence description)

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

Parameters
`description`	`CharSequence`