FileDocCategorySizeDatePackage
WindowInsetsCompat.javaAPI DocAndroid 5.1 API8992Thu Mar 12 22:22:56 GMT 2015android.support.v4.view

WindowInsetsCompat

public class WindowInsetsCompat extends Object
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.

Fields Summary
Constructors Summary
WindowInsetsCompat()
Private ctor

Methods Summary
public android.support.v4.view.WindowInsetsCompatconsumeStableInsets()
Returns a copy of this WindowInsets with the stable insets fully consumed.

return
A modified copy of this WindowInsetsCompat

        return this;
    
public android.support.v4.view.WindowInsetsCompatconsumeSystemWindowInsets()
Returns a copy of this WindowInsets with the system window insets fully consumed.

return
A modified copy of this WindowInsets

        return this;
    
public intgetStableInsetBottom()
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.

return
The bottom stable inset

        return 0;
    
public intgetStableInsetLeft()
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.

return
The left stable inset

        return 0;
    
public intgetStableInsetRight()
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.

return
The right stable inset

        return 0;
    
public intgetStableInsetTop()
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.

return
The top stable inset

        return 0;
    
public intgetSystemWindowInsetBottom()
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.

return
The bottom system window inset

        return 0;
    
public intgetSystemWindowInsetLeft()
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.

return
The left system window inset

        return 0;
    
public intgetSystemWindowInsetRight()
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.

return
The right system window inset

        return 0;
    
public intgetSystemWindowInsetTop()
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.

return
The top system window inset

        return 0;
    
public booleanhasInsets()
Returns true if this WindowInsets has any nonzero insets.

return
true if any inset values are nonzero

        return false;
    
public booleanhasStableInsets()
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.

return
true if any of the stable inset values are nonzero

        return false;
    
public booleanhasSystemWindowInsets()
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.

return
true if any of the system window inset values are nonzero

        return false;
    
public booleanisConsumed()
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 {@link android.view.View#fitSystemWindows(android.graphics.Rect)}.

return
true if the insets have been fully consumed.

        return false;
    
public booleanisRound()
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.

return
True if the window is round

        return false;
    
public android.support.v4.view.WindowInsetsCompatreplaceSystemWindowInsets(int left, int top, int right, int bottom)
Returns a copy of this WindowInsets with selected system window insets replaced with new values.

param
left New left inset in pixels
param
top New top inset in pixels
param
right New right inset in pixels
param
bottom New bottom inset in pixels
return
A modified copy of this WindowInsets

        return this;
    
public android.support.v4.view.WindowInsetsCompatreplaceSystemWindowInsets(android.graphics.Rect systemWindowInsets)
Returns a copy of this WindowInsets with selected system window insets replaced with new values.

param
systemWindowInsets New system window insets. Each field is the inset in pixels for that edge
return
A modified copy of this WindowInsets

        return this;