WindowInsetsControllerCompat

Added in 1.5.0

class 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 types

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

Constants
const Int

The default option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.
const Int

This property is deprecated.

Use BEHAVIOR_DEFAULT instead.
const Int

This property is deprecated.

This is not supported on Android S and later.
const Int

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

Public constructors

Public functions
Unit

Adds a WindowInsetsController.OnControllableInsetsChangedListener to the window insets controller.
Unit
controlWindowInsetsAnimation(
    types: Int,
    durationMillis: Long,
    interpolator: Interpolator?,
    cancellationSignal: CancellationSignal?,
    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 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.
java-static WindowInsetsControllerCompat
@RequiresApi(value = 30)
toWindowInsetsControllerCompat(
    insetsController: WindowInsetsController
)

This function is deprecated.

Use getInsetsController instead

Constants

BEHAVIOR_DEFAULT

Added in 1.10.0
const val BEHAVIOR_DEFAULT = 1: Int

The default option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

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.

BEHAVIOR_SHOW_BARS_BY_SWIPE

Added in 1.5.0
Deprecated in 1.10.0
const val BEHAVIOR_SHOW_BARS_BY_SWIPE = 1: Int

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

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.

BEHAVIOR_SHOW_BARS_BY_TOUCH

Added in 1.5.0
Deprecated in 1.10.0
const val BEHAVIOR_SHOW_BARS_BY_TOUCH = 0: Int

Option for setSystemBarsBehavior. System bars will be forcibly shown on any user interaction on the corresponding display if navigation bars are hidden by hide or setInsetsAndAlpha.

BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE

Added in 1.5.0
const val BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE = 2: Int

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

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.

Public constructors

WindowInsetsControllerCompat

Added in 1.5.0
WindowInsetsControllerCompat(window: Window, view: View)

Public functions

addOnControllableInsetsChangedListener

Added in 1.5.0
fun addOnControllableInsetsChangedListener(
    listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener
): Unit

Adds a WindowInsetsController.OnControllableInsetsChangedListener to the window insets controller.

Parameters
listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener

The listener to add.
See also
WindowInsetsControllerCompat.OnControllableInsetsChangedListener
removeOnControllableInsetsChangedListener

controlWindowInsetsAnimation

Added in 1.5.0
fun controlWindowInsetsAnimation(
    types: Int,
    durationMillis: Long,
    interpolator: Interpolator?,
    cancellationSignal: CancellationSignal?,
    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 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 MILLISECONDS, or -1 if the animation doesn't have a predetermined duration. This value will be passed to 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 getInterpolator and used to calculate 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.
See also
getFraction
getInterpolatedFraction
getInterpolator
getDurationMillis

getSystemBarsBehavior

Added in 1.5.0
fun getSystemBarsBehavior(): Int

Retrieves the requested behavior of system bars.

Returns
Int

the system bar behavior controlled by this window.
See also
setSystemBarsBehavior

hide

Added in 1.5.0
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 onApplyWindowInsets and checking visibility with isVisible.

Parameters
types: Int

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

isAppearanceLightNavigationBars

Added in 1.5.0
fun isAppearanceLightNavigationBars(): Boolean

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

This method always returns false on API <26.

If this value is being set in the theme (via windowLightNavigationBar), then the correct value will only be returned once attached to the window.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

Returns
Boolean

true if the foreground is light
See also
setAppearanceLightNavigationBars

isAppearanceLightStatusBars

Added in 1.5.0
fun isAppearanceLightStatusBars(): Boolean

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

This method always returns false on API <23.

If this value is being set in the theme (via windowLightStatusBar), then the correct value will only be returned once attached to the window.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

Returns
Boolean

true if the foreground is light
See also
setAppearanceLightStatusBars

removeOnControllableInsetsChangedListener

Added in 1.5.0
fun removeOnControllableInsetsChangedListener(
    listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener
): Unit

Removes a WindowInsetsController.OnControllableInsetsChangedListener from the window insets controller.

Parameters
listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener

The listener to remove.
See also
WindowInsetsControllerCompat.OnControllableInsetsChangedListener
addOnControllableInsetsChangedListener

setAppearanceLightNavigationBars

Added in 1.5.0
fun setAppearanceLightNavigationBars(isLight: Boolean): Unit

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

This method has no effect on API <26.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

See also
isAppearanceLightNavigationBars

setAppearanceLightStatusBars

Added in 1.5.0
fun setAppearanceLightStatusBars(isLight: Boolean): Unit

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

This method has no effect on API <23.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

See also
isAppearanceLightStatusBars

setSystemBarsBehavior

Added in 1.5.0
fun setSystemBarsBehavior(behavior: Int): Unit

Controls the behavior of system bars.

Parameters
behavior: Int

Determines how the bars behave when being hidden by the application.
See also
getSystemBarsBehavior

show

Added in 1.5.0
fun show(types: Int): Unit

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 onApplyWindowInsets and checking visibility with isVisible.

Parameters
types: Int

A bitmask of WindowInsetsCompat.Type specifying what windows the app would like to make appear on screen.

toWindowInsetsControllerCompat

Added in 1.5.0
Deprecated in 1.8.0
@RequiresApi(value = 30)
java-static fun toWindowInsetsControllerCompat(
    insetsController: WindowInsetsController
): WindowInsetsControllerCompat

Wrap a WindowInsetsController into a WindowInsetsControllerCompat for compatibility purpose.

Parameters
insetsController: WindowInsetsController

The WindowInsetsController to wrap.
Returns
WindowInsetsControllerCompat

The provided WindowInsetsController wrapped into a WindowInsetsControllerCompat