# HeaderItem

Artifact: [androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/widget/HeaderItem.java+class:androidx.leanback.widget.HeaderItem) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***


```
public class HeaderItem
```

<br />

*** ** * ** ***

A header item describes the metadata of a `https://developer.android.com/reference/androidx/leanback/widget/Row`, such as a category of media items. May be subclassed to add more information.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#HeaderItem(java.lang.String)(https://developer.android.com/reference/java/lang/String.html name)` Create a header item. |
| `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#HeaderItem(long,java.lang.String)(long id, https://developer.android.com/reference/java/lang/String.html name)` Create a header item. |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#getContentDescription()()` Returns optional content description for the HeaderItem. |
| `https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#getDescription()()` Returns the description for the current row. |
| `final long` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#getId()()` Returns a unique identifier for this item. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#getName()()` Returns the name of this header item. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#setContentDescription(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence.html contentDescription)` Sets optional content description for the HeaderItem. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#setDescription(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence.html description)` Sets the description for the current header item. |

## Public constructors

### HeaderItem

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public HeaderItem(String name)
```

Create a header item.

### HeaderItem

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public HeaderItem(long id, String name)
```

Create a header item. All fields are optional.

## Public methods

### getContentDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public CharSequence getContentDescription()
```

Returns optional content description for the HeaderItem. When it is null, `https://developer.android.com/reference/androidx/leanback/widget/HeaderItem#getName()` should be used for the content description.

| Returns |
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence.html` | Content description for the HeaderItem. |

### getDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public CharSequence getDescription()
```

Returns the description for the current row.

### getId

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public final long getId()
```

Returns a unique identifier for this item.

### getName

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public final String getName()
```

Returns the name of this header item.

### setContentDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public void setContentDescription(CharSequence contentDescription)
```

Sets optional content description for the HeaderItem.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence.html contentDescription` | Content description sets on the HeaderItem. |

### setDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public void setDescription(CharSequence description)
```

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