WindowInsetsController

APPEARANCE_LIGHT_CAPTION_BARS

public static final int APPEARANCE_LIGHT_CAPTION_BARS

When WindowInsetsController.APPEARANCE_TRANSPARENT_CAPTION_BAR_BACKGROUND is set, changes the foreground color of the caption bars so that the items on the bar can be read clearly on light backgrounds.

Constant Value: 256 (0x00000100)

APPEARANCE_LIGHT_NAVIGATION_BARS

public static final int APPEARANCE_LIGHT_NAVIGATION_BARS

Changes the foreground color for light navigation bars so that the items on the bar can be read clearly.

Constant Value: 16 (0x00000010)

APPEARANCE_LIGHT_STATUS_BARS

public static final int APPEARANCE_LIGHT_STATUS_BARS

Changes the foreground color for light status bars so that the items on the bar can be read clearly.

Constant Value: 8 (0x00000008)

APPEARANCE_TRANSPARENT_CAPTION_BAR_BACKGROUND

public static final int APPEARANCE_TRANSPARENT_CAPTION_BAR_BACKGROUND

Makes the caption bar transparent.

Constant Value: 128 (0x00000080)

BEHAVIOR_DEFAULT

public static final int BEHAVIOR_DEFAULT

The default option for setSystemBarsBehavior(int): Window would like to remain interactive when hiding navigation bars by calling hide(int) or WindowInsetsAnimationController.setInsetsAndAlpha(Insets, float, float).

When system bars are hidden in this mode, they can be revealed with system gestures, such as swiping from the edge of the screen where the bar is hidden from.

When the gesture navigation is enabled, the system gestures can be triggered regardless the visibility of system bars.

Constant Value: 1 (0x00000001)

BEHAVIOR_SHOW_BARS_BY_SWIPE

public static final int BEHAVIOR_SHOW_BARS_BY_SWIPE

This constant was deprecated in API level 31.
Use BEHAVIOR_DEFAULT instead.

Option for setSystemBarsBehavior(int): Window would like to remain interactive when hiding navigation bars by calling hide(int) or WindowInsetsAnimationController.setInsetsAndAlpha(Insets, float, float).

When system bars are hidden in this mode, they can be revealed with system gestures, such as swiping from the edge of the screen where the bar is hidden from.

Constant Value: 1 (0x00000001)

BEHAVIOR_SHOW_BARS_BY_TOUCH

public static final int BEHAVIOR_SHOW_BARS_BY_TOUCH

This constant was deprecated in API level 31.
This is not supported on Android Build.VERSION_CODES.S and later. Use BEHAVIOR_DEFAULT or BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE instead.

Option for setSystemBarsBehavior(int). System bars will be forcibly shown on any user interaction on the corresponding display if navigation bars are hidden by hide(int) or WindowInsetsAnimationController.setInsetsAndAlpha(Insets, float, float).

Constant Value: 0 (0x00000000)

BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE

public static final int BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE

Option for setSystemBarsBehavior(int): Window would like to remain interactive when hiding navigation bars by calling hide(int) or WindowInsetsAnimationController.setInsetsAndAlpha(Insets, float, float).

When system bars are hidden in this mode, they can be revealed temporarily with system gestures, such as swiping from the edge of the screen where the bar is hidden from. These transient system bars will overlay app\u2019s content, may have some degree of transparency, and will automatically hide after a short timeout.

Constant Value: 2 (0x00000002)

addOnControllableInsetsChangedListener

public abstract void addOnControllableInsetsChangedListener (WindowInsetsController.OnControllableInsetsChangedListener listener)

Adds a OnControllableInsetsChangedListener to the window insets controller.

controlWindowInsetsAnimation

public abstract void controlWindowInsetsAnimation (int types, 
                long durationMillis, 
                Interpolator interpolator, 
                CancellationSignal cancellationSignal, 
                WindowInsetsAnimationControlListener listener)

Lets the application control window inset animations in a frame-by-frame manner by modifying the position of the windows in the system causing insets directly.

getSystemBarsAppearance

public abstract int getSystemBarsAppearance ()

Retrieves the requested appearance of system bars.

getSystemBarsBehavior

public abstract int getSystemBarsBehavior ()

Retrieves the requested behavior of system bars.

hide

public abstract void hide (int types)

Makes a set of windows causing insets disappear.

Note that if the window currently doesn't have control over a certain type, it will apply the change as soon as the window gains control. The app can listen to the event by observing View.onApplyWindowInsets and checking visibility with WindowInsets.isVisible.

removeOnControllableInsetsChangedListener

public abstract void removeOnControllableInsetsChangedListener (WindowInsetsController.OnControllableInsetsChangedListener listener)

Removes a OnControllableInsetsChangedListener from the window insets controller.

setSystemBarsAppearance

public abstract void setSystemBarsAppearance (int appearance, 
                int mask)

Controls the appearance of system bars.

For example, the following statement adds APPEARANCE_LIGHT_STATUS_BARS:

 setSystemBarsAppearance(APPEARANCE_LIGHT_STATUS_BARS, APPEARANCE_LIGHT_STATUS_BARS)
 

 setSystemBarsAppearance(0, APPEARANCE_LIGHT_STATUS_BARS)
 

setSystemBarsBehavior

public abstract void setSystemBarsBehavior (int behavior)

Controls the behavior of system bars.

show

public abstract void show (int types)

Makes a set of windows that cause insets appear on screen.

Note that if the window currently doesn't have control over a certain type, it will apply the change as soon as the window gains control. The app can listen to the event by observing View.onApplyWindowInsets and checking visibility with WindowInsets.isVisible.