SESL Material/com.google.android.material.behavior/HideBottomViewOnScrollBehavior

HideBottomViewOnScrollBehavior

open class HideBottomViewOnScrollBehavior<V : View?> : CoordinatorLayout.Behavior<V>

The 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.

Inheritors

Constructors

Link copied to clipboard
constructor()
constructor(context: Context, attrs: AttributeSet)

Types

Link copied to clipboard
interface OnScrollStateChangedListener
Interface definition for a listener to be notified when the bottom view scroll state changes.
Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP)
annotation class ScrollState
Positions the scroll state can be set to.

Properties

Link copied to clipboard
val STATE_SCROLLED_DOWN: Int = 1
State of the bottom view when it's scrolled down.
Link copied to clipboard
val STATE_SCROLLED_UP: Int = 2
State of the bottom view when it's scrolled up.

Functions

Link copied to clipboard
open fun addOnScrollStateChangedListener(@NonNull listener: HideBottomViewOnScrollBehavior.OnScrollStateChangedListener)
Adds a listener to be notified of bottom view scroll state changes.
Link copied to clipboard
open fun clearOnScrollStateChangedListeners()
Remove all previously added OnScrollStateChangedListeners.
Link copied to clipboard
open fun isScrolledDown(): Boolean
Returns true if the current state is scrolled down.
Link copied to clipboard
open fun isScrolledUp(): Boolean
Returns true if the current state is scrolled up.
Link copied to clipboard
open fun onLayoutChild(@NonNull parent: CoordinatorLayout, @NonNull child: V, layoutDirection: Int): Boolean
Link copied to clipboard
open fun onNestedScroll(coordinatorLayout: CoordinatorLayout, @NonNull child: V, @NonNull target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, type: Int, @NonNull consumed: Array<Int>)
Link copied to clipboard
open fun onStartNestedScroll(@NonNull coordinatorLayout: CoordinatorLayout, @NonNull child: V, @NonNull directTargetChild: View, @NonNull target: View, nestedScrollAxes: Int, type: Int): Boolean
Link copied to clipboard
Link copied to clipboard
open fun setAdditionalHiddenOffsetY(@NonNull child: V, @Dimension offset: Int)
Sets an additional offset for the y position used to hide the view.
Link copied to clipboard
open fun slideDown(@NonNull child: V)
Performs an animation that will slide the child from it's current position to be totally off the screen.
open fun slideDown(@NonNull child: V, animate: Boolean)
Slides the child with or without animation from its current position to be totally off the screen.
Link copied to clipboard
open fun slideUp(@NonNull child: V)
Performs an animation that will slide the child from it's current position to be totally on the screen.
open fun slideUp(@NonNull child: V, animate: Boolean)
Slides the child with or without animation from its current position to be totally on the screen.