added in version 22.2.0
belongs to Maven artifact com.android.support:design:27.1.0

Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

AppBarLayout.ScrollingViewBehavior

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public static class AppBarLayout.ScrollingViewBehavior
extends Behavior<V extends View>

java.lang.Object
↳	android.support.design.widget.CoordinatorLayout.Behavior<V extends android.view.View>
	↳	android.support.design.widget.AppBarLayout.ScrollingViewBehavior

---

Behavior which should be used by Views which can scroll vertically and support nested scrolling to automatically scroll any AppBarLayout siblings.

Summary

Public constructors
AppBarLayout.ScrollingViewBehavior()
AppBarLayout.ScrollingViewBehavior(Context context, AttributeSet attrs)

Public methods
int	getLeftAndRightOffset()
final int	getOverlayTop() Returns the distance that this view should overlap any AppBarLayout.
int	getTopAndBottomOffset()
boolean	layoutDependsOn(CoordinatorLayout parent, View child, View dependency) Determine whether the supplied child view has another specific sibling view as a layout dependency.
boolean	onDependentViewChanged(CoordinatorLayout parent, View child, View dependency) Respond to a change in a child's dependent view This method is called whenever a dependent view changes in size or position outside of the standard layout flow.
boolean	onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection) Called when the parent CoordinatorLayout is about the lay out the given child view.
boolean	onMeasureChild(CoordinatorLayout parent, View child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed) Called when the parent CoordinatorLayout is about to measure the given child view.
boolean	onRequestChildRectangleOnScreen(CoordinatorLayout parent, View child, Rect rectangle, boolean immediate) Called when a child of the view associated with this behavior wants a particular rectangle to be positioned onto the screen.
boolean	setLeftAndRightOffset(int offset)
final void	setOverlayTop(int overlayTop) Set the distance that this view should overlap any AppBarLayout.
boolean	setTopAndBottomOffset(int offset)

Protected methods
void	layoutChild(CoordinatorLayout parent, View child, int layoutDirection)
void	layoutChild(CoordinatorLayout parent, V child, int layoutDirection)

Inherited methods
From class android.support.design.widget.CoordinatorLayout.Behavior boolean blocksInteractionBelow(CoordinatorLayout parent, V child) Determine whether interaction with views behind the given child in the child order should be blocked. boolean getInsetDodgeRect(CoordinatorLayout parent, V child, Rect rect) Called when a view is set to dodge view insets. int getScrimColor(CoordinatorLayout parent, V child) Supply a scrim color that will be painted behind the associated child view. float getScrimOpacity(CoordinatorLayout parent, V child) Determine the current opacity of the scrim behind a given child view A scrim may be used to indicate that the other elements beneath it are not currently interactive or actionable, drawing user focus and attention to the views above the scrim. static Object getTag(View child) Get the behavior-specific tag object with the given child view. boolean layoutDependsOn(CoordinatorLayout parent, V child, View dependency) Determine whether the supplied child view has another specific sibling view as a layout dependency. WindowInsetsCompat onApplyWindowInsets(CoordinatorLayout coordinatorLayout, V child, WindowInsetsCompat insets) Called when the window insets have changed. void onAttachedToLayoutParams(CoordinatorLayout.LayoutParams params) Called when the Behavior has been attached to a LayoutParams instance. boolean onDependentViewChanged(CoordinatorLayout parent, V child, View dependency) Respond to a change in a child's dependent view This method is called whenever a dependent view changes in size or position outside of the standard layout flow. void onDependentViewRemoved(CoordinatorLayout parent, V child, View dependency) Respond to a child's dependent view being removed. void onDetachedFromLayoutParams() Called when the Behavior has been detached from its holding LayoutParams instance. boolean onInterceptTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events before they are dispatched to child views. boolean onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection) Called when the parent CoordinatorLayout is about the lay out the given child view. boolean onMeasureChild(CoordinatorLayout parent, V child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed) Called when the parent CoordinatorLayout is about to measure the given child view. boolean onNestedFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY, boolean consumed) Called when a nested scrolling child is starting a fling or an action that would be a fling. boolean onNestedPreFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY) Called when a nested scrolling child is about to start a fling. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed) This method was deprecated in API level 26.1.0. You should now override onNestedPreScroll(CoordinatorLayout, View, View, int, int, int[], int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed, int type) Called when a nested scroll in progress is about to update, before the target has consumed any of the scrolled distance. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) This method was deprecated in API level 26.1.0. You should now override onNestedScroll(CoordinatorLayout, View, View, int, int, int, int, int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type) Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a nested scroll has been accepted by the CoordinatorLayout. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onNestedScrollAccepted(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onRequestChildRectangleOnScreen(CoordinatorLayout coordinatorLayout, V child, Rect rectangle, boolean immediate) Called when a child of the view associated with this behavior wants a particular rectangle to be positioned onto the screen. void onRestoreInstanceState(CoordinatorLayout parent, V child, Parcelable state) Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(CoordinatorLayout, V). Parcelable onSaveInstanceState(CoordinatorLayout parent, V child) Hook allowing a behavior to generate a representation of its internal state that can later be used to create a new instance with that same state. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onStartNestedScroll(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target) This method was deprecated in API level 26.1.0. You should now override onStopNestedScroll(CoordinatorLayout, View, View, int). This method will still continue to be called if the type is TYPE_TOUCH. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int type) Called when a nested scroll has ended. boolean onTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events after this Behavior has started intercepting them. static void setTag(View child, Object tag) Associate a Behavior-specific tag object with the given child view.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

