CoordinatorLayout.Behavior

abstract class CoordinatorLayout.Behavior<V : View?>


Interaction behavior plugin for child views of CoordinatorLayout.

A Behavior implements one or more interactions that a user can take on a child view. These interactions may include drags, swipes, flings, or any other gestures.

Parameters
<V : View?>

The View type that this Behavior operates on

Summary

Public constructors

Default constructor for instantiating Behaviors.

Behavior(context: Context, attrs: AttributeSet?)

Default constructor for inflating Behaviors from layout.

Public functions

Boolean

Determine whether interaction with views behind the given child in the child order should be blocked.

Boolean
getInsetDodgeRect(parent: CoordinatorLayout, child: V, rect: Rect)

Called when a view is set to dodge view insets.

@ColorInt Int
getScrimColor(parent: CoordinatorLayout, child: V)

Supply a scrim color that will be painted behind the associated child view.

@FloatRange(from = 0, to = 1) Float
getScrimOpacity(parent: CoordinatorLayout, child: V)

Determine the current opacity of the scrim behind a given child view

java-static Any?
getTag(child: View)

Get the behavior-specific tag object with the given child view.

Boolean
layoutDependsOn(parent: CoordinatorLayout, child: V, dependency: View)

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

WindowInsetsCompat
onApplyWindowInsets(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    insets: WindowInsetsCompat
)

Called when the window insets have changed.

Unit

Called when the Behavior has been attached to a LayoutParams instance.

Boolean
onDependentViewChanged(
    parent: CoordinatorLayout,
    child: V,
    dependency: View
)

Respond to a change in a child's dependent view

Unit
onDependentViewRemoved(
    parent: CoordinatorLayout,
    child: V,
    dependency: View
)

Respond to a child's dependent view being removed.

Unit

Called when the Behavior has been detached from its holding LayoutParams instance.

Boolean

Respond to CoordinatorLayout touch events before they are dispatched to child views.

Boolean
onLayoutChild(parent: CoordinatorLayout, child: V, layoutDirection: Int)

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

Boolean
onMeasureChild(
    parent: CoordinatorLayout,
    child: V,
    parentWidthMeasureSpec: Int,
    widthUsed: Int,
    parentHeightMeasureSpec: Int,
    heightUsed: Int
)

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

Boolean
onNestedFling(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    velocityX: Float,
    velocityY: Float,
    consumed: Boolean
)

Called when a nested scrolling child is starting a fling or an action that would be a fling.

Boolean
onNestedPreFling(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    velocityX: Float,
    velocityY: Float
)

Called when a nested scrolling child is about to start a fling.

Unit
onNestedPreScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dx: Int,
    dy: Int,
    consumed: IntArray
)

This function is deprecated.

You should now override onNestedPreScroll.

Unit
onNestedPreScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dx: Int,
    dy: Int,
    consumed: IntArray,
    type: Int
)

Called when a nested scroll in progress is about to update, before the target has consumed any of the scrolled distance.

Unit
onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int
)

This function is deprecated.

You should now override onNestedScroll.

Unit
onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    type: Int
)

This function is deprecated.

You should now override onNestedScroll.

Unit
onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    type: Int,
    consumed: IntArray
)

Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll.

Unit
onNestedScrollAccepted(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int
)

This function is deprecated.

You should now override onNestedScrollAccepted.

Unit
onNestedScrollAccepted(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int,
    type: Int
)

Called when a nested scroll has been accepted by the CoordinatorLayout.

Boolean
onRequestChildRectangleOnScreen(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    rectangle: Rect,
    immediate: Boolean
)

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

Unit
onRestoreInstanceState(
    parent: CoordinatorLayout,
    child: V,
    state: Parcelable
)

Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.

Parcelable?

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,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int
)

This function is deprecated.

You should now override onStartNestedScroll.

Boolean
onStartNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int,
    type: Int
)

Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll.

Unit
onStopNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View
)

This function is deprecated.

You should now override onStopNestedScroll.

Unit
onStopNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    type: Int
)

Called when a nested scroll has ended.

Boolean
onTouchEvent(parent: CoordinatorLayout, child: V, ev: MotionEvent)

Respond to CoordinatorLayout touch events after this Behavior has started intercepting them.

java-static Unit
setTag(child: View, tag: Any?)

Associate a Behavior-specific tag object with the given child view.

Public constructors

Behavior

Added in 1.1.0
Behavior()

Default constructor for instantiating Behaviors.

Behavior

Added in 1.1.0
Behavior(context: Context, attrs: AttributeSet?)

Default constructor for inflating Behaviors from layout. The Behavior will have the opportunity to parse specially defined layout parameters. These parameters will appear on the child view tag.

Parameters
context: Context
attrs: AttributeSet?

Public functions

