# FocusHighlightHelper

# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/widget/FocusHighlightHelper "View this page in Java")

<br />

```
class FocusHighlightHelper
```

<br />

*** ** * ** ***

Sets up the highlighting behavior when an item gains focus.

## Summary

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

|                                    ### Public functions                                     |
|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java-static `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setupBrowseItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupBrowseItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,int,boolean))`(` ` adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!,` ` zoomIndex: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` useDimmer: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) `)` Sets up the focus highlight behavior of a focused item in browse list row.                                                                                     |
| `java-static `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter))`(adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!)` Sets up default focus highlight behavior of a focused item in header list.                                                                                                                                                                                                                                                                                                        |
| `java-static `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | ~~[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView))~~`(gridView: `[VerticalGridView](https://developer.android.com/reference/kotlin/androidx/leanback/widget/VerticalGridView)`!)` **This function is deprecated.** Use[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter)) <br />                                                                                                                              |
| `java-static `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,boolean))`(` ` adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!,` ` scaleEnabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) `)` Sets up the focus highlight behavior of a focused item in header list.                                                                                                                                                                                       |
| `java-static `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | ~~[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView,boolean))~~`(` ` gridView: `[VerticalGridView](https://developer.android.com/reference/kotlin/androidx/leanback/widget/VerticalGridView)`!,` ` scaleEnabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) `)` **This function is deprecated.** Use[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/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)  

```
[FocusHighlightHelper](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#FocusHighlightHelper())()
```
| **This function is deprecated.**   
|
This type should not be instantiated as it contains only static methods.  

## Public functions

### setupBrowseItemFocusHighlight

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

```
java-static fun setupBrowseItemFocusHighlight(
    adapter: ItemBridgeAdapter!,
    zoomIndex: Int,
    useDimmer: Boolean
): Unit
```

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

|                                                          Parameters                                                          |
|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!` | adapter of the list row.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `zoomIndex: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                     | One of[ZOOM_FACTOR_SMALL](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_SMALL())[ZOOM_FACTOR_XSMALL](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_XSMALL())[ZOOM_FACTOR_MEDIUM](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_MEDIUM())[ZOOM_FACTOR_LARGE](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_LARGE())[ZOOM_FACTOR_NONE](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlight#ZOOM_FACTOR_NONE()). |
| `useDimmer: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                             | Allow dimming browse item when unselected.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### setupHeaderItemFocusHighlight

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

```
java-static fun setupHeaderItemFocusHighlight(adapter: ItemBridgeAdapter!): Unit
```

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

|                                                          Parameters                                                          |
|------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| `adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!` | The adapter of HeadersFragment. |

|                                                          See also                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|---|
| [getBridgeAdapter](https://developer.android.com/reference/kotlin/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)  

```
java-static fun [setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView))(gridView: VerticalGridView!): Unit
```
| **This function is deprecated.**   
|
| Use[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/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[onSelectLevelChanged](https://developer.android.com/reference/kotlin/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder)). Equivalent to call setupHeaderItemFocusHighlight(gridView, true).  

|                                                         Parameters                                                          |
|-----------------------------------------------------------------------------------------------------------------------------|------------------|
| `gridView: `[VerticalGridView](https://developer.android.com/reference/kotlin/androidx/leanback/widget/VerticalGridView)`!` | The header list. |

### setupHeaderItemFocusHighlight

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

```
java-static fun setupHeaderItemFocusHighlight(
    adapter: ItemBridgeAdapter!,
    scaleEnabled: Boolean
): Unit
```

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

|                                                          Parameters                                                          |
|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `adapter: `[ItemBridgeAdapter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/ItemBridgeAdapter)`!` | The adapter of HeadersFragment.                                                                                                                                                                                                                                                                                       |
| `scaleEnabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                          | True if scale the item when focused, false otherwise. Note that[onSelectLevelChanged](https://developer.android.com/reference/kotlin/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder))will always be called regardless value of scaleEnabled. |

|                                                          See also                                                           |
|-----------------------------------------------------------------------------------------------------------------------------|---|
| [getBridgeAdapter](https://developer.android.com/reference/kotlin/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)  

```
java-static fun [setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.VerticalGridView,boolean))(
    gridView: VerticalGridView!,
    scaleEnabled: Boolean
): Unit
```
| **This function is deprecated.**   
|
| Use[setupHeaderItemFocusHighlight](https://developer.android.com/reference/kotlin/androidx/leanback/widget/FocusHighlightHelper#setupHeaderItemFocusHighlight(androidx.leanback.widget.ItemBridgeAdapter,boolean))

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

|                                                         Parameters                                                          |
|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `gridView: `[VerticalGridView](https://developer.android.com/reference/kotlin/androidx/leanback/widget/VerticalGridView)`!` | The header list.                                                                                                                                                                                                                                                                                                      |
| `scaleEnabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                         | True if scale the item when focused, false otherwise. Note that[onSelectLevelChanged](https://developer.android.com/reference/kotlin/androidx/leanback/widget/RowHeaderPresenter#onSelectLevelChanged(androidx.leanback.widget.RowHeaderPresenter.ViewHolder))will always be called regardless value of scaleEnabled. |