AppBarLayout.ScrollingViewBehavior

added in version 22.2.0

AppBarLayout.ScrollingViewBehavior ()

AppBarLayout.ScrollingViewBehavior

added in version 22.2.0

AppBarLayout.ScrollingViewBehavior (Context context, 
                AttributeSet attrs)

Parameters
context	Context
attrs	AttributeSet

Public methods

getLeftAndRightOffset

added in version 22.2.0

int getLeftAndRightOffset ()

Returns
int

getOverlayTop

added in version 22.2.0

int getOverlayTop ()

Returns the distance that this view should overlap any AppBarLayout.

Returns
int

getTopAndBottomOffset

added in version 22.2.0

int getTopAndBottomOffset ()

Returns
int

layoutDependsOn

added in version 22.2.0

boolean layoutDependsOn (CoordinatorLayout parent, 
                View child, 
                View dependency)

Determine whether the supplied child view has another specific sibling view as a layout dependency.

This method will be called at least once in response to a layout request. If it returns true for a given child and dependency view pair, the parent CoordinatorLayout will:

1. Always lay out this child after the dependent child is laid out, regardless of child order.
2. Call onDependentViewChanged(CoordinatorLayout, V, View) when the dependency view's layout or position changes.

Parameters
parent	CoordinatorLayout: the parent view of the given child
child	View: the child view to test
dependency	View: the proposed dependency of child

Returns
boolean	true if child's layout depends on the proposed dependency's layout, false otherwise

onDependentViewChanged

added in version 22.2.0

boolean onDependentViewChanged (CoordinatorLayout parent, 
                View child, 
                View dependency)

Respond to a change in a child's dependent view

This method is called whenever a dependent view changes in size or position outside of the standard layout flow. A Behavior may use this method to appropriately update the child view in response.

A view's dependency is determined by layoutDependsOn(CoordinatorLayout, View, View) or if child has set another view as it's anchor.

Note that if a Behavior changes the layout of a child via this method, it should also be able to reconstruct the correct position in onLayoutChild. onDependentViewChanged will not be called during normal layout since the layout of each child view will always happen in dependency order.

If the Behavior changes the child view's size or position, it should return true. The default implementation returns false.

Parameters
parent	CoordinatorLayout: the parent view of the given child
child	View: the child view to manipulate
dependency	View: the dependent view that changed

Returns
boolean	true if the Behavior changed the child view's size or position, false otherwise

onLayoutChild

boolean onLayoutChild (CoordinatorLayout parent, 
                V child, 
                int layoutDirection)

Called when the parent CoordinatorLayout is about the lay out the given child view.

This method can be used to perform custom or modified layout of a child view in place of the default child layout behavior. The Behavior's implementation can delegate to the standard CoordinatorLayout measurement behavior by calling parent.onLayoutChild.

If a Behavior implements onDependentViewChanged(CoordinatorLayout, View, View) to change the position of a view in response to a dependent view changing, it should also implement onLayoutChild in such a way that respects those dependent views. onLayoutChild will always be called for a dependent view after its dependency has been laid out.

Parameters
parent	CoordinatorLayout: the parent CoordinatorLayout
child	V: child view to lay out
layoutDirection	int: the resolved layout direction for the CoordinatorLayout, such as LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL.

Returns
boolean	true if the Behavior performed layout of the child view, false to request default layout behavior

onMeasureChild

added in version 22.2.0

