WindowInsetsCompat.Builder

Builder()

Creates a builder where all insets are initially consumed.

Builder(insets: WindowInsetsCompat)

Creates a builder where all insets are initialized from WindowInsetsCompat.

fun build(): WindowInsetsCompat

Builds a WindowInsetsCompat instance.

fun setDisplayCutout(displayCutout: DisplayCutoutCompat?): WindowInsetsCompat.Builder

Sets the display cutout.

The cutout passed will only take effect when running on API 29 and above.

fun setInsets(typeMask: Int, insets: Insets): WindowInsetsCompat.Builder

Sets the insets of a specific window type in pixels.

The insets represents the area of a a window that is partially or fully obscured by the system windows identified by typeMask.

fun setInsetsIgnoringVisibility(typeMask: Int, insets: Insets): WindowInsetsCompat.Builder

Sets the insets a specific window type in pixels, while ignoring its visibility state.

The insets represents the area of a a window that that may be partially or fully obscured by the system window identified by typeMask. This value does not change based on the visibility state of those elements. For example, if the status bar is normally shown, but temporarily hidden, the inset returned here will still provide the inset associated with the status bar being shown.

fun setMandatorySystemGestureInsets(insets: Insets): WindowInsetsCompat.Builder

Sets mandatory system gesture insets in pixels.

The mandatory system gesture insets represent the area of a window where mandatory 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.

In contrast to regular system gestures, mandatory system gestures cannot be overridden by setSystemGestureExclusionRects.

The insets passed will only take effect when running on API 29 and above.

fun setStableInsets(insets: Insets): WindowInsetsCompat.Builder

Sets the stable insets in pixels.

The stable inset represents the area of a full-screen window that may be partially or fully obscured by the system UI elements. This value does not change based on the visibility state of those elements; for example, if the status bar is normally shown, but temporarily hidden, the stable inset will still provide the inset associated with the status bar being shown.

The insets passed will only take effect when running on API 29 and above.

fun setSystemGestureInsets(insets: Insets): WindowInsetsCompat.Builder

Sets system gesture insets in pixels.

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.

The insets passed will only take effect when running on API 29 and above.

fun setSystemWindowInsets(insets: Insets): WindowInsetsCompat.Builder

Sets system window insets in pixels.

The system window inset represents the area of a full-screen window that is partially or fully obscured by the status bar, navigation bar, IME or other system windows.

fun setTappableElementInsets(insets: Insets): WindowInsetsCompat.Builder

Sets tappable element insets in pixels.

The tappable element insets represent how much tappable elements must at least be inset to remain both tappable and visually unobstructed by persistent system windows.

The insets passed will only take effect when running on API 29 and above.

fun setVisible(typeMask: Int, visible: Boolean): WindowInsetsCompat.Builder

Sets whether windows that can cause insets are currently visible on screen.