OverlayManagerEntry<T> class abstract

Every overlay is provided an OverlayManagerEntry. Check the state of overlay by closed flag and close it by close method.

Inheritance

Constructors

OverlayManagerEntry({required OverlayManager manager, OverlayDismiss<T>? onDismiss, bool isDismissible = true, double elevation = 0})
The OverlayManagerEntry's constructor

Properties

closed bool
closed is true if this overlay is closed. each overlay can be shown only one time and can not be reused if it is closed
no setter
elevation double
The elevation provides the layer's z-index position of this overlay in manage. Call OverlayManager.rearrange or use OverlayManagerEntry.rearrange to apply the new overlay elevation order.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
isDismissible bool
Used for internal! isDismissible is true if the overlay can be close automatically.
final
manager OverlayManager
The OverlayManager manages this overlay.
final
onDismiss OverlayDismiss<T>?
Used for internal! Will call when overlay is closed.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

close([T? value]) → void
close this overlay if closed is false and return T value for onDismiss
compareTo(OverlayManagerEntry other) int
Compares this object to another object.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rearrange(double newElevation) → void
Rearrange entry with newElevation
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited