WindowInsets

WindowInsets

WindowInsets(src: WindowInsets!)

Construct a new WindowInsets, copying all values from a source WindowInsets.

consumeDisplayCutout

fun consumeDisplayCutout(): WindowInsets

Deprecated: Consuming of different parts individually of a WindowInsets instance is deprecated, since WindowInsets contains many different insets. Use CONSUMED instead to stop dispatching insets.

Returns a copy of this WindowInsets with the cutout fully consumed.

consumeStableInsets

fun consumeStableInsets(): WindowInsets

Deprecated: Consuming of different parts individually of a WindowInsets instance is deprecated, since WindowInsets contains many different insets. Use CONSUMED instead to stop dispatching insets. On R, this method has no effect.

Returns a copy of this WindowInsets with the stable insets fully consumed.

consumeSystemWindowInsets

fun consumeSystemWindowInsets(): WindowInsets

Deprecated: Consuming of different parts individually of a WindowInsets instance is deprecated, since WindowInsets contains many different insets. Use CONSUMED instead to stop dispatching insets.

Returns a copy of this WindowInsets with the system window insets fully consumed.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getBoundingRects

fun getBoundingRects(typeMask: Int): MutableList<Rect!>

Returns a list of Rects, each of which is the bounding rectangle for an area that is being partially or fully obscured inside the window.

May be used with or instead of Insets for finer avoidance of regions that may be partially obscuring the window but may be smaller than those provided by getInsets(int).

The Rects returned are always cropped to the bounds of the window frame and their coordinate values are relative to the getFrame(), regardless of the window's position on screen.

If inset by inset(android.graphics.Insets), bounding rects that intersect with the provided insets will be resized to only include the intersection with the remaining frame. Bounding rects may be completely removed if they no longer intersect with the new instance.

getBoundingRectsIgnoringVisibility

fun getBoundingRectsIgnoringVisibility(typeMask: Int): MutableList<Rect!>

Returns a list of Rects, each of which is the bounding rectangle for an area that can be partially or fully obscured inside the window, regardless of whether that type is currently visible or not.

The bounding rects represent areas of a window that may be partially or fully obscured by the type. 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 bounding rects returned here will provide the rects associated with the status bar being shown.

May be used with or instead of Insets for finer avoidance of regions that may be partially obscuring the window but may be smaller than those provided by getInsetsIgnoringVisibility(int).

The Rects returned are always cropped to the bounds of the window frame and their coordinate values are relative to the getFrame(), regardless of the window's position on screen.

getDisplayCutout

fun getDisplayCutout(): DisplayCutout?

Returns the display cutout if there is one.

Note: the display cutout will already be consumed during dispatch to View.onApplyWindowInsets, unless the window has requested a WindowManager.LayoutParams.layoutInDisplayCutoutMode other than never or default.

getDisplayShape

fun getDisplayShape(): DisplayShape?

Returns the display shape in the coordinate space of the window.

getFrame

fun getFrame(): Size

Returns the assumed size of the window, relative to which the getInsets and getBoundingRects have been calculated.

May be used with getBoundingRects to better understand their position within the window, such as the area between the edge of a bounding rect and the edge of the window.

Note: the size may not match the actual size of the window, which is determined during the layout pass - as WindowInsets are dispatched before layout.

Caution: using this value in determining the actual window size may make the result of layout passes unstable and should be avoided.

getInsets

fun getInsets(typeMask: Int): Insets

Returns the insets of a specific set of windows causing insets, denoted by the typeMask bit mask of Types.

getInsetsIgnoringVisibility

fun getInsetsIgnoringVisibility(typeMask: Int): Insets

Returns the insets a specific set of windows can cause, denoted by the typeMask bit mask of Types, regardless of whether that type is currently visible or not.

The insets represents the area of a a window that that may be partially or fully obscured by the system window identified by type. 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.

getMandatorySystemGestureInsets

fun getMandatorySystemGestureInsets(): Insets

Deprecated: Use getInsets(int) with Type.mandatorySystemGestures() instead.

Returns the mandatory system gesture insets.

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 overriden by View.setSystemGestureExclusionRects.

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.

This inset is consumed together with the system window insets by consumeSystemWindowInsets().

getPrivacyIndicatorBounds

fun getPrivacyIndicatorBounds(): Rect?

Returns the Rect of the maximum bounds of the system privacy indicator, for the current orientation, in relative coordinates, or null if the bounds have not been loaded yet.

The privacy indicator bounds are determined by SystemUI, and subsequently loaded once the StatusBar window has been created and attached. The bounds for all rotations are calculated and loaded at once, and this value is only expected to ever change on display or font scale changes. As long as there is a StatusBar window, this value should not be expected to be null.

The privacy indicator shows over apps when an app uses the microphone or camera permissions, while an app is in immersive mode.

getRoundedCorner

fun getRoundedCorner(position: Int): RoundedCorner?

Returns the RoundedCorner of the given position if there is one.

getStableInsetBottom

fun getStableInsetBottom(): Int

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns the bottom stable inset 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.

getStableInsetLeft