blocksInteractionBelow

Added in 1.1.0
fun blocksInteractionBelow(parent: CoordinatorLayout, child: V): Boolean

Determine whether interaction with views behind the given child in the child order should be blocked.

The default implementation returns true if getScrimOpacity would return >0.0f.

Parameters
parent: CoordinatorLayout

the parent view of the given child

child: V

the child view to test

Returns
Boolean

true if getScrimOpacity would return >0.0f.

getInsetDodgeRect

Added in 1.1.0
fun getInsetDodgeRect(parent: CoordinatorLayout, child: V, rect: Rect): Boolean

Called when a view is set to dodge view insets.

This method allows a behavior to update the rectangle that should be dodged. The rectangle should be in the parent's coordinate system and within the child's bounds. If not, a IllegalArgumentException is thrown.

Parameters
parent: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

rect: Rect

the rect to update with the dodge rectangle

Returns
Boolean

true the rect was updated, false if we should use the child's bounds

getScrimColor

Added in 1.1.0
fun getScrimColor(parent: CoordinatorLayout, child: V): @ColorInt Int

Supply a scrim color that will be painted behind the associated 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.

The default implementation returns BLACK.

Parameters
parent: CoordinatorLayout

the parent view of the given child

child: V

the child view above the scrim

Returns
@ColorInt Int

the desired scrim color in 0xAARRGGBB format. The default return value is BLACK.

See also
getScrimOpacity

getScrimOpacity

Added in 1.1.0
fun getScrimOpacity(parent: CoordinatorLayout, child: V): @FloatRange(from = 0, to = 1) Float

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.

The default implementation returns 0.0f.

Parameters
parent: CoordinatorLayout

the parent view of the given child

child: V

the child view above the scrim

Returns
@FloatRange(from = 0, to = 1) Float

the desired scrim opacity from 0.0f to 1.0f. The default return value is 0.0f.

getTag

Added in 1.1.0
java-static fun getTag(child: View): Any?

Get the behavior-specific tag object with the given child view. This object is stored with the child view's LayoutParams.

Parameters
child: View

child view to get tag with

Returns
Any?

the previously stored tag object

layoutDependsOn

Added in 1.1.0
fun layoutDependsOn(parent: CoordinatorLayout, child: V, dependency: View): Boolean

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 when the dependency view's layout or position changes.
Parameters
parent: CoordinatorLayout

the parent view of the given child

child: V

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

onApplyWindowInsets

Added in 1.1.0
fun onApplyWindowInsets(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    insets: WindowInsetsCompat
): WindowInsetsCompat

Called when the window insets have changed.

Any Behavior associated with the direct child of the CoordinatorLayout may elect to handle the window inset change on behalf of it's associated view.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

insets: WindowInsetsCompat

the new window insets.

Returns
WindowInsetsCompat

The insets supplied, minus any insets that were consumed

onAttachedToLayoutParams

Added in 1.1.0
fun onAttachedToLayoutParams(params: CoordinatorLayout.LayoutParams): Unit

Called when the Behavior has been attached to a LayoutParams instance.

This will be called after the LayoutParams has been instantiated and can be modified.

Parameters
params: CoordinatorLayout.LayoutParams

the LayoutParams instance that this Behavior has been attached to

onDependentViewChanged

Added in 1.1.0
fun onDependentViewChanged(
    parent: CoordinatorLayout,
    child: V,
    dependency: View
): Boolean

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

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

onDependentViewRemoved

Added in 1.1.0
fun onDependentViewRemoved(
    parent: CoordinatorLayout,
    child: V,
    dependency: View
): Unit

Respond to a child's dependent view being removed.

This method is called after a dependent view has been removed from the parent. A Behavior may use this method to appropriately update the child view in response.

A view's dependency is determined by layoutDependsOn or if child has set another view as it's anchor.

Parameters
parent: CoordinatorLayout

the parent view of the given child

child: V

the child view to manipulate

dependency: View

the dependent view that has been removed

onDetachedFromLayoutParams

Added in 1.1.0
fun onDetachedFromLayoutParams(): Unit

Called when the Behavior has been detached from its holding LayoutParams instance.

This will only be called if the Behavior has been explicitly removed from the LayoutParams instance via setBehavior. It will not be called if the associated view is removed from the CoordinatorLayout or similar.

onInterceptTouchEvent

Added in 1.1.0
fun onInterceptTouchEvent(parent: CoordinatorLayout, child: V, ev: MotionEvent): Boolean

Respond to CoordinatorLayout touch events before they are dispatched to child views.

Behaviors can use this to monitor inbound touch events until one decides to intercept the rest of the event stream to take an action on its associated child view. This method will return false until it detects the proper intercept conditions, then return true once those conditions have occurred.

Once a Behavior intercepts touch events, the rest of the event stream will be sent to the onTouchEvent method.

