WindowInsetsAnimationControlListener
public
interface
WindowInsetsAnimationControlListener
android.view.WindowInsetsAnimationControlListener |
Listener that encapsulates a request to
WindowInsetsController#controlWindowInsetsAnimation
.
Insets can be controlled with the supplied WindowInsetsAnimationController
from
onReady(WindowInsetsAnimationController, int)
until either onFinished(WindowInsetsAnimationController)
or onCancelled(WindowInsetsAnimationController)
.
Once the control over insets is finished or cancelled, it will not be regained until a new
request to WindowInsetsController#controlWindowInsetsAnimation
is made.
The request to control insets can fail immediately. In that case onCancelled(WindowInsetsAnimationController)
will be
invoked without a preceding onReady(WindowInsetsAnimationController, int)
.
Summary
Public methods | |
---|---|
abstract
void
|
onCancelled(WindowInsetsAnimationController controller)
Called when the request for control over the insets has been cancelled, either
because the |
abstract
void
|
onFinished(WindowInsetsAnimationController controller)
Called when the request for control over the insets has
|
abstract
void
|
onReady(WindowInsetsAnimationController controller, int types)
Called when the animation is ready to be controlled. |
Public methods
onCancelled
public abstract void onCancelled (WindowInsetsAnimationController controller)
Called when the request for control over the insets has been cancelled, either
because the 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 WindowInsetsAnimationController
is no longer ready
.
Control will not be regained until a new request
to WindowInsetsController#controlWindowInsetsAnimation
is made.
Parameters | |
---|---|
controller |
WindowInsetsAnimationController : the controller which has been cancelled, or null if the request
was cancelled before onReady(WindowInsetsAnimationController, int) was invoked. |
onFinished
public abstract void onFinished (WindowInsetsAnimationController controller)
Called when the request for control over the insets has
finished
.
Once this callback is invoked, the supplied WindowInsetsAnimationController
is no longer ready
.
Control will not be regained until a new request
to WindowInsetsController#controlWindowInsetsAnimation
is made.
Parameters | |
---|---|
controller |
WindowInsetsAnimationController : the controller which has finished.
This value cannot be null . |
onReady
public abstract void onReady (WindowInsetsAnimationController 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 | |
---|---|
controller |
WindowInsetsAnimationController : The controller to control the inset animation.
This value cannot be null . |
types |
int : The WindowInsets.Type s it was able to gain control over. Note that this
may be different than the types passed into
WindowInsetsController#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.
Value is either 0 or a combination of android.view.WindowInsets.Type.STATUS_BARS, android.view.WindowInsets.Type.NAVIGATION_BARS, android.view.WindowInsets.Type.CAPTION_BAR, android.view.WindowInsets.Type.IME, android.view.WindowInsets.Type.WINDOW_DECOR, android.view.WindowInsets.Type.SYSTEM_GESTURES, android.view.WindowInsets.Type.MANDATORY_SYSTEM_GESTURES, android.view.WindowInsets.Type.TAPPABLE_ELEMENT, android.view.WindowInsets.Type.DISPLAY_CUTOUT, and android.view.WindowInsets.Type.SYSTEM_OVERLAYS |