com.simplecityapps.recyclerview_fastscroll.views

Class FastScrollRecyclerView

java.lang.Object

RecyclerView

com.simplecityapps.recyclerview_fastscroll.views.FastScrollRecyclerView

public class FastScrollRecyclerView
extends RecyclerView

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FastScrollRecyclerView.MeasurableAdapter<VH extends ViewHolder> FastScrollRecyclerView by default assumes that all items in a RecyclerView will have ItemViews with the same heights so that the total height of all views in the RecyclerView can be calculated.
static class	FastScrollRecyclerView.ScrollPositionState The current scroll state of the recycler view.
static interface	FastScrollRecyclerView.SectionedAdapter

Constructor Summary

Constructors

Constructor and Description
FastScrollRecyclerView(android.content.Context context)
FastScrollRecyclerView(android.content.Context context, android.util.AttributeSet attrs)
FastScrollRecyclerView(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
void	allowThumbInactiveColor(boolean allowInactiveColor)
void	draw(android.graphics.Canvas c)
protected int	getAvailableScrollBarHeight() Returns the available scroll bar height: AvailableScrollBarHeight = Total height of the visible view - thumb height
protected int	getAvailableScrollHeight(int adapterHeight, int yOffset) Returns the available scroll height: AvailableScrollHeight = Total height of the all items - last page height
int	getScrollBarThumbHeight()
int	getScrollBarWidth()
protected boolean	isLayoutManagerReversed()
protected void	onFinishInflate()
boolean	onInterceptTouchEvent(RecyclerView rv, android.view.MotionEvent ev) We intercept the touch handling only to support fast scrolling when initiated from the scroll bar.
void	onRequestDisallowInterceptTouchEvent(boolean disallowIntercept)
void	onTouchEvent(RecyclerView rv, android.view.MotionEvent ev)
void	onUpdateScrollbar() Updates the bounds for the scrollbar.
java.lang.String	scrollToPositionAtProgress(float touchFraction) Maps the touch (from 0..1) to the adapter position that should be visible.
void	setAdapter(Adapter adapter)
void	setAutoHideDelay(int hideDelay)
void	setAutoHideEnabled(boolean autoHideEnabled)
void	setFastScrollEnabled(boolean fastScrollEnabled)
void	setOnFastScrollStateChangeListener(OnFastScrollStateChangeListener stateChangeListener)
void	setPopupBgColor(int color)
void	setPopupPosition(int popupPosition) Set the FastScroll Popup position.
void	setPopupTextColor(int color)
void	setPopupTextSize(int textSize)
void	setPopUpTypeface(android.graphics.Typeface typeface)
void	setStateChangeListener(OnFastScrollStateChangeListener stateChangeListener) Deprecated.
void	setThumbColor(int color)
void	setThumbEnabled(boolean thumbEnabled) Deprecated.
void	setThumbInactiveColor(boolean allowInactiveColor) Deprecated.
void	setThumbInactiveColor(int color)
void	setTrackColor(int color)
void	showScrollbar()
protected void	updateThumbPosition(FastScrollRecyclerView.ScrollPositionState scrollPosState, int rowCount) Updates the scrollbar thumb offset to match the visible scroll of the recycler view.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastScrollRecyclerView

public FastScrollRecyclerView(android.content.Context context)

FastScrollRecyclerView

public FastScrollRecyclerView(android.content.Context context,
                              android.util.AttributeSet attrs)

FastScrollRecyclerView

public FastScrollRecyclerView(android.content.Context context,
                              android.util.AttributeSet attrs,
                              int defStyleAttr)

Method Detail

getScrollBarWidth

public int getScrollBarWidth()

getScrollBarThumbHeight

public int getScrollBarThumbHeight()

onFinishInflate

protected void onFinishInflate()

setAdapter

public void setAdapter(Adapter adapter)

onInterceptTouchEvent

public boolean onInterceptTouchEvent(RecyclerView rv,
                                     android.view.MotionEvent ev)

We intercept the touch handling only to support fast scrolling when initiated from the scroll bar. Otherwise, we fall back to the default RecyclerView touch handling.

onTouchEvent

public void onTouchEvent(RecyclerView rv,
                         android.view.MotionEvent ev)

onRequestDisallowInterceptTouchEvent

public void onRequestDisallowInterceptTouchEvent(boolean disallowIntercept)

getAvailableScrollHeight

protected int getAvailableScrollHeight(int adapterHeight,
                                       int yOffset)

Returns the available scroll height: AvailableScrollHeight = Total height of the all items - last page height

Parameters:

yOffset - the offset from the top of the recycler view to start tracking.

getAvailableScrollBarHeight

protected int getAvailableScrollBarHeight()

Returns the available scroll bar height: AvailableScrollBarHeight = Total height of the visible view - thumb height

draw

public void draw(android.graphics.Canvas c)

updateThumbPosition

protected void updateThumbPosition(FastScrollRecyclerView.ScrollPositionState scrollPosState,
                                   int rowCount)

Updates the scrollbar thumb offset to match the visible scroll of the recycler view. It does this by mapping the available scroll area of the recycler view to the available space for the scroll bar.

Parameters:

scrollPosState - the current scroll position

rowCount - the number of rows, used to calculate the total scroll height (assumes that

scrollToPositionAtProgress

public java.lang.String scrollToPositionAtProgress(float touchFraction)

Maps the touch (from 0..1) to the adapter position that should be visible.

onUpdateScrollbar

public void onUpdateScrollbar()

Updates the bounds for the scrollbar.

isLayoutManagerReversed

protected boolean isLayoutManagerReversed()

showScrollbar

public void showScrollbar()

setThumbColor

public void setThumbColor(int color)

setTrackColor

public void setTrackColor(int color)

setPopupBgColor

public void setPopupBgColor(int color)

setPopupTextColor

public void setPopupTextColor(int color)

setPopupTextSize

public void setPopupTextSize(int textSize)

setPopUpTypeface

public void setPopUpTypeface(android.graphics.Typeface typeface)

setAutoHideDelay

public void setAutoHideDelay(int hideDelay)

setAutoHideEnabled

public void setAutoHideEnabled(boolean autoHideEnabled)

setOnFastScrollStateChangeListener

public void setOnFastScrollStateChangeListener(OnFastScrollStateChangeListener stateChangeListener)

setStateChangeListener

@Deprecated
public void setStateChangeListener(OnFastScrollStateChangeListener stateChangeListener)

Deprecated.

setThumbInactiveColor

public void setThumbInactiveColor(int color)

allowThumbInactiveColor

public void allowThumbInactiveColor(boolean allowInactiveColor)

setThumbInactiveColor

@Deprecated
public void setThumbInactiveColor(boolean allowInactiveColor)

Deprecated.

setFastScrollEnabled

public void setFastScrollEnabled(boolean fastScrollEnabled)

setThumbEnabled

@Deprecated
public void setThumbEnabled(boolean thumbEnabled)

Deprecated.

setPopupPosition

public void setPopupPosition(int popupPosition)

Set the FastScroll Popup position. This is either FastScroller.PopupPosition.ADJACENT, meaning the popup moves adjacent to the FastScroll thumb, or FastScroller.PopupPosition.CENTER, meaning the popup is static and centered within the RecyclerView.