Share via


WindowInsetsAnimation.Callback.DispatchMode Property

Definition

Retrieves the dispatch mode of this listener.

public int DispatchMode { [Android.Runtime.Register("getDispatchMode", "()I", "", ApiSince=30)] get; }
[<get: Android.Runtime.Register("getDispatchMode", "()I", "", ApiSince=30)>]
member this.DispatchMode : int

Property Value

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

Attributes

Remarks

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 #DISPATCH_MODE_CONTINUE_ON_SUBTREE to indicate that animation events should be propagated to the subtree of the view hierarchy, or #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 #DISPATCH_MODE_STOP behaves the same way as returning WindowInsets#CONSUMED during the regular insets dispatch in View#onApplyWindowInsets.

Java documentation for android.view.WindowInsetsAnimation.Callback.getDispatchMode().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to