# FocusHighlightHelper

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

*** ** * ** ***


```
public class FocusHighlightHelper
```

<br />

*** ** * ** ***

Sets up the highlighting behavior when an item gains focus.

## Summary

| ### Public constructors |
|---|
| `[FocusHighlightHelper](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#FocusHighlightHelper())()` **This method is deprecated.** This type should not be instantiated as it contains only static methods. <br /> |

| ### Public methods |
|---|---|
| `static void` | `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupBrowseItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,int,boolean)( https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter, int zoomIndex, boolean useDimmer )` Sets up the focus highlight behavior of a focused item in browse list row. |
| `static void` | `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter)(https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter)` Sets up default focus highlight behavior of a focused item in header list. |
| `static void` | `[setupHeaderItemFocusHighlight](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView))(https://developer.android.com/reference/androidx/leanback/widget/VerticalGridView gridView)` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter)` <br /> |
| `static void` | `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,boolean)( https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter, boolean scaleEnabled )` Sets up the focus highlight behavior of a focused item in header list. |
| `static void` | `[setupHeaderItemFocusHighlight](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView,boolean))( https://developer.android.com/reference/androidx/leanback/widget/VerticalGridView gridView, boolean scaleEnabled )` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,boolean)` <br /> |

## Public constructors

### FocusHighlightHelper

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

```
public [FocusHighlightHelper](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#FocusHighlightHelper())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> This type should not be instantiated as it contains only static methods.

## Public methods

### setupBrowseItemFocusHighlight

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

```
public static void setupBrowseItemFocusHighlight(
    ItemBridgeAdapter adapter,
    int zoomIndex,
    boolean useDimmer
)
```

Sets up the focus highlight behavior of a focused item in browse list row. App usually does not call this method, it uses `https://developer.android.com/reference/androidx/leanback/widget/ListRowPresenter#ListRowPresenter(int,boolean)`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter` | adapter of the list row. |
| `int zoomIndex` | One of `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_SMALL()``https://developer.android.com/reference/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_XSMALL()``https://developer.android.com/reference/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_MEDIUM()``https://developer.android.com/reference/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_LARGE()``https://developer.android.com/reference/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_NONE()`. |
| `boolean useDimmer` | Allow dimming browse item when unselected. |

### setupHeaderItemFocusHighlight

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

```
public static void setupHeaderItemFocusHighlight(ItemBridgeAdapter adapter)
```

Sets up default focus highlight behavior of a focused item in header list. It would scale the focused item and update `https://developer.android.com/reference/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder)`. Equivalent to call setupHeaderItemFocusHighlight(itemBridgeAdapter, true).

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter` | The adapter of HeadersFragment. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/app/BaseRowFragment#getBridgeAdapter()` |   |

### setupHeaderItemFocusHighlight

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

```
public static void [setupHeaderItemFocusHighlight](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView))(VerticalGridView gridView)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter)`

Sets up default focus highlight behavior of a focused item in header list. It would scale the focused item and update `https://developer.android.com/reference/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder)`. Equivalent to call setupHeaderItemFocusHighlight(gridView, true).

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/VerticalGridView gridView` | The header list. |

### setupHeaderItemFocusHighlight

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

```
public static void setupHeaderItemFocusHighlight(
    ItemBridgeAdapter adapter,
    boolean scaleEnabled
)
```

Sets up the focus highlight behavior of a focused item in header list.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/ItemBridgeAdapter adapter` | The adapter of HeadersFragment. |
| `boolean scaleEnabled` | True if scale the item when focused, false otherwise. Note that `https://developer.android.com/reference/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder)` will always be called regardless value of scaleEnabled. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/app/BaseRowFragment#getBridgeAdapter()` |   |

### setupHeaderItemFocusHighlight

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

```
public static void [setupHeaderItemFocusHighlight](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView,boolean))(
    VerticalGridView gridView,
    boolean scaleEnabled
)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,boolean)`

Sets up the focus highlight behavior of a focused item in header list.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/VerticalGridView gridView` | The header list. |
| `boolean scaleEnabled` | True if scale the item when focused, false otherwise. Note that `https://developer.android.com/reference/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder)` will always be called regardless value of scaleEnabled. |