WindowInsetsCompat.Type

Added in 1.5.0

Kotlin |Java

public final class WindowInsetsCompat.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 `DisplayCutoutCompat`.
`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()`

Public methods

captionBar

Added in 1.5.0

public static int captionBar()

Returns
`int`	An insets type representing the window of a caption bar.

displayCutout

Added in 1.5.0

public static int displayCutout()

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

This is equivalent to the safe insets on getDisplayCutout.

See also
`getSafeInsetLeft`
`getSafeInsetTop`
`getSafeInsetRight`
`getSafeInsetBottom`

ime

Added in 1.5.0

public static int ime()

Returns
`int`	An insets type representing the window of an `InputMethod`.

mandatorySystemGestures

Added in 1.5.0

public static int mandatorySystemGestures()

See also
`getMandatorySystemGestureInsets`

navigationBars

Added in 1.5.0

public static int navigationBars()

Returns
`int`	An insets type representing any system bars for navigation.

statusBars

Added in 1.5.0

public static int statusBars()

Returns
`int`	An insets type representing any system bars for displaying status.

systemBars

Added in 1.5.0

public static int systemBars()

Returns
`int`	All system bars. Includes `statusBars`, `captionBar` as well as `navigationBars`, `systemOverlays` but not `ime`.

systemGestures

Added in 1.5.0

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 SYSTEM_UI_FLAG_LAYOUT_STABLE is requested, an inset will be returned even when the system gestures are inactive due to SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION.

See also
`getSystemGestureInsets`

systemOverlays

Added in 1.16.0

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.

tappableElement

Added in 1.5.0

public static int tappableElement()

See also
`getTappableElementInsets`