Summary: Ctors | Methods | Inherited Methods

FocusHighlightHelper

Kotlin |Java

public class FocusHighlightHelper
extends Object

java.lang.Object
↳	androidx.leanback.widget.FocusHighlightHelper

---

Sets up the highlighting behavior when an item gains focus.

Summary

Public constructors
FocusHighlightHelper() This constructor is deprecated. This type should not be instantiated as it contains only static methods.

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(VerticalGridView gridView, boolean scaleEnabled) This method is deprecated. Use setupHeaderItemFocusHighlight(ItemBridgeAdapter, boolean)
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 is deprecated. Use setupHeaderItemFocusHighlight(ItemBridgeAdapter)
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 Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

FocusHighlightHelper

public FocusHighlightHelper ()

This constructor is deprecated.
This type should not be instantiated as it contains only static methods.

Public methods

setupBrowseItemFocusHighlight

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 ListRowPresenter.ListRowPresenter(int, boolean).

Parameters
adapter	ItemBridgeAdapter: adapter of the list row.
zoomIndex	int: One of FocusHighlight.ZOOM_FACTOR_SMALL FocusHighlight.ZOOM_FACTOR_XSMALL FocusHighlight.ZOOM_FACTOR_MEDIUM FocusHighlight.ZOOM_FACTOR_LARGE FocusHighlight.ZOOM_FACTOR_NONE.
useDimmer	boolean: Allow dimming browse item when unselected.

setupHeaderItemFocusHighlight

public static void setupHeaderItemFocusHighlight (VerticalGridView gridView, 
                boolean scaleEnabled)

This method is deprecated.
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 RowHeaderPresenter.onSelectLevelChanged(RowHeaderPresenter.ViewHolder) will always be called regardless value of scaleEnabled.

setupHeaderItemFocusHighlight

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

Parameters
adapter	ItemBridgeAdapter: The adapter of HeadersFragment.

See also:

• HeadersFragment.getBridgeAdapter()

setupHeaderItemFocusHighlight

public static void setupHeaderItemFocusHighlight (VerticalGridView gridView)

This method is deprecated.
Use setupHeaderItemFocusHighlight(ItemBridgeAdapter)

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

Parameters
gridView	VerticalGridView: The header list.

setupHeaderItemFocusHighlight

public static 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 RowHeaderPresenter.onSelectLevelChanged(RowHeaderPresenter.ViewHolder) will always be called regardless value of scaleEnabled.

See also:

• HeadersFragment.getBridgeAdapter()