Overview

Interface that allows the application to listen to animation events for windows that cause insets.

Summary

Fields

Return value for WindowInsetsAnimationCompat.Callback.getDispatchMode(): Dispatching of animation events should stop at this level in the view hierarchy, and no animation events should be dispatch to the subtree of the view hierarchy.

Return value for WindowInsetsAnimationCompat.Callback.getDispatchMode(): Dispatching of animation events should continue in the view hierarchy.

Constructors

Creates a new WindowInsetsAnimationCompat callback with the given dispatch mode.

Parameters:

dispatchMode: The dispatch mode for this callback. See WindowInsetsAnimationCompat.Callback.getDispatchMode().

Methods

Retrieves the dispatch mode of this listener. Dispatch of the all animation events is hierarchical: It will starts at the root of the view hierarchy and then traverse it and invoke the callback of the specific View that is being traversed. The method may return either WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_CONTINUE_ON_SUBTREE to indicate that animation events should be propagated to the subtree of the view hierarchy, or WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP to stop dispatching. In that case, all animation callbacks related to the animation passed in will be stopped from propagating to the subtree of the hierarchy.

Also note that WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP behaves the same way as returning WindowInsetsCompat.CONSUMED during the regular insets dispatch in View.

Returns:

Either WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_CONTINUE_ON_SUBTREE to indicate that dispatching of animation events will continue to the subtree of the view hierarchy, or WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP to indicate that animation events will stop dispatching.

Called when an insets animation is about to start and before the views have been re-laid out due to an animation.

This ordering allows the application to inspect the end state after the animation has finished, and then revert to the starting state of the animation in the first WindowInsetsAnimationCompat.Callback.onProgress(WindowInsetsCompat, List) callback by using post-layout view properties like View and related methods.

The ordering of events during an insets animation is the following:

• Application calls WindowInsetsControllerCompat.hide(int), WindowInsetsControllerCompat.show(int), WindowInsetsControllerCompat.controlWindowInsetsAnimation(int, long, Interpolator, CancellationSignal, WindowInsetsAnimationControlListenerCompat)
• onPrepare is called on the view hierarchy listeners
• View will be called with the end state of the animation
• View hierarchy gets laid out according to the changes the application has requested due to the new insets being dispatched
• WindowInsetsAnimationCompat.Callback.onStart(WindowInsetsAnimationCompat, WindowInsetsAnimationCompat.BoundsCompat) is called before the view hierarchy gets drawn in the new laid out state
• WindowInsetsAnimationCompat.Callback.onProgress(WindowInsetsCompat, List) is called immediately after with the animation start state
• The frame gets drawn.

Note: If the animation is application controlled by using WindowInsetsControllerCompat.controlWindowInsetsAnimation(int, long, Interpolator, CancellationSignal, WindowInsetsAnimationControlListenerCompat), the end state of the animation is undefined as the application may decide on the end state only by passing in shown parameter when calling WindowInsetsAnimationControllerCompat.finish(boolean). In this situation, the system will dispatch the insets in the opposite visibility state before the animation starts. Example: When controlling the input method with WindowInsetsControllerCompat.controlWindowInsetsAnimation(int, long, Interpolator, CancellationSignal, WindowInsetsAnimationControlListenerCompat) and the input method is currently showing, View will receive a WindowInsetsCompat instance for which WindowInsetsCompat.isVisible(int) will return false for WindowInsetsCompat.Type.ime().

Parameters:

animation: The animation that is about to start.

Called when an insets animation gets started.

This ordering allows the application to inspect the end state after the animation has finished, and then revert to the starting state of the animation in the first WindowInsetsAnimationCompat.Callback.onProgress(WindowInsetsCompat, List) callback by using post-layout view properties like View and related methods.

The ordering of events during an insets animation is the following:

• Application calls WindowInsetsControllerCompat.hide(int), WindowInsetsControllerCompat.show(int), WindowInsetsControllerCompat.controlWindowInsetsAnimation(int, long, Interpolator, CancellationSignal, WindowInsetsAnimationControlListenerCompat)
• onPrepare is called on the view hierarchy listeners
• View will be called with the end state of the animation
• View hierarchy gets laid out according to the changes the application has requested due to the new insets being dispatched
• WindowInsetsAnimationCompat.Callback.onStart(WindowInsetsAnimationCompat, WindowInsetsAnimationCompat.BoundsCompat) is called before the view hierarchy gets drawn in the new laid out state
• WindowInsetsAnimationCompat.Callback.onProgress(WindowInsetsCompat, List) is called immediately after with the animation start state
• The frame gets drawn.

Note that, like WindowInsetsAnimationCompat.Callback.onProgress(WindowInsetsCompat, List), dispatch of the animation start event is hierarchical: It will starts at the root of the view hierarchy and then traverse it and invoke the callback of the specific View that is being traversed. The method may return a modified instance of the bounds by calling WindowInsetsAnimationCompat.BoundsCompat.inset(Insets) to indicate that a part of the insets have been used to offset or clip its children, and the children shouldn't worry about that part anymore. Furthermore, if WindowInsetsAnimationCompat.Callback.getDispatchMode() returns WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP, children of this view will not receive the callback anymore.

Parameters:

animation: The animation that is about to start.
bounds: The bounds in which animation happens.

Returns:

The animation bounds representing the part of the insets that should be dispatched to the subtree of the hierarchy.

Called when the insets change as part of running an animation. Note that even if multiple animations for different types are running, there will only be one progress callback per frame. The insets passed as an argument represents the overall state and will include all types, regardless of whether they are animating or not.

Note that insets dispatch is hierarchical: It will start at the root of the view hierarchy, and then traverse it and invoke the callback of the specific View being traversed. The method may return a modified instance by calling WindowInsetsCompat.inset(int, int, int, int) to indicate that a part of the insets have been used to offset or clip its children, and the children shouldn't worry about that part anymore. Furthermore, if WindowInsetsAnimationCompat.Callback.getDispatchMode() returns WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP, children of this view will not receive the callback anymore.

Parameters:

insets: The current insets.
runningAnimations: The currently running animations.

Returns:

The insets to dispatch to the subtree of the hierarchy.

Called when an insets animation has ended.

Parameters:

animation: The animation that has ended. This will be the same instance as passed into WindowInsetsAnimationCompat.Callback.onStart(WindowInsetsAnimationCompat, WindowInsetsAnimationCompat.BoundsCompat)