fun getStableInsetLeft(): Int

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns the left stable inset 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.

getStableInsetRight

fun getStableInsetRight(): Int

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns the right stable inset 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.

getStableInsetTop

fun getStableInsetTop(): Int

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns the top stable inset 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.

getStableInsets

fun getStableInsets(): Insets

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns 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.

getSystemGestureInsets

fun getSystemGestureInsets(): Insets

Deprecated: Use getInsets(int) with Type.systemGestures() instead.

Returns 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.

An app can declare priority over system gestures with View.setSystemGestureExclusionRects outside of the mandatory system gesture insets.

Note: the system will put a limit of 200dp on the vertical extent of the exclusions it takes into account. The limit does not apply while the navigation bar is stickily hidden, nor to the input method and home activity.

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.

This inset is consumed together with the system window insets by consumeSystemWindowInsets().

getSystemWindowInsetBottom

fun getSystemWindowInsetBottom(): Int

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns the bottom system window inset 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.

getSystemWindowInsetLeft

fun getSystemWindowInsetLeft(): Int

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns the left system window inset 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.

getSystemWindowInsetRight

fun getSystemWindowInsetRight(): Int

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns the right system window inset 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.

getSystemWindowInsetTop

fun getSystemWindowInsetTop(): Int

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns the top system window inset 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.

getSystemWindowInsets

fun getSystemWindowInsets(): Insets

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns the 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.

getTappableElementInsets

fun getTappableElementInsets(): Insets

Deprecated: Use getInsets(int) with Type.tappableElement() instead.

Returns the tappable element insets.

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.

This may be smaller than getSystemWindowInsets() if the system window is largely transparent and lets through simple taps (but not necessarily more complex gestures).

Note that generally, tappable elements should be aligned with the system window insets instead to avoid overlapping with the system bars.

When View.SYSTEM_UI_FLAG_LAYOUT_STABLE is requested, an inset will be returned even when the area covered by the inset would be tappable due to View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION.

This inset is consumed together with the system window insets by consumeSystemWindowInsets().

hasInsets

fun hasInsets(): Boolean

Returns true if this WindowInsets has any nonzero insets.

hasStableInsets

fun hasStableInsets(): Boolean

Deprecated: Use getInsetsIgnoringVisibility(int) with Type.systemBars() instead.

Returns true if this WindowInsets has nonzero stable insets.

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.

hasSystemWindowInsets

fun hasSystemWindowInsets(): Boolean

Deprecated: Use getInsets(int) with Type.systemBars() instead.

Returns true if this WindowInsets has nonzero system window insets.

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.

hashCode

fun hashCode(): Int

inset

fun inset(insets: Insets): WindowInsets

Returns a copy of this instance inset in the given directions. This is intended for dispatching insets to areas of the window that are smaller than the current area.

Example:

childView.dispatchApplyWindowInsets(insets.inset(childMargins));
  

inset

fun inset(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): WindowInsets

Returns a copy of this instance inset in the given directions. This is intended for dispatching insets to areas of the window that are smaller than the current area.

Example:

childView.dispatchApplyWindowInsets(insets.inset(
          childMarginLeft, childMarginTop, childMarginBottom, childMarginRight));
  

isConsumed

fun isConsumed(): Boolean

Check if these insets have been fully consumed.

Insets are considered "consumed" if the applicable consume* methods have been called such that all insets have been set to zero. This affects propagation of insets through the view hierarchy; insets that have not been fully consumed will continue to propagate down to child views.

The result of this method is equivalent to the return value of View.fitSystemWindows(android.graphics.Rect).

isRound

fun isRound(): Boolean

Returns true if the associated window has a round shape.

A round window's left, top, right and bottom edges reach all the way to the associated edges of the window but the corners may not be visible. Views responding to round insets should take care to not lay out critical elements within the corners where they may not be accessible.

isVisible

fun isVisible(typeMask: Int): Boolean

Returns whether a set of windows that may cause insets is currently visible on screen, regardless of whether it actually overlaps with this window.

replaceSystemWindowInsets

fun replaceSystemWindowInsets(systemWindowInsets: Rect!): WindowInsets

Deprecated: use Builder#Builder(WindowInsets) with Builder.setSystemWindowInsets(Insets) instead.

Returns a copy of this WindowInsets with selected system window insets replaced with new values.

Note: If the system window insets are already consumed, this method will return them unchanged on Q and later. Prior to Q, the new values were applied regardless of whether they were consumed, and this method returns invalid non-zero consumed insets.

replaceSystemWindowInsets

fun replaceSystemWindowInsets(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): WindowInsets

Deprecated: use Builder#Builder(WindowInsets) with Builder.setSystemWindowInsets(Insets) instead.

Returns a copy of this WindowInsets with selected system window insets replaced with new values.

Note: If the system window insets are already consumed, this method will return them unchanged on Q and later. Prior to Q, the new values were applied regardless of whether they were consumed, and this method returns invalid non-zero consumed insets.

toString

fun toString(): String

CONSUMED

static val CONSUMED: WindowInsets

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.