Google is committed to advancing racial equity for Black communities. See how.

WindowInsetsControllerCompat

class WindowInsetsControllerCompat
kotlin.Any
   ↳ androidx.core.view.WindowInsetsControllerCompat

Provide simple controls of windows that generate insets. For SDKs >= 30, this class is a simple wrapper around WindowInsetsController. For lower SDKs, this class aims to behave as close as possible to the original implementation.

Summary

Nested classes
abstract

Listener to be notified when the set of controllable WindowInsetsCompat.Type controlled by a WindowInsetsController changes.

Constants
static Int

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

static Int

The default option for setSystemBarsBehavior(int).

static Int

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

Public constructors
<init>(@NonNull window: Window, @NonNull view: View)

Public methods
Unit

Adds a WindowInsetsController.OnControllableInsetsChangedListener to the window insets controller.

Unit
controlWindowInsetsAnimation(types: Int, durationMillis: Long, @Nullable interpolator: Interpolator?, @Nullable cancellationSignal: CancellationSignal?, @NonNull listener: WindowInsetsAnimationControlListenerCompat)

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 using WindowInsetsAnimationControllerCompat#setInsetsAndAlpha in the controller provided by the given listener.

Int

Retrieves the requested behavior of system bars.

Unit
hide(types: Int)

Makes a set of windows causing insets disappear.

Boolean

Checks if the foreground of the navigation bar is set to light.

Boolean

Checks if the foreground of the status bar is set to light.

Unit

Removes a WindowInsetsController.OnControllableInsetsChangedListener from the window insets controller.

Unit

If true, changes the foreground color of the navigation bars to light so that the items on the bar can be read clearly.

Unit

If true, changes the foreground color of the status bars to light so that the items on the bar can be read clearly.

Unit

Controls the behavior of system bars.

Unit
show(types: Int)

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

static WindowInsetsControllerCompat

Wrap a WindowInsetsController into a WindowInsetsControllerCompat for compatibility purpose.

Constants

BEHAVIOR_SHOW_BARS_BY_SWIPE

static val BEHAVIOR_SHOW_BARS_BY_SWIPE: Int

Option for setSystemBarsBehavior(int): Window would like to remain interactive when hiding navigation bars by calling hide(int) or WindowInsetsAnimationControllerCompat#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.

Value: 1

BEHAVIOR_SHOW_BARS_BY_TOUCH

static val BEHAVIOR_SHOW_BARS_BY_TOUCH: Int

The default 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 WindowInsetsAnimationControllerCompat#setInsetsAndAlpha(Insets, float, float).

Value: 0

BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE

static val BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE: Int

Option for setSystemBarsBehavior(int): Window would like to remain interactive when hiding navigation bars by calling hide(int) or WindowInsetsAnimationControllerCompat#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’s content, may have some degree of transparency, and will automatically hide after a short timeout.

Value: 2

Public constructors

<init>

WindowInsetsControllerCompat(
    @NonNull window: Window,
    @NonNull view: View)

Public methods

controlWindowInsetsAnimation

fun controlWindowInsetsAnimation(
    types: Int,
    durationMillis: Long,
    @Nullable interpolator: Interpolator?,
    @Nullable cancellationSignal: CancellationSignal?,
    @NonNull listener: WindowInsetsAnimationControlListenerCompat
): Unit

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 using WindowInsetsAnimationControllerCompat#setInsetsAndAlpha in the controller provided by the given listener.

This method only works on API >= 30 since there is no way to control the window in the system on prior APIs.

Parameters
types Int: The WindowInsetsCompat.Types the application has requested to control.
durationMillis Long: Duration of animation in TimeUnit#MILLISECONDS, or -1 if the animation doesn't have a predetermined duration. This value will be passed to WindowInsetsAnimationCompat#getDurationMillis()
interpolator Interpolator?: The interpolator used for this animation, or null if this animation doesn't follow an interpolation curve. This value will be passed to WindowInsetsAnimationCompat#getInterpolator() and used to calculate WindowInsetsAnimationCompat#getInterpolatedFraction().
cancellationSignal CancellationSignal?: A cancellation signal that the caller can use to cancel the request to obtain control, or once they have control, to cancel the control.
listener WindowInsetsAnimationControlListenerCompat: The WindowInsetsAnimationControlListener that gets called when the windows are ready to be controlled, among other callbacks.

getSystemBarsBehavior

fun getSystemBarsBehavior(): Int

Retrieves the requested behavior of system bars.

Return
Int the system bar behavior controlled by this window.

hide

fun hide(types: Int): Unit

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.

Parameters
types Int: A bitmask of WindowInsetsCompat.Type specifying what windows the app would like to make disappear.

isAppearanceLightNavigationBars

fun isAppearanceLightNavigationBars(): Boolean

Checks if the foreground of the navigation bar is set to light.

This method always returns false on API < 26.

Return
Boolean true if the foreground is light

isAppearanceLightStatusBars

fun isAppearanceLightStatusBars(): Boolean

Checks if the foreground of the status bar is set to light.

This method always returns false on API < 23.

Return
Boolean true if the foreground is light

removeOnControllableInsetsChangedListener

fun removeOnControllableInsetsChangedListener(@NonNull