com.ashokvarma.bottomnavigation.behaviour

Class VerticalScrollingBehavior<V extends android.view.View>

java.lang.Object

<any>

com.ashokvarma.bottomnavigation.behaviour.VerticalScrollingBehavior<V>

Direct Known Subclasses:

BottomVerticalScrollBehavior

public abstract class VerticalScrollingBehavior<V extends android.view.View>
extends <any>

Class description

Since:

25 Mar 2016

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VerticalScrollingBehavior.ScrollDirection

Constructor Summary

Constructors

Constructor and Description
VerticalScrollingBehavior()
VerticalScrollingBehavior(android.content.Context context, android.util.AttributeSet attrs)

Method Summary

Modifier and Type	Method and Description
int	getConsumedScrollDirection()
int	getPreScrollDirection()
int	getScrollDirection()
protected abstract boolean	onNestedDirectionFling(CoordinatorLayout coordinatorLayout, V child, android.view.View target, float velocityX, float velocityY, boolean consumed, int scrollDirection)
boolean	onNestedFling(CoordinatorLayout coordinatorLayout, V child, android.view.View target, float velocityX, float velocityY, boolean consumed)
void	onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, android.view.View target, int dx, int dy, int[] consumed)
void	onNestedScroll(CoordinatorLayout coordinatorLayout, V child, android.view.View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed)
abstract void	onNestedVerticalPreScroll(CoordinatorLayout coordinatorLayout, V child, android.view.View target, int dx, int dy, int[] consumed, int scrollDirection)
abstract void	onNestedVerticalScrollConsumed(CoordinatorLayout coordinatorLayout, V child, int scrollDirection, int currentOverScroll, int totalConsumedScroll)
abstract void	onNestedVerticalScrollUnconsumed(CoordinatorLayout coordinatorLayout, V child, int scrollDirection, int currentOverScroll, int totalScroll)
boolean	onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, android.view.View directTargetChild, android.view.View target, int nestedScrollAxes)

Methods inherited from class java.lang.Object

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

Constructor Detail

VerticalScrollingBehavior

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

VerticalScrollingBehavior

public VerticalScrollingBehavior()

Method Detail

getScrollDirection

public int getScrollDirection()

Returns:

Scroll direction: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN, SCROLL_NONE

getConsumedScrollDirection

public int getConsumedScrollDirection()

Returns:

ConsumedScroll direction: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN, SCROLL_NONE

getPreScrollDirection

public int getPreScrollDirection()

Returns:

PreScroll direction: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN, SCROLL_NONE

onStartNestedScroll

public boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout,
                                   V child,
                                   android.view.View directTargetChild,
                                   android.view.View target,
                                   int nestedScrollAxes)

onNestedScroll

public void onNestedScroll(CoordinatorLayout coordinatorLayout,
                           V child,
                           android.view.View target,
                           int dxConsumed,
                           int dyConsumed,
                           int dxUnconsumed,
                           int dyUnconsumed)

onNestedPreScroll

public void onNestedPreScroll(CoordinatorLayout coordinatorLayout,
                              V child,
                              android.view.View target,
                              int dx,
                              int dy,
                              int[] consumed)

onNestedFling

public boolean onNestedFling(CoordinatorLayout coordinatorLayout,
                             V child,
                             android.view.View target,
                             float velocityX,
                             float velocityY,
                             boolean consumed)

onNestedVerticalScrollUnconsumed

public abstract void onNestedVerticalScrollUnconsumed(CoordinatorLayout coordinatorLayout,
                                                      V child,
                                                      int scrollDirection,
                                                      int currentOverScroll,
                                                      int totalScroll)

Parameters:

coordinatorLayout - the CoordinatorLayout parent of the view this Behavior is associated with

child - the child view of the CoordinatorLayout this Behavior is associated with

scrollDirection - Direction of the scroll: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN

currentOverScroll - Unconsumed value, negative or positive based on the direction;

totalScroll - Cumulative value for current direction (Unconsumed)

onNestedVerticalScrollConsumed

public abstract void onNestedVerticalScrollConsumed(CoordinatorLayout coordinatorLayout,
                                                    V child,
                                                    int scrollDirection,
                                                    int currentOverScroll,
                                                    int totalConsumedScroll)

Parameters:

coordinatorLayout - the CoordinatorLayout parent of the view this Behavior is associated with

child - the child view of the CoordinatorLayout this Behavior is associated with

scrollDirection - Direction of the scroll: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN

currentOverScroll - Unconsumed value, negative or positive based on the direction;

totalConsumedScroll - Cumulative value for current direction (Unconsumed)

onNestedVerticalPreScroll

public abstract void onNestedVerticalPreScroll(CoordinatorLayout coordinatorLayout,
                                               V child,
                                               android.view.View target,
                                               int dx,
                                               int dy,
                                               int[] consumed,
                                               int scrollDirection)

Parameters:

coordinatorLayout - the CoordinatorLayout parent of the view this Behavior is associated with

child - the child view of the CoordinatorLayout this Behavior is associated with

target - the descendant view of the CoordinatorLayout performing the nested scroll

dx - the raw horizontal number of pixels that the user attempted to scroll

dy - the raw vertical number of pixels that the user attempted to scroll

consumed - out parameter. consumed[0] should be set to the distance of dx that was consumed, consumed[1] should be set to the distance of dy that was consumed

scrollDirection - Direction of the scroll: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN

onNestedDirectionFling

protected abstract boolean onNestedDirectionFling(CoordinatorLayout coordinatorLayout,
                                                  V child,
                                                  android.view.View target,
                                                  float velocityX,
                                                  float velocityY,
                                                  boolean consumed,
                                                  int scrollDirection)

Parameters:

coordinatorLayout - the CoordinatorLayout parent of the view this Behavior is associated with

child - the child view of the CoordinatorLayout this Behavior is associated with

target - the descendant view of the CoordinatorLayout performing the nested scroll

velocityX - horizontal velocity of the attempted fling

velocityY - vertical velocity of the attempted fling

consumed - true if the nested child view consumed the fling

scrollDirection - Direction of the scroll: SCROLL_DIRECTION_UP, SCROLL_DIRECTION_DOWN

Returns:

true if the Behavior consumed the fling