FocusHighlightHelper

class FocusHighlightHelper


Sets up the highlighting behavior when an item gains focus.

Summary

Public constructors

This function is deprecated.

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

Public functions

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

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

java-static Unit

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

java-static Unit

This function is deprecated.

Use setupHeaderItemFocusHighlight

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

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

java-static Unit
setupHeaderItemFocusHighlight(
    gridView: VerticalGridView!,
    scaleEnabled: Boolean
)

This function is deprecated.

Use setupHeaderItemFocusHighlight

Public constructors

FocusHighlightHelper

Added in 1.1.0
Deprecated in 1.1.0
FocusHighlightHelper()

Public functions

setupBrowseItemFocusHighlight

Added in 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.

Parameters
adapter: ItemBridgeAdapter!

adapter of the list row.

zoomIndex: Int

One of ZOOM_FACTOR_SMALLZOOM_FACTOR_XSMALLZOOM_FACTOR_MEDIUMZOOM_FACTOR_LARGEZOOM_FACTOR_NONE.

useDimmer: Boolean

Allow dimming browse item when unselected.

setupHeaderItemFocusHighlight

Added in 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. Equivalent to call setupHeaderItemFocusHighlight(itemBridgeAdapter, true).

Parameters
adapter: ItemBridgeAdapter!

The adapter of HeadersFragment.

See also
getBridgeAdapter

setupHeaderItemFocusHighlight

Added in 1.1.0
Deprecated in 1.1.0
java-static fun setupHeaderItemFocusHighlight(gridView: VerticalGridView!): Unit

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

Parameters
gridView: VerticalGridView!

The header list.

setupHeaderItemFocusHighlight

Added in 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!

The adapter of HeadersFragment.

scaleEnabled: Boolean

True if scale the item when focused, false otherwise. Note that onSelectLevelChanged will always be called regardless value of scaleEnabled.

See also
getBridgeAdapter

setupHeaderItemFocusHighlight

Added in 1.1.0
Deprecated in 1.1.0
java-static fun setupHeaderItemFocusHighlight(
    gridView: VerticalGridView!,
    scaleEnabled: Boolean
): Unit

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 will always be called regardless value of scaleEnabled.