Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

ConfirmationOverlay

Kotlin |Java

public class ConfirmationOverlay
extends Object

java.lang.Object
↳	androidx.wear.widget.ConfirmationOverlay

Displays a full-screen confirmation animation with optional text and then hides it.

This is a lighter-weight version of ConfirmationActivity and should be preferred when constructed from an Activity.

Sample usage:

   // Defaults to SUCCESS_ANIMATION
   new ConfirmationOverlay().showOn(myActivity);

   new ConfirmationOverlay()
      .setType(ConfirmationOverlay.OPEN_ON_PHONE_ANIMATION)
      .setDuration(3000)
      .setMessage("Opening...")
      .setFinishedAnimationListener(new ConfirmationOverlay.OnAnimationFinishedListener() {
          @Override
          public void onAnimationFinished() {
              // Finished animating and the content view has been removed from myActivity.
          }
      }).showOn(myActivity);

   // Default duration is DEFAULT_ANIMATION_DURATION_MS
   new ConfirmationOverlay()
      .setType(ConfirmationOverlay.FAILURE_ANIMATION)
      .setMessage("Failed")
      .setFinishedAnimationListener(new ConfirmationOverlay.OnAnimationFinishedListener() {
          @Override
          public void onAnimationFinished() {
              // Finished animating and the view has been removed from myView.getRootView().
          }
      }).showAbove(myView);

Summary

Nested classes
`interface`	`ConfirmationOverlay.OnAnimationFinishedListener` Interface for listeners to be notified when the `ConfirmationOverlay` animation has finished and its `View` has been removed.
`@interface`	`ConfirmationOverlay.OverlayType` Types of animations to display in the overlay.

Constants
`int`	`DEFAULT_ANIMATION_DURATION_MS` Default animation duration in ms.
`int`	`FAILURE_ANIMATION` `ConfirmationOverlay.OverlayType` indicating the failure overlay should be shown.
`int`	`OPEN_ON_PHONE_ANIMATION` `ConfirmationOverlay.OverlayType` indicating the "Open on Phone" animation overlay should be displayed.
`int`	`SUCCESS_ANIMATION` `ConfirmationOverlay.OverlayType` indicating the success animation overlay should be displayed.

Public constructors
`ConfirmationOverlay()`

Public methods
`ConfirmationOverlay`	`setDuration(int millis)` Sets the duration in milliseconds which controls how long the animation will be displayed.
`ConfirmationOverlay`	`setFinishedAnimationListener(ConfirmationOverlay.OnAnimationFinishedListener listener)` Sets the `ConfirmationOverlay.OnAnimationFinishedListener` which will be invoked once the overlay is no longer visible.
`ConfirmationOverlay`	`setMessage(String message)` Sets a message which will be displayed at the same time as the animation.
`ConfirmationOverlay`	`setType(int type)` Sets the `ConfirmationOverlay.OverlayType` which controls which animation is displayed.
`void`	`showAbove(View view)` Adds the overlay as a child of `view.getRootView()`, removing it when complete.
`void`	`showOn(Activity activity)` Adds the overlay as a content view to the `activity`, removing it when complete.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Constants

DEFAULT_ANIMATION_DURATION_MS

public static final int DEFAULT_ANIMATION_DURATION_MS

Default animation duration in ms.

Constant Value: 1000 (0x000003e8)

FAILURE_ANIMATION

public static final int FAILURE_ANIMATION

ConfirmationOverlay.OverlayType indicating the failure overlay should be shown. The icon associated with this type, unlike the others, does not animate.

Constant Value: 1 (0x00000001)

OPEN_ON_PHONE_ANIMATION

public static final int OPEN_ON_PHONE_ANIMATION

ConfirmationOverlay.OverlayType indicating the "Open on Phone" animation overlay should be displayed.

Constant Value: 2 (0x00000002)

SUCCESS_ANIMATION

public static final int SUCCESS_ANIMATION

ConfirmationOverlay.OverlayType indicating the success animation overlay should be displayed.

Constant Value: 0 (0x00000000)

Public constructors