WindowInsetsCompat

public
class
WindowInsetsCompat
extends Object

java.lang.Object

↳

androidx.core.view.WindowInsetsCompat

Describes a set of insets for window content.

WindowInsetsCompats are immutable and may be expanded to include more inset types in the
future. To adjust insets, use one of the supplied clone methods to obtain a new
WindowInsetsCompat instance with the adjusted properties.

getDisplayCutout

getStableInsetBottom

int getStableInsetBottom ()

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.

Returns

int

The bottom stable inset

getStableInsetLeft

int getStableInsetLeft ()

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.

Returns

int

The left stable inset

getStableInsetRight

int getStableInsetRight ()

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.

Returns

int

The right stable inset

getStableInsetTop

int getStableInsetTop ()

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.

Returns

int

The top stable inset

getSystemWindowInsetBottom

int getSystemWindowInsetBottom ()

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.

Returns

int

The bottom system window inset

getSystemWindowInsetLeft

int getSystemWindowInsetLeft ()

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.

Returns

int

The left system window inset

getSystemWindowInsetRight

int getSystemWindowInsetRight ()

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.

Returns

int

The right system window inset

getSystemWindowInsetTop

int getSystemWindowInsetTop ()

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.

Returns

int

The top system window inset

hasInsets

boolean hasInsets ()

Returns true if this WindowInsets has any nonzero insets.

Returns

boolean

true if any inset values are nonzero

hasStableInsets

boolean hasStableInsets ()

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.

Returns

boolean

true if any of the stable inset values are nonzero

hasSystemWindowInsets

boolean hasSystemWindowInsets ()

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.

Returns

boolean

true if any of the system window inset values are nonzero

hashCode

int hashCode ()

Returns

int

isConsumed

boolean isConsumed ()

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.

isRound

boolean isRound ()

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.