WindowInsetsAnimationControlListenerCompat

Added in 1.5.0

public interface WindowInsetsAnimationControlListenerCompat

Listener that encapsulates a request to controlWindowInsetsAnimation.

Insets can be controlled with the supplied WindowInsetsAnimationControllerCompat from onReady until either onFinished or onCancelled.

Once the control over insets is finished or cancelled, it will not be regained until a new request to controlWindowInsetsAnimation is made.

The request to control insets can fail immediately. In that case onCancelled will be invoked without a preceding onReady.

See also
controlWindowInsetsAnimation

Summary

Public methods
abstract void

Called when the request for control over the insets has been cancelled, either because the android.os.CancellationSignal associated with the request has been invoked, or the window has lost control over the insets (e.g. because it lost focus).
abstract void

Called when the request for control over the insets has finished.
abstract void
onReady(
    @NonNull WindowInsetsAnimationControllerCompat controller,
    int types
)

Called when the animation is ready to be controlled.

Public methods

onCancelled

Added in 1.5.0
abstract void onCancelled(@Nullable WindowInsetsAnimationControllerCompat controller)

Called when the request for control over the insets has been cancelled, either because the android.os.CancellationSignal associated with the request has been invoked, or the window has lost control over the insets (e.g. because it lost focus).

Once this callback is invoked, the supplied WindowInsetsAnimationControllerCompat is no longer ready.

Control will not be regained until a new request to controlWindowInsetsAnimation is made.

Parameters
@Nullable WindowInsetsAnimationControllerCompat controller

the controller which has been cancelled, or null if the request was cancelled before onReady was invoked.
See also
isCancelled

onFinished

Added in 1.5.0
abstract void onFinished(@NonNull WindowInsetsAnimationControllerCompat controller)

Called when the request for control over the insets has finished.

Once this callback is invoked, the supplied WindowInsetsAnimationControllerCompat is no longer ready.

Control will not be regained until a new request to controlWindowInsetsAnimation is made.

Parameters
@NonNull WindowInsetsAnimationControllerCompat controller

the controller which has finished.
See also
isFinished

onReady

Added in 1.5.0
abstract void onReady(
    @NonNull WindowInsetsAnimationControllerCompat controller,
    int types
)

Called when the animation is ready to be controlled. This may be delayed when the IME needs to redraw because of an EditorInfo change, or when the window is starting up.

Parameters
@NonNull WindowInsetsAnimationControllerCompat controller

The controller to control the inset animation.
int types

The Types it was able to gain control over. Note that this may be different than the types passed into controlWindowInsetsAnimation in case the window wasn't able to gain the controls because it wasn't the IME target or not currently the window that's controlling the system bars.
See also
isReady