Android Studio
Added in API level 30
Summary: Methods | Inherited Methods

WindowInsets.Type

public static final class WindowInsets.Type
extends Object

java.lang.Object
   ↳ android.view.WindowInsets.Type

Class that defines different types of sources causing window insets.

Summary

Public methods

static int captionBar()
static int displayCutout()

Returns an insets type representing the area that used by DisplayCutout.

static int ime()
static int mandatorySystemGestures()
static int navigationBars()
static int statusBars()
static int systemBars()
static int systemGestures()

Returns an insets type representing the system gesture insets.

static int systemOverlays()

System overlays represent the insets caused by the system visible elements.

static int tappableElement()

Inherited methods

Public methods

captionBar

Added in API level 30 
public static int captionBar ()

Returns int An insets type representing the window of a caption bar.
Value is either 0 or a combination of the following:

displayCutout

Added in API level 30 
public static int displayCutout ()

Returns an insets type representing the area that used by DisplayCutout.

This is equivalent to the safe insets on WindowInsets.getDisplayCutout().

Note: During dispatch to View.onApplyWindowInsets, if the window is using the default WindowManager.LayoutParams.layoutInDisplayCutoutMode, WindowInsets.getDisplayCutout() will return null even if the window overlaps a display cutout area, in which case the displayCutout() inset will still report the accurate value.

Returns int Value is either 0 or a combination of the following:

See also:

ime

Added in API level 30 
public static int ime ()

Returns int An insets type representing the window of an InputMethod.
Value is either 0 or a combination of the following:

mandatorySystemGestures

Added in API level 30 
public static int mandatorySystemGestures ()

Returns int Value is either 0 or a combination of the following:

See also:

Added in API level 30 
public static int navigationBars ()

Returns int An insets type representing any system bars for navigation.
Value is either 0 or a combination of the following:

statusBars

Added in API level 30 
public static int statusBars ()

Returns int An insets type representing any system bars for displaying status.
Value is either 0 or a combination of the following:

systemBars

Added in API level 30 
public static int systemBars ()

Returns int All system bars. Includes statusBars(), captionBar() as well as navigationBars(), systemOverlays(), but not ime().
Value is either 0 or a combination of the following:

systemGestures

Added in API level 30 
public static int systemGestures ()

Returns an insets type representing the system gesture insets.

The system gesture insets represent the area of a window where system gestures have priority and may consume some or all touch input, e.g. due to the a system bar occupying it, or it being reserved for touch-only gestures.

Simple taps are guaranteed to reach the window even within the system gesture insets, as long as they are outside the system window insets.

When View.SYSTEM_UI_FLAG_LAYOUT_STABLE is requested, an inset will be returned even when the system gestures are inactive due to View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION.

Returns int Value is either 0 or a combination of the following:

See also:

systemOverlays

Added in API level 34 
public static int systemOverlays ()

System overlays represent the insets caused by the system visible elements. Unlike navigationBars() or statusBars(), system overlays might not be hidden by the client.

For compatibility reasons, this type is included in systemBars(). In this way, views which fit systemBars() fit systemOverlays().

Examples include climate controls, multi-tasking affordances, etc.

Returns int An insets type representing the system overlays.
Value is either 0 or a combination of the following:

tappableElement

Added in API level 30 
public static int tappableElement ()

Returns int Value is either 0 or a combination of the following:

See also: