HideBottomViewOnScrollBehavior
public
class
HideBottomViewOnScrollBehavior
extends Behavior<V extends View>
java.lang.Object | ||
↳ | androidx.coordinatorlayout.widget.CoordinatorLayout.Behavior<V extends android.view.View> | |
↳ | com.google.android.material.behavior.HideBottomViewOnScrollBehavior<V extends android.view.View> |
The CoordinatorLayout.Behavior
for a View within a CoordinatorLayout
to hide the view off the
bottom of the screen when scrolling down, and show it when scrolling up.
Summary
Constants | |
---|---|
int |
ENTER_ANIMATION_DURATION
|
int |
EXIT_ANIMATION_DURATION
|
Public constructors | |
---|---|
HideBottomViewOnScrollBehavior()
|
|
HideBottomViewOnScrollBehavior(Context context, AttributeSet attrs)
|
Public methods | |
---|---|
boolean
|
isScrolledDown()
Returns true if the current state is scrolled down. |
boolean
|
isScrolledUp()
Returns true if the current state is scrolled up. |
boolean
|
onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection)
|
void
|
onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type, int[] consumed)
|
boolean
|
onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int nestedScrollAxes, int type)
|
void
|
setAdditionalHiddenOffsetY(V child, int offset)
Sets an additional offset for the y position used to hide the view. |
void
|
slideDown(V child)
Performs an animation that will slide the child from it's current position to be totally off the screen. |
void
|
slideDown(V child, boolean animate)
Slides the child with or without animation from its current position to be totally off the screen. |
void
|
slideUp(V child, boolean animate)
Slides the child with or without animation from its current position to be totally on the screen. |
void
|
slideUp(V child)
Performs an animation that will slide the child from it's current position to be totally on the screen. |
Inherited methods | |
---|---|
Constants
ENTER_ANIMATION_DURATION
protected static final int ENTER_ANIMATION_DURATION
Constant Value: 225 (0x000000e1)
EXIT_ANIMATION_DURATION
protected static final int EXIT_ANIMATION_DURATION
Constant Value: 175 (0x000000af)
Public constructors
HideBottomViewOnScrollBehavior
public HideBottomViewOnScrollBehavior ()
HideBottomViewOnScrollBehavior
public HideBottomViewOnScrollBehavior (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
Public methods
isScrolledDown
public boolean isScrolledDown ()
Returns true if the current state is scrolled down.
Returns | |
---|---|
boolean |
isScrolledUp
public boolean isScrolledUp ()
Returns true if the current state is scrolled up.
Returns | |
---|---|
boolean |
onLayoutChild
public boolean onLayoutChild (CoordinatorLayout parent, V child, int layoutDirection)
Parameters | |
---|---|
parent |
CoordinatorLayout |
child |
V |
layoutDirection |
int |
Returns | |
---|---|
boolean |
onNestedScroll
public void onNestedScroll (CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type, int[] consumed)
Parameters | |
---|---|
coordinatorLayout |
CoordinatorLayout |
child |
V |
target |
View |
dxConsumed |
int |
dyConsumed |
int |
dxUnconsumed |
int |
dyUnconsumed |
int |
type |
int |
consumed |
int |
onStartNestedScroll
public boolean onStartNestedScroll (CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int nestedScrollAxes, int type)
Parameters | |
---|---|
coordinatorLayout |
CoordinatorLayout |
child |
V |
directTargetChild |
View |
target |
View |
nestedScrollAxes |
int |
type |
int |
Returns | |
---|---|
boolean |
setAdditionalHiddenOffsetY
public void setAdditionalHiddenOffsetY (V child, int offset)
Sets an additional offset for the y position used to hide the view.
Parameters | |
---|---|
child |
V : the child view that is hidden by this behavior |
offset |
int : the additional offset in pixels that should be added when the view slides away
|
slideDown
public void slideDown (V child)
Performs an animation that will slide the child from it's current position to be totally off the screen.
Parameters | |
---|---|
child |
V |
slideDown
public void slideDown (V child, boolean animate)
Slides the child with or without animation from its current position to be totally off the screen.
Parameters | |
---|---|
child |
V |
animate |
boolean : true to slide with animation.
|
slideUp
public void slideUp (V child, boolean animate)
Slides the child with or without animation from its current position to be totally on the screen.
Parameters | |
---|---|
child |
V |
animate |
boolean : true to slide with animation.
|
slideUp
public void slideUp (V child)
Performs an animation that will slide the child from it's current position to be totally on the screen.
Parameters | |
---|---|
child |
V |