Most visited

Recently visited

Results for

Summary: Methods | Inherited Methods | [Expand All]

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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

consumeStableInsets

WindowInsetsCompat consumeStableInsets ()

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

Returns
`WindowInsetsCompat`	A modified copy of this WindowInsetsCompat

consumeSystemWindowInsets

WindowInsetsCompat consumeSystemWindowInsets ()

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

Returns
`WindowInsetsCompat`	A modified copy of this WindowInsets

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.

Returns
`int`	The left stable inset

getStableInsetRight

int getStableInsetRight ()

Returns the right stable inset in pixels.

Returns
`int`	The right stable inset

getStableInsetTop

int getStableInsetTop ()

Returns the top stable inset in pixels.

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.

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

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.

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

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

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

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

Annotations

Interfaces

Classes

Most visited

Recently visited

Results for

WindowInsetsCompat

Summary

Public methods

Inherited methods

Public methods

consumeStableInsets

consumeSystemWindowInsets

getStableInsetBottom

getStableInsetLeft

getStableInsetRight

getStableInsetTop

getSystemWindowInsetBottom

getSystemWindowInsetLeft

getSystemWindowInsetRight

getSystemWindowInsetTop

hasInsets

hasStableInsets

hasSystemWindowInsets

isConsumed

isRound

replaceSystemWindowInsets

replaceSystemWindowInsets