This method will be called regardless of the visibility of the associated child of the behavior. If you only wish to handle touch events when the child is visible, you should add a check to isShown on the given child.

The default implementation of this method always returns false.

Parameters
parent: CoordinatorLayout

the parent view currently receiving this touch event

child: V

the child view associated with this Behavior

ev: MotionEvent

the MotionEvent describing the touch event being processed

Returns
Boolean

true if this Behavior would like to intercept and take over the event stream. The default always returns false.

onLayoutChild

Added in 1.1.0
fun onLayoutChild(parent: CoordinatorLayout, child: V, layoutDirection: Int): Boolean

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 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 1.1.0
fun onMeasureChild(
    parent: CoordinatorLayout,
    child: V,
    parentWidthMeasureSpec: Int,
    widthUsed: Int,
    parentHeightMeasureSpec: Int,
    heightUsed: Int
): Boolean

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

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

onNestedFling

Added in 1.1.0
fun onNestedFling(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    velocityX: Float,
    velocityY: Float,
    consumed: Boolean
): Boolean

Called when a nested scrolling child is starting a fling or an action that would be a fling.

Any Behavior associated with the direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

onNestedFling is called when the current nested scrolling child view detects the proper conditions for a fling. It reports if the child itself consumed the fling. If it did not, the child is expected to show some sort of overscroll indication. This method should return true if it consumes the fling, so that a child that did not itself take an action in response can choose not to show an overfling indication.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

target: View

the descendant view of the CoordinatorLayout performing the nested scroll

velocityX: Float

horizontal velocity of the attempted fling

velocityY: Float

vertical velocity of the attempted fling

consumed: Boolean

true if the nested child view consumed the fling

Returns
Boolean

true if the Behavior consumed the fling

See also
onNestedFling

onNestedPreFling

Added in 1.1.0
fun onNestedPreFling(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    velocityX: Float,
    velocityY: Float
): Boolean

Called when a nested scrolling child is about to start a fling.

Any Behavior associated with the direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

onNestedPreFling is called when the current nested scrolling child view detects the proper conditions for a fling, but it has not acted on it yet. A Behavior can return true to indicate that it consumed the fling. If at least one Behavior returns true, the fling should not be acted upon by the child.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

target: View

the descendant view of the CoordinatorLayout performing the nested scroll

velocityX: Float

horizontal velocity of the attempted fling

velocityY: Float

vertical velocity of the attempted fling

Returns
Boolean

true if the Behavior consumed the fling

See also
onNestedPreFling

onNestedPreScroll

Added in 1.1.0
Deprecated in 1.1.0
fun onNestedPreScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dx: Int,
    dy: Int,
    consumed: IntArray
): Unit

onNestedPreScroll

Added in 1.1.0
fun onNestedPreScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dx: Int,
    dy: Int,
    consumed: IntArray,
    type: Int
): Unit

Called when a nested scroll in progress is about to update, before the target has consumed any of the scrolled distance.

Any Behavior associated with the direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

onNestedPreScroll is called each time the nested scroll is updated by the nested scrolling child, before the nested scrolling child has consumed the scroll distance itself. Each Behavior responding to the nested scroll will receive the same values. The CoordinatorLayout will report as consumed the maximum number of pixels in either direction that any Behavior responding to the nested scroll reported as consumed.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

target: View

the descendant view of the CoordinatorLayout performing the nested scroll

dx: Int

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

dy: Int

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

consumed: IntArray

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

type: Int

the type of input which cause this scroll event

onNestedScroll

Added in 1.1.0
Deprecated in 1.1.0
fun onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int
): Unit

onNestedScroll

Added in 1.1.0
Deprecated in 1.1.0
fun onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    type: Int
): Unit

onNestedScroll

Added in 1.1.0
fun onNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    type: Int,
    consumed: IntArray
): Unit

Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll.

Any Behavior associated with the direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

onNestedScroll is called each time the nested scroll is updated by the nested scrolling child, with both consumed and unconsumed components of the scroll supplied in pixels. Each Behavior responding to the nested scroll will receive the same values.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

target: View

the descendant view of the CoordinatorLayout performing the nested scroll

dxConsumed: Int

horizontal pixels consumed by the target's own scrolling operation

dyConsumed: Int

vertical pixels consumed by the target's own scrolling operation

dxUnconsumed: Int

horizontal pixels not consumed by the target's own scrolling operation, but requested by the user

dyUnconsumed: Int

vertical pixels not consumed by the target's own scrolling operation, but requested by the user

type: Int

the type of input which cause this scroll event

consumed: IntArray

output. Upon this method returning, should contain the scroll distances consumed by this Behavior

See also
onNestedScroll

onNestedScrollAccepted

