DialogOverlayCompleter<T> class
Completer that manages the lifecycle of a dialog overlay.
Provides control over dialog animations, completion status, and disposal. Wraps a DialogRoute to offer a consistent interface for managing dialog lifecycles through the overlay system.
Features:
- Animation state monitoring
- Future-based completion handling
- Proper resource disposal
- Route management integration
Example:
final completer = DialogOverlayCompleter(dialogRoute);
await completer.future; // Wait for dialog completion
completer.remove(); // Programmatically close dialog
- Inheritance
-
- Object
- OverlayCompleter<
T> - DialogOverlayCompleter
Constructors
-
DialogOverlayCompleter(DialogRoute<
T> route) - Creates a DialogOverlayCompleter.
Properties
-
animationFuture
→ Future<
void> -
Future that completes when the overlay animation finishes.
no setteroverride
- config ↔ OverlayConfiguration?
-
The configuration currently applied to this overlay, if this mechanism
tracks one.
getter/setter pairinherited
-
future
→ Future<
T> -
Future that completes with the overlay's result value.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAnimationCompleted → bool
-
Whether the overlay's animation has completed.
no setteroverride
- isCompleted → bool
-
Whether the overlay operation has completed.
no setteroverride
-
route
→ DialogRoute<
T> -
The dialog route managed by this completer.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
[bool immediate = false]) → Future< void> -
Closes the overlay.
inherited
-
closeLater(
) → void -
Schedules overlay closure for the next frame.
inherited
-
closeWithResult<
X> ([X? value]) → Future< void> -
Closes the overlay with a result value.
inherited
-
dispose(
) → void -
Disposes resources associated with the overlay.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
remove(
) → void -
Removes the overlay from the screen.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited