AppBarLayout.ScrollingViewBehavior - Android SDK

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

public static class

AppBarLayout.ScrollingViewBehavior

extends Behavior<View>

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

Class Overview

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()
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	setLeftAndRightOffset(int offset)
void	setOverlayTop(int overlayTop) Set the distance that this view should overlap any `AppBarLayout`.
boolean	setTopAndBottomOffset(int offset)

[Expand]

Inherited Methods

From class android.support.design.widget.CoordinatorLayout.Behavior

boolean	blocksInteractionBelow(CoordinatorLayout parent, View child) Determine whether interaction with views behind the given child in the child order should be blocked.
final int	getScrimColor(CoordinatorLayout parent, View child) Supply a scrim color that will be painted behind the associated child view.
final float	getScrimOpacity(CoordinatorLayout parent, View 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	isDirty(CoordinatorLayout parent, View child) Determine whether the given child view should be considered dirty.
boolean	layoutDependsOn(CoordinatorLayout parent, View child, View dependency) Determine whether the supplied child view has another specific sibling view as a layout dependency.
WindowInsetsCompat	onApplyWindowInsets(CoordinatorLayout coordinatorLayout, View child, WindowInsetsCompat insets) Called when the window insets have changed.
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.
void	onDependentViewRemoved(CoordinatorLayout parent, View child, View dependency) Respond to a child's dependent view being removed.
boolean	onInterceptTouchEvent(CoordinatorLayout parent, View child, MotionEvent ev) Respond to CoordinatorLayout touch events before they are dispatched to child views.
boolean	onLayoutChild(CoordinatorLayout parent, View 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	onNestedFling(CoordinatorLayout coordinatorLayout, View 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, View child, View target, float velocityX, float velocityY) Called when a nested scrolling child is about to start a fling.
void	onNestedPreScroll(CoordinatorLayout coordinatorLayout, View child, View target, int dx, int dy, int[] consumed) 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, View child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll.
void	onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, View child, View directTargetChild, View target, int nestedScrollAxes) Called when a nested scroll has been accepted by the CoordinatorLayout.
void	onRestoreInstanceState(CoordinatorLayout parent, View 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, View 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, View child, View directTargetChild, View target, int nestedScrollAxes) Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll.
void	onStopNestedScroll(CoordinatorLayout coordinatorLayout, View child, View target) Called when a nested scroll has ended.
boolean	onTouchEvent(CoordinatorLayout parent, View 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() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public AppBarLayout.ScrollingViewBehavior ()

public AppBarLayout.ScrollingViewBehavior (Context context, AttributeSet attrs)

Public Methods

public int getLeftAndRightOffset ()

public int getOverlayTop ()

Returns the distance that this view should overlap any AppBarLayout.

public int getTopAndBottomOffset ()

public 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:

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

Parameters

parent	the parent view of the given child
child	the child view to test
dependency	the proposed dependency of child

Returns

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

public 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, android.view.View, android.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	the parent view of the given child
child	the child view to manipulate
dependency	the dependent view that changed

Returns

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

public 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.onMeasureChild.

If a Behavior implements onDependentViewChanged(CoordinatorLayout, android.view.View, android.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	the parent CoordinatorLayout
child	child view to lay out
layoutDirection	the resolved layout direction for the CoordinatorLayout, such as `LAYOUT_DIRECTION_LTR` or `LAYOUT_DIRECTION_RTL`.

Returns

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

public 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	the parent CoordinatorLayout
child	the child to measure
parentWidthMeasureSpec	the width requirements for this view
widthUsed	extra space that has been used up by the parent horizontally (possibly by other children of the parent)
parentHeightMeasureSpec	the height requirements for this view
heightUsed	extra space that has been used up by the parent vertically (possibly by other children of the parent)

Returns

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

public boolean setLeftAndRightOffset (int offset)

public void setOverlayTop (int overlayTop)

Set the distance that this view should overlap any AppBarLayout.

Parameters

overlayTop	the distance in px

Results

Annotations

Interfaces

Classes

AppBarLayout.ScrollingViewBehavior

Class Overview

Summary

Public Constructors

public AppBarLayout.ScrollingViewBehavior ()

public AppBarLayout.ScrollingViewBehavior (Context context, AttributeSet attrs)

Public Methods

public int getLeftAndRightOffset ()

public int getOverlayTop ()

public int getTopAndBottomOffset ()

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

public boolean setLeftAndRightOffset (int offset)

public void setOverlayTop (int overlayTop)

Parameters

public boolean setTopAndBottomOffset (int offset)