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.
Summary
Public constructors | |
---|---|
WindowInsetsCompat(WindowInsetsCompat src)
Constructs a new WindowInsetsCompat, copying all values from a source WindowInsetsCompat. |
Public methods | |
---|---|
WindowInsetsCompat
|
consumeDisplayCutout()
Returns a copy of this WindowInsets with the cutout fully consumed. |
WindowInsetsCompat
|
consumeStableInsets()
Returns a copy of this WindowInsets with the stable insets fully consumed. |
WindowInsetsCompat
|
consumeSystemWindowInsets()
Returns a copy of this WindowInsets with the system window insets fully consumed. |
boolean
|
equals(Object o)
|
DisplayCutoutCompat
|
getDisplayCutout()
Returns the display cutout if there is one. |
Insets
|
getMandatorySystemGestureInsets()
Returns the mandatory system gesture insets. |
int
|
getStableInsetBottom()
Returns the bottom stable inset in pixels. |
int
|
getStableInsetLeft()
Returns the left stable inset in pixels. |
int
|
getStableInsetRight()
Returns the right stable inset in pixels. |
int
|
getStableInsetTop()
Returns the top stable inset in pixels. |
Insets
|
getStableInsets()
Returns the stable insets in pixels. |
Insets
|
getSystemGestureInsets()
Returns the system gesture insets. |
int
|
getSystemWindowInsetBottom()
Returns the bottom system window inset in pixels. |
int
|
getSystemWindowInsetLeft()
Returns the left system window inset in pixels. |
int
|
getSystemWindowInsetRight()
Returns the right system window inset in pixels. |
int
|
getSystemWindowInsetTop()
Returns the top system window inset in pixels. |
Insets
|
getSystemWindowInsets()
Returns the system window insets in pixels. |
Insets
|
getTappableElementInsets()
Returns the tappable element insets. |
boolean
|
hasInsets()
Returns true if this WindowInsets has any nonzero insets. |
boolean
|
hasStableInsets()
Returns true if this WindowInsets has nonzero stable insets. |
boolean
|
hasSystemWindowInsets()
Returns true if this WindowInsets has nonzero system window insets. |
int
|
hashCode()
|
boolean
|
isConsumed()
Check if these insets have been fully consumed. |
boolean
|
isRound()
Returns true if the associated window has a round shape. |
WindowInsetsCompat
|
replaceSystemWindowInsets(int left, int top, int right, int bottom)
Returns a copy of this WindowInsets with selected system window insets replaced with new values. |
WindowInsetsCompat
|
replaceSystemWindowInsets(Rect systemWindowInsets)
Returns a copy of this WindowInsets with selected system window insets replaced with new values. |
WindowInsets
|
toWindowInsets()
Return the source |
static
WindowInsetsCompat
|
toWindowInsetsCompat(WindowInsets insets)
Wrap an instance of |
Inherited methods | |
---|---|
Public constructors
WindowInsetsCompat
public WindowInsetsCompat (WindowInsetsCompat src)
Constructs a new WindowInsetsCompat, copying all values from a source WindowInsetsCompat.
Parameters | |
---|---|
src |
WindowInsetsCompat : source from which values are copied
|
Public methods
consumeDisplayCutout
public WindowInsetsCompat consumeDisplayCutout ()
Returns a copy of this WindowInsets with the cutout fully consumed.
Returns | |
---|---|
WindowInsetsCompat |
A modified copy of this WindowInsets |
consumeStableInsets
public WindowInsetsCompat consumeStableInsets ()
Returns a copy of this WindowInsets with the stable insets fully consumed.
Returns | |
---|---|
WindowInsetsCompat |
A modified copy of this WindowInsetsCompat |
consumeSystemWindowInsets
public WindowInsetsCompat consumeSystemWindowInsets ()
Returns a copy of this WindowInsets with the system window insets fully consumed.
Returns | |
---|---|
WindowInsetsCompat |
A modified copy of this WindowInsets |
equals
public boolean equals (Object o)
Parameters | |
---|---|
o |
Object |
Returns | |
---|---|
boolean |
getDisplayCutout
public DisplayCutoutCompat getDisplayCutout ()
Returns the display cutout if there is one.
Returns | |
---|---|
DisplayCutoutCompat |
the display cutout or null if there is none |
See also:
getMandatorySystemGestureInsets
public Insets getMandatorySystemGestureInsets ()
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.
Returns | |
---|---|
Insets |
getStableInsetBottom
public 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
public 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
public 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
public 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 |
getStableInsets
public Insets getStableInsets ()
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.
Returns | |
---|---|
Insets |
The stable insets |
getSystemGestureInsets
public Insets getSystemGestureInsets ()
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(List
outside of the
mandatory system gesture insets
.
Returns | |
---|---|
Insets |
See also:
getSystemWindowInsetBottom
public 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
public 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
public 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
public 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 |
getSystemWindowInsets
public Insets getSystemWindowInsets ()
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.
Returns | |
---|---|
Insets |
The system window insets |
getTappableElementInsets
public Insets getTappableElementInsets ()
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).
Returns | |
---|---|
Insets |
See also:
hasInsets
public boolean hasInsets ()
Returns true if this WindowInsets has any nonzero insets.
Returns | |
---|---|
boolean |
true if any inset values are nonzero |
hasStableInsets
public 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
public 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
public int hashCode ()
Returns | |
---|---|
int |
isConsumed
public 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.
The result of this method is equivalent to the return value of
View.fitSystemWindows(android.graphics.Rect)
.
Returns | |
---|---|
boolean |
true if the insets have been fully consumed. |
isRound
public 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.
Returns | |
---|---|
boolean |
True if the window is round |
replaceSystemWindowInsets
public WindowInsetsCompat replaceSystemWindowInsets (int left, int top, int right, int bottom)
Returns a copy of this WindowInsets with selected system window insets replaced with new values.
Parameters | |
---|---|
left |
int : New left inset in pixels |
top |
int : New top inset in pixels |
right |
int : New right inset in pixels |
bottom |
int : New bottom inset in pixels |
Returns | |
---|---|
WindowInsetsCompat |
A modified copy of this WindowInsets |
replaceSystemWindowInsets
public WindowInsetsCompat replaceSystemWindowInsets (Rect systemWindowInsets)
Returns a copy of this WindowInsets with selected system window insets replaced with new values.
Parameters | |
---|---|
systemWindowInsets |
Rect : New system window insets. Each field is the inset in pixels
for that edge |
Returns | |
---|---|
WindowInsetsCompat |
A modified copy of this WindowInsets |
toWindowInsets
public WindowInsets toWindowInsets ()
Return the source WindowInsets
instance used in this WindowInsetsCompat
.
Returns | |
---|---|
WindowInsets |
the wrapped WindowInsets instance |
toWindowInsetsCompat
public static WindowInsetsCompat toWindowInsetsCompat (WindowInsets insets)
Wrap an instance of WindowInsets
into a WindowInsetsCompat
.
Parameters | |
---|---|
insets |
WindowInsets : source insets to wrap |
Returns | |
---|---|
WindowInsetsCompat |
the wrapped instance |