Added in 1.1.0
Deprecated in 1.1.0
fun onNestedScrollAccepted(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int
): Unit

onNestedScrollAccepted

Added in 1.1.0
fun onNestedScrollAccepted(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int,
    type: Int
): Unit

Called when a nested scroll has been accepted by the CoordinatorLayout.

Any Behavior associated with any direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

directTargetChild: View

the child view of the CoordinatorLayout that either is or contains the target of the nested scroll operation

target: View

the descendant view of the CoordinatorLayout initiating the nested scroll

axes: Int

the axes that this nested scroll applies to. See SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_VERTICAL

type: Int

the type of input which cause this scroll event

onRequestChildRectangleOnScreen

Added in 1.1.0
fun onRequestChildRectangleOnScreen(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    rectangle: Rect,
    immediate: Boolean
): Boolean

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.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

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

onRestoreInstanceState

Added in 1.1.0
fun onRestoreInstanceState(
    parent: CoordinatorLayout,
    child: V,
    state: Parcelable
): Unit

Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState. This function will never be called with a null state.

Parameters
parent: CoordinatorLayout

the parent CoordinatorLayout

child: V

child view to restore from

state: Parcelable

The frozen state that had previously been returned by onSaveInstanceState.

onSaveInstanceState

Added in 1.1.0
fun onSaveInstanceState(parent: CoordinatorLayout, child: V): Parcelable?

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. This state should only contain information that is not persistent or can not be reconstructed later.

Behavior state is only saved when both the parent CoordinatorLayout and a view using this behavior have valid IDs set.

Parameters
parent: CoordinatorLayout

the parent CoordinatorLayout

child: V

child view to restore from

Returns
Parcelable?

Returns a Parcelable object containing the behavior's current dynamic state.

onStartNestedScroll

Added in 1.1.0
Deprecated in 1.1.0
fun onStartNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int
): Boolean

onStartNestedScroll

Added in 1.1.0
fun onStartNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    directTargetChild: View,
    target: View,
    axes: Int,
    type: Int
): Boolean

Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll.

Any Behavior associated with any direct child of the CoordinatorLayout may respond to this event and return true to indicate that the CoordinatorLayout should act as a nested scrolling parent for this scroll. Only Behaviors that return true from this method will receive subsequent nested scroll events.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

directTargetChild: View

the child view of the CoordinatorLayout that either is or contains the target of the nested scroll operation

target: View

the descendant view of the CoordinatorLayout initiating the nested scroll

axes: Int

the axes that this nested scroll applies to. See SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_VERTICAL

type: Int

the type of input which cause this scroll event

Returns
Boolean

true if the Behavior wishes to accept this nested scroll

onStopNestedScroll

Added in 1.1.0
Deprecated in 1.1.0
fun onStopNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View
): Unit

onStopNestedScroll

Added in 1.1.0
fun onStopNestedScroll(
    coordinatorLayout: CoordinatorLayout,
    child: V,
    target: View,
    type: Int
): Unit

Called when a nested scroll has ended.

Any Behavior associated with any direct child of the CoordinatorLayout may elect to accept the nested scroll as part of onStartNestedScroll. Each Behavior that returned true will receive subsequent nested scroll events for that nested scroll.

onStopNestedScroll marks the end of a single nested scroll event sequence. This is a good place to clean up any state related to the nested scroll.

Parameters
coordinatorLayout: CoordinatorLayout

the CoordinatorLayout parent of the view this Behavior is associated with

child: V

the child view of the CoordinatorLayout this Behavior is associated with

target: View

the descendant view of the CoordinatorLayout that initiated the nested scroll

type: Int

the type of input which cause this scroll event

onTouchEvent

Added in 1.1.0
fun onTouchEvent(parent: CoordinatorLayout, child: V, ev: MotionEvent): Boolean

Respond to CoordinatorLayout touch events after this Behavior has started intercepting them.

Behaviors may intercept touch events in order to help the CoordinatorLayout manipulate its child views. For example, a Behavior may allow a user to drag a UI pane open or closed. This method should perform actual mutations of view layout state.

This method will be called regardless of the visibility of the associated child of the behavior. If you only wish to handle touch events when the child is visible, you should add a check to isShown on the given child.

Parameters
parent: CoordinatorLayout

the parent view currently receiving this touch event

child: V

the child view associated with this Behavior

ev: MotionEvent

the MotionEvent describing the touch event being processed

Returns
Boolean

true if this Behavior handled this touch event and would like to continue receiving events in this stream. The default always returns false.

setTag

Added in 1.1.0
java-static fun setTag(child: View, tag: Any?): Unit

Associate a Behavior-specific tag object with the given child view. This object will be stored with the child view's LayoutParams.

Parameters
child: View

child view to set tag with

tag: Any?

tag object to set