amarenkov.androidx.snappyrecyclerview

Class SnappyRecyclerView

java.lang.Object

RecyclerView

amarenkov.androidx.snappyrecyclerview.SnappyRecyclerView

All Implemented Interfaces:

SnappyAdapter.Snapper

public class SnappyRecyclerView
extends RecyclerView
implements SnappyAdapter.Snapper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnappyRecyclerView.Behavior

Constructor Summary

Constructors

Constructor and Description
SnappyRecyclerView(android.content.Context context)
SnappyRecyclerView(android.content.Context context, android.util.AttributeSet attrs)
SnappyRecyclerView(android.content.Context context, android.util.AttributeSet attrs, int defStyle)

Method Summary

Modifier and Type	Method and Description
void	enableSnapListener(SnappyRecyclerView.Behavior behavior) Enables scroll listener that will notify on snapped item change
int	getCurrentPosition()
int	getSnappedPosition()
boolean	isPaddingApplied()
boolean	notifyOnSnap()
protected void	onLayout(boolean changed, int l, int t, int r, int b)
void	resetCenteringPadding(int itemSize, int edgeMargin, int position) Resets required padding to place items in the center
void	resetCenteringPadding(android.view.View target, int position) Resets required padding to place items in the center.
void	setAdapter(Adapter adapter)
void	setCenteringPadding(int itemSize, int edgeMargin, int position) Sets required padding to place items in the center
void	setCenteringPadding(android.view.View target, int position) Sets required padding to place items in the center.
void	setCustomSnapHelper(LinearSnapHelper snapHelper)
void	setLayoutManager(LayoutManager layout)
void	smoothSnapBy(int dx, int dy) Smothly scrolls to position by pixels
void	smoothSnapToPosition(int position) Smothly scrolls to position
void	snapToPosition(int position) Instantly scrolls to position

Methods inherited from class java.lang.Object

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

Constructor Detail

SnappyRecyclerView

public SnappyRecyclerView(android.content.Context context)

SnappyRecyclerView

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

SnappyRecyclerView

public SnappyRecyclerView(android.content.Context context,
                          android.util.AttributeSet attrs,
                          int defStyle)

Method Detail

setCustomSnapHelper

public void setCustomSnapHelper(LinearSnapHelper snapHelper)

setCenteringPadding

public final void setCenteringPadding(int itemSize,
                                      int edgeMargin,
                                      int position)

Sets required padding to place items in the center

Parameters:

itemSize - height (if orientation is vertical) or weight (if orientation is horizontal) of the item

edgeMargin - edge margin (e.g. left for vertical and top for horizontal orientation) of the item

position - initial position of the centered item (usually position = 0)

resetCenteringPadding

public final void resetCenteringPadding(int itemSize,
                                        int edgeMargin,
                                        int position)

Resets required padding to place items in the center

Parameters:

itemSize - height (if orientation is vertical) or weight (if orientation is horizontal) of the item

edgeMargin - edge margin (e.g. left for vertical and top for horizontal orientation) of the item

position - initial position of the centered item (usually position = 0)

setCenteringPadding

public final void setCenteringPadding(android.view.View target,
                                      int position)

Sets required padding to place items in the center. Using view to obtain params

Parameters:

target - the view that is identical to item view

position - initial position of the centered item (usually position = 0)

resetCenteringPadding

public final void resetCenteringPadding(android.view.View target,
                                        int position)

Resets required padding to place items in the center. Using view to obtain params

Parameters:

target - the view that is identical to item view

position - initial position of the centered item (usually position = 0)

setLayoutManager

public void setLayoutManager(LayoutManager layout)

enableSnapListener

public final void enableSnapListener(SnappyRecyclerView.Behavior behavior)

Enables scroll listener that will notify on snapped item change

setAdapter

public void setAdapter(Adapter adapter)

getSnappedPosition

public int getSnappedPosition()

Specified by:

getSnappedPosition in interface SnappyAdapter.Snapper

Returns:

current snapped position (position of the center item)

getCurrentPosition

public int getCurrentPosition()

Returns:

saved current snapped position (position of the center item)

notifyOnSnap

public boolean notifyOnSnap()

Returns:

true if layout of the snapped item should be updated

smoothSnapToPosition

public void smoothSnapToPosition(int position)

Smothly scrolls to position

Specified by:

smoothSnapToPosition in interface SnappyAdapter.Snapper

Parameters:

position - position of the item that will be placed in the center

smoothSnapBy

public void smoothSnapBy(int dx,
                         int dy)

Smothly scrolls to position by pixels

Specified by:

smoothSnapBy in interface SnappyAdapter.Snapper

snapToPosition

public void snapToPosition(int position)

Instantly scrolls to position

Specified by:

snapToPosition in interface SnappyAdapter.Snapper

isPaddingApplied

public boolean isPaddingApplied()

Returns:

true if padding has been aplied and items centered

onLayout

protected void onLayout(boolean changed,
                        int l,
                        int t,
                        int r,
                        int b)