boolean onMeasureChild (CoordinatorLayout parent, 
                View child, 
                int parentWidthMeasureSpec, 
                int widthUsed, 
                int parentHeightMeasureSpec, 
                int heightUsed)

Called when the parent CoordinatorLayout is about to measure the given child view.

This method can be used to perform custom or modified measurement of a child view in place of the default child measurement behavior. The Behavior's implementation can delegate to the standard CoordinatorLayout measurement behavior by calling parent.onMeasureChild.

Parameters
parent	CoordinatorLayout: the parent CoordinatorLayout
child	View: the child to measure
parentWidthMeasureSpec	int: the width requirements for this view
widthUsed	int: extra space that has been used up by the parent horizontally (possibly by other children of the parent)
parentHeightMeasureSpec	int: the height requirements for this view
heightUsed	int: extra space that has been used up by the parent vertically (possibly by other children of the parent)

Returns
boolean	true if the Behavior measured the child view, false if the CoordinatorLayout should perform its default measurement

onRequestChildRectangleOnScreen

added in version 26.1.0

boolean onRequestChildRectangleOnScreen (CoordinatorLayout parent, 
                View child, 
                Rect rectangle, 
                boolean immediate)

Called when a child of the view associated with this behavior wants a particular rectangle to be positioned onto the screen.

The contract for this method is the same as requestChildRectangleOnScreen(View, Rect, boolean).

Parameters
parent	CoordinatorLayout: the CoordinatorLayout parent of the view this Behavior is associated with
child	View: the child view of the CoordinatorLayout this Behavior is associated with
rectangle	Rect: The rectangle which the child wishes to be on the screen in the child's coordinates
immediate	boolean: true to forbid animated or delayed scrolling, false otherwise

Returns
boolean	true if the Behavior handled the request

setLeftAndRightOffset

added in version 22.2.0

boolean setLeftAndRightOffset (int offset)

Parameters
offset	int

Returns
boolean

setOverlayTop

added in version 22.2.0

void setOverlayTop (int overlayTop)

Set the distance that this view should overlap any AppBarLayout.

Parameters
overlayTop	int: the distance in px

setTopAndBottomOffset

added in version 22.2.0

boolean setTopAndBottomOffset (int offset)

Parameters
offset	int

Returns
boolean

Protected methods

layoutChild

added in version 23.4.0

void layoutChild (CoordinatorLayout parent, 
                View child, 
                int layoutDirection)

Parameters
parent	CoordinatorLayout
child	View
layoutDirection	int

layoutChild

void layoutChild (CoordinatorLayout parent, 
                V child, 
                int layoutDirection)

Parameters
parent	CoordinatorLayout
child	V
layoutDirection	int

• Annotations

  • CoordinatorLayout.DefaultBehavior

• Interfaces

  • AppBarLayout.OnOffsetChangedListener
  • BaseTransientBottomBar.ContentViewCallback
  • BottomNavigationView.OnNavigationItemReselectedListener
  • BottomNavigationView.OnNavigationItemSelectedListener
  • CoordinatorLayout.AttachedBehavior
  • NavigationView.OnNavigationItemSelectedListener
  • SwipeDismissBehavior.OnDismissListener
  • TabLayout.OnTabSelectedListener

• Classes

  • AppBarLayout
  • AppBarLayout.Behavior
  • AppBarLayout.Behavior.DragCallback
  • AppBarLayout.Behavior.SavedState
  • AppBarLayout.LayoutParams
  • AppBarLayout.ScrollingViewBehavior
  • BaseTransientBottomBar
  • BaseTransientBottomBar.BaseCallback
  • BottomNavigationView
  • BottomSheetBehavior
  • BottomSheetBehavior.BottomSheetCallback
  • BottomSheetBehavior.SavedState
  • BottomSheetDialog
  • BottomSheetDialogFragment
  • CollapsingToolbarLayout
  • CollapsingToolbarLayout.LayoutParams
  • CoordinatorLayout
  • CoordinatorLayout.Behavior
  • CoordinatorLayout.LayoutParams
  • CoordinatorLayout.SavedState
  • FloatingActionButton
  • FloatingActionButton.Behavior
  • FloatingActionButton.OnVisibilityChangedListener
  • NavigationView
  • NavigationView.SavedState
  • Snackbar
  • Snackbar.Callback
  • SwipeDismissBehavior
  • TabItem
  • TabLayout
  • TabLayout.Tab
  • TabLayout.TabLayoutOnPageChangeListener
  • TabLayout.ViewPagerOnTabSelectedListener
  • TextInputEditText
  • TextInputLayout