AsyncListUtil.ViewCallback

Artifact: androidx.recyclerview:recyclerview

Added in 1.0.0

Kotlin |Java

public abstract class AsyncListUtil.ViewCallback

The callback that links AsyncListUtil with the list view.

All methods are called on the main thread.

Summary

Constants
`static final int`	`HINT_SCROLL_ASC = 2` Scrolling in ascending order (from lower to higher positions in the order of the backing storage).
`static final int`	`HINT_SCROLL_DESC = 1` Scrolling in descending order (from higher to lower positions in the order of the backing storage).
`static final int`	`HINT_SCROLL_NONE = 0` No scroll direction hint available.

Public constructors
`ViewCallback()`

Public methods
`void`	`@UiThread extendRangeInto( @NonNull int[] range, @NonNull int[] outRange, int scrollHint )` Compute a wider range of items that will be loaded for smoother scrolling.
`abstract void`	`@UiThread getItemRangeInto(@NonNull int[] outRange)` Compute the range of visible item positions.
`abstract void`	`@UiThread onDataRefresh()` Called when the entire data set has changed.
`abstract void`	`@UiThread onItemLoaded(int position)` Called when an item at the given position is loaded.

Constants

HINT_SCROLL_ASC

Added in 1.0.0

public static final int HINT_SCROLL_ASC = 2

Scrolling in ascending order (from lower to higher positions in the order of the backing storage).

HINT_SCROLL_DESC

Added in 1.0.0

public static final int HINT_SCROLL_DESC = 1

Scrolling in descending order (from higher to lower positions in the order of the backing storage).

HINT_SCROLL_NONE

Added in 1.0.0

public static final int HINT_SCROLL_NONE = 0

No scroll direction hint available.

Public constructors

ViewCallback

Added in 1.0.0

public ViewCallback()

Public methods

extendRangeInto

Added in 1.0.0

@UiThread
public void extendRangeInto(
    @NonNull int[] range,
    @NonNull int[] outRange,
    int scrollHint
)

Compute a wider range of items that will be loaded for smoother scrolling.

If there is no scroll hint, the default implementation extends the visible range by half its length in both directions. If there is a scroll hint, the range is extended by its full length in the scroll direction, and by half in the other direction.

For example, if range is {100, 200} and scrollHint is HINT_SCROLL_ASC, then outRange will be {50, 300}.

However, if scrollHint is HINT_SCROLL_NONE, then outRange will be {50, 250}

Parameters
`@NonNull int[] range`	Visible item range.
`@NonNull int[] outRange`	Extended range.
`int scrollHint`	The scroll direction hint.

getItemRangeInto

Added in 1.0.0

@UiThread
public abstract void getItemRangeInto(@NonNull int[] outRange)

Compute the range of visible item positions.

outRange[0] is the position of the first visible item (in the order of the backing storage).

outRange[1] is the position of the last visible item (in the order of the backing storage).

Negative positions and positions greater or equal to getItemCount are invalid. If the returned range contains invalid positions it is ignored (no item will be loaded).

Parameters
`@NonNull int[] outRange`	The visible item range.

onDataRefresh

Added in 1.0.0

@UiThread
public abstract void onDataRefresh()

Called when the entire data set has changed.

onItemLoaded

Added in 1.0.0

@UiThread
public abstract void onItemLoaded(int position)

Called when an item at the given position is loaded.

Parameters
`int position`	Item position.