OverlayRoute<T> class

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

Inheritance
Implemented by

Constructors

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

Properties

finishedWhenPopped bool
Controls whether didPop calls NavigatorState.finalizeRoute. [...]
@protected, read-only
overlayEntries List<OverlayEntry>
The entries this route has placed in the overlay.
read-only
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-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isActive bool
Whether this route is on the navigator. [...]
read-only, inherited
isCurrent bool
Whether this route is the top-most route on the navigator. [...]
read-only, inherited
isFirst bool
Whether this route is the bottom-most route on the navigator. [...]
read-only, inherited
The navigator that the route is in, if any.
read-only, inherited
popped Future<T>
A future that completes when this route is popped off the navigator. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
settings RouteSettings
The settings for this route. [...]
final, inherited
willHandlePopInternally bool
Whether calling didPop would return false.
read-only, inherited

Methods

createOverlayEntries() Iterable<OverlayEntry>
Subclasses should override this getter to return the builders for the overlay.
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 return the value of calling super.didPop). Returning false will prevent the default behavior of NavigatorState.pop. [...]
dispose() → void
The route should remove its overlays and free any other resources. [...]
install(OverlayEntry insertionPoint) → void
Called when the route is inserted into the navigator. [...]
changedExternalState() → void
Called whenever the Navigator has its widget rebuilt, to indicate that the route may wish to rebuild as well. [...]
@mustCallSuper, @protected, inherited
changedInternalState() → void
Called whenever the internal state of the route has changed. [...]
@mustCallSuper, @protected, inherited
didChangeNext(Route nextRoute) → void
This route's next route has changed to the given new route. This is called on a route whenever the next route changes for any reason, so long as it is in the history, including when a route is first added to a Navigator (e.g. by Navigator.push), except for cases when didPopNext would be called. nextRoute will be null if there's no next route.
@mustCallSuper, @protected, inherited
didChangePrevious(Route previousRoute) → void
This route's previous route has changed to the given new route. This is called on a route whenever the previous route changes for any reason, so long as it is in the history, except for immediately after the route has been pushed (in which case didPush or didReplace will be called instead). previousRoute will be null if there's no previous route.
@mustCallSuper, @protected, inherited
didComplete(T result) → void
The route was popped or is otherwise being removed somewhat gracefully. [...]
@mustCallSuper, @protected, inherited
didPopNext(Route nextRoute) → void
The given route, which was above this one, has been popped off the navigator.
@mustCallSuper, @protected, inherited
didPush() TickerFuture
Called after install when the route is pushed onto the navigator. [...]
@protected, inherited
didReplace(Route oldRoute) → void
Called after install when the route replaced another in the navigator. [...]
@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited
willPop() Future<RoutePopDisposition>
Returns false if this route wants to veto a Navigator.pop. This method is called by Navigator.maybePop. [...]
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited