OverlayRoute<T> class Null safety

A route that displays widgets in the Navigator's Overlay.

Inheritance
Implementers

Constructors

OverlayRoute({RouteSettings? settings})
Creates a route that knows how to interact with an Overlay.

Properties

currentResult → T?
When this route is popped (see Navigator.pop) if the result isn't specified or if it's null, this value will be used instead.
read-onlyinherited
finishedWhenPopped bool
Controls whether didPop calls NavigatorState.finalizeRoute.
protected">@protectedread-only
hasActiveRouteBelow bool
Whether there is at least one active route underneath this route.
protected">@protectedread-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
isActive bool
Whether this route is on the navigator.
read-onlyinherited
isCurrent bool
Whether this route is the top-most route on the navigator.
read-onlyinherited
isFirst bool
Whether this route is the bottom-most active route on the navigator.
read-onlyinherited
The navigator that the route is in, if any.
read-onlyinherited
overlayEntries List<OverlayEntry>
The overlay entries of this route.
read-onlyoverride
popped Future<T?>
A future that completes when this route is popped off the navigator.
read-onlyinherited
restorationScopeId ValueListenable<String?>
The restoration scope ID to be used for the RestorationScope surrounding this route.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
settings RouteSettings
The settings for this route.
read-onlyinherited
willHandlePopInternally bool
Whether calling didPop would return false.
read-onlyinherited

Methods

changedExternalState() → void
Called whenever the Navigator has updated in some manner that might affect routes, to indicate that the route may wish to rebuild as well.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
changedInternalState() → void
Called whenever the internal state of the route has changed.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
createOverlayEntries() Iterable<OverlayEntry>
Subclasses should override this getter to return the builders for the overlay.
factory">@factory
didAdd() → void
Called after install when the route is added to the navigator.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didChangeNext(Route? nextRoute) → void
This route's next route has changed to the given new route.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didChangePrevious(Route? previousRoute) → void
This route's previous route has changed to the given new route.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didComplete(T? result) → void
The route was popped or is otherwise being removed somewhat gracefully.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didPop(T? result) bool
A request was made to pop this route. If the route can handle it internally (e.g. because it has its own stack of internal state) then return false, otherwise return true (by returning the value of calling super.didPop). Returning false will prevent the default behavior of NavigatorState.pop.
override
didPopNext(Route nextRoute) → void
The given route, which was above this one, has been popped off the navigator.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didPush() TickerFuture
Called after install when the route is pushed onto the navigator.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
didReplace(Route? oldRoute) → void
Called after install when the route replaced another in the navigator.
mustCallSuper">@mustCallSuperprotected">@protectedinherited
dispose() → void
Discards any resources used by the object.
override
install() → void
Called when the route is inserted into the navigator.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
willPop() Future<RoutePopDisposition>
Returns whether calling Navigator.maybePop when this Route is current (isCurrent) should do anything.
inherited

Operators

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