Skip to content

Most visited

Recently visited

navigation

WindowInsetsCompat

public class WindowInsetsCompat
extends Object

java.lang.Object
   ↳ android.support.v4.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 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)

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

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.

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.

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()

Returns a hash code value for the object.

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.

Inherited methods

From class java.lang.Object

Public constructors

WindowInsetsCompat

added in version 24.2.0
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

consumeStableInsets

added in version 22.0.0
WindowInsetsCompat consumeStableInsets ()

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

Returns
WindowInsetsCompat A modified copy of this WindowInsetsCompat

consumeSystemWindowInsets

added in version 22.0.0
WindowInsetsCompat consumeSystemWindowInsets ()

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

Returns
WindowInsetsCompat A modified copy of this WindowInsets

equals

boolean equals (Object o)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getStableInsetBottom

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
boolean hasInsets ()

Returns true if this WindowInsets has any nonzero insets.

Returns
boolean true if any inset values are nonzero

hasStableInsets

added in version 22.0.0
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

added in version 22.0.0
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 a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isConsumed

added in version 22.0.0
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 fitSystemWindows(android.graphics.Rect).

Returns
boolean true if the insets have been fully consumed.

isRound

added in version 22.0.0
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

added in version 22.0.0
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

added in version 22.0.0
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

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.