eu.davidea.fastscroller

Class FastScroller.Delegate

java.lang.Object

eu.davidea.fastscroller.FastScroller.Delegate

Enclosing class:

FastScroller

public static class FastScroller.Delegate
extends java.lang.Object

This class links the FastScroller to the RecyclerView. To use FastScroller in your existing adapter (Not FlexibleAdapter), follow the steps below:

1. In your layout, include @layout/fast_scroller after the RecyclerView.
2. Implement FastScroller.AdapterInterface in your adapter.
3. In your adapter, create a FastScroller.Delegate and call the delegate methods: onAttachedToRecyclerView, onDetachedFromRecyclerView and setFastScroller.
4. If fastScrollerBubbleEnabled is true, in your adapter, implement BubbleTextCreator and add the logic to display the label in onCreateBubbleText.
5. In the fragment/activity call the adapter's setFastScroller after setting the RecyclerView's adapter.

Constructor Summary

Constructors

Constructor and Description
Delegate()

Method Summary

Modifier and Type	Method and Description
FastScroller	getFastScroller()
boolean	isFastScrollerEnabled()
void	onAttachedToRecyclerView(RecyclerView recyclerView)
void	onDetachedFromRecyclerView(RecyclerView recyclerView)
void	setFastScroller(FastScroller fastScroller) Sets up the FastScroller with automatic fetch of accent color.
void	toggleFastScroller() Displays or Hides the FastScroller if previously configured.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Delegate

public Delegate()

Method Detail

onAttachedToRecyclerView

public void onAttachedToRecyclerView(RecyclerView recyclerView)

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(RecyclerView recyclerView)

toggleFastScroller

public void toggleFastScroller()

Displays or Hides the FastScroller if previously configured.
The action is animated.

Since:

5.0.0-b1

See Also:

setFastScroller(FastScroller)

isFastScrollerEnabled

public boolean isFastScrollerEnabled()

Returns:

true if FastScroller is configured and shown, false otherwise

Since:

5.0.0-b1

getFastScroller

public FastScroller getFastScroller()

Returns:

the current instance of the FastScroller object

Since:

5.0.0-b1

setFastScroller

public void setFastScroller(FastScroller fastScroller)

Sets up the FastScroller with automatic fetch of accent color.

IMPORTANT: Call this method after the adapter is added to the RecyclerView.

NOTE: If the device has at least Lollipop, the Accent color is fetched, otherwise for previous version, the default value is used.

Parameters:

fastScroller - instance of FastScroller

Since:

5.0.0-b6