Share via


WindowInsets.Consumed Property

Definition

A WindowInsets instance for which #isConsumed() returns true.

[Android.Runtime.Register("CONSUMED", ApiSince=30)]
public static Android.Views.WindowInsets Consumed { get; }
[<Android.Runtime.Register("CONSUMED", ApiSince=30)>]
static member Consumed : Android.Views.WindowInsets

Property Value

Attributes

Remarks

A WindowInsets instance for which #isConsumed() returns true.

This can be used during insets dispatch in the view hierarchy by returning this value from View#onApplyWindowInsets(WindowInsets) or OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) to stop dispatch the insets to its children to avoid traversing the entire view hierarchy.

The application should return this instance once it has taken care of all insets on a certain level in the view hierarchy, and doesn't need to dispatch to its children anymore for better performance.

Java documentation for android.view.WindowInsets.CONSUMED.

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