Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

FocusHighlightHelper

public class FocusHighlightHelper
extends Object

java.lang.Object
   ↳ android.support.v17.leanback.widget.FocusHighlightHelper


Sets up the highlighting behavior when an item gains focus.

Summary

Public constructors

FocusHighlightHelper()

Public methods

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

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

static void setupHeaderItemFocusHighlight(ItemBridgeAdapter adapter)

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

static void setupHeaderItemFocusHighlight(VerticalGridView gridView)

This method was deprecated in API level 26.1.0. Use setupHeaderItemFocusHighlight(ItemBridgeAdapter)

static void setupHeaderItemFocusHighlight(VerticalGridView gridView, boolean scaleEnabled)

This method was deprecated in API level 26.1.0. Use setupHeaderItemFocusHighlight(ItemBridgeAdapter, boolean)

static void setupHeaderItemFocusHighlight(ItemBridgeAdapter adapter, boolean scaleEnabled)

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

Inherited methods

From class java.lang.Object

Public constructors

FocusHighlightHelper

added in version 22.1.0
FocusHighlightHelper ()

Public methods

setupBrowseItemFocusHighlight

added in version 22.1.0
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 ListRowPresenter(int, boolean).

Parameters
adapter ItemBridgeAdapter: adapter of the list row.

zoomIndex int: One of ZOOM_FACTOR_SMALL ZOOM_FACTOR_XSMALL ZOOM_FACTOR_MEDIUM ZOOM_FACTOR_LARGE ZOOM_FACTOR_NONE.

useDimmer boolean: Allow dimming browse item when unselected.

setupHeaderItemFocusHighlight

added in version 26.1.0
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 onSelectLevelChanged(RowHeaderPresenter.ViewHolder). Equivalent to call setupHeaderItemFocusHighlight(itemBridgeAdapter, true).

Parameters
adapter ItemBridgeAdapter: The adapter of HeadersFragment.

setupHeaderItemFocusHighlight

added in version 22.1.0
void setupHeaderItemFocusHighlight (VerticalGridView gridView)

This method was deprecated in API level 26.1.0.
Use setupHeaderItemFocusHighlight(ItemBridgeAdapter)

Sets up default focus highlight behavior of a focused item in header list. It would scale the focused item and update onSelectLevelChanged(RowHeaderPresenter.ViewHolder). Equivalent to call setupHeaderItemFocusHighlight(gridView, true).

Parameters
gridView VerticalGridView: The header list.

setupHeaderItemFocusHighlight

added in version 25.4.0
void setupHeaderItemFocusHighlight (VerticalGridView gridView, 
                boolean scaleEnabled)

This method was deprecated in API level 26.1.0.
Use setupHeaderItemFocusHighlight(ItemBridgeAdapter, boolean)

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

Parameters
gridView VerticalGridView: The header list.

scaleEnabled boolean: True if scale the item when focused, false otherwise. Note that onSelectLevelChanged(RowHeaderPresenter.ViewHolder) will always be called regardless value of scaleEnabled.

setupHeaderItemFocusHighlight

added in version 26.1.0
void setupHeaderItemFocusHighlight (ItemBridgeAdapter adapter, 
                boolean scaleEnabled)

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

Parameters
adapter ItemBridgeAdapter: The adapter of HeadersFragment.

scaleEnabled boolean: True if scale the item when focused, false otherwise. Note that onSelectLevelChanged(RowHeaderPresenter.ViewHolder) will always be called regardless value of scaleEnabled.