PageRouteReportMixin<T> mixin

A mixin that provides page route lifecycle event reporting to a RouterReportManager.

This mixin is intended to be used with classes that extend Route to report the installation and disposal of page routes to a RouterReportManager.

Example:

class MyPageRoute extends PageRoute<MyPage> with PageRouteReportMixin<MyPage> {
  // Implement page route...
}
Superclass constraints
Mixin applications

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.
no setterinherited
hasActiveRouteBelow → bool
Whether there is at least one active route underneath this route.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isActive → bool
Whether this route is on the navigator.
no setterinherited
isCurrent → bool
Whether this route is the top-most route on the navigator.
no setterinherited
isFirst → bool
Whether this route is the bottom-most active route on the navigator.
no setterinherited
The navigator that the route is in, if any.
no setterinherited
overlayEntries → List<OverlayEntry>
The overlay entries of this route.
no setterinherited
popDisposition → RoutePopDisposition
Returns whether calling Navigator.maybePop when this Route is current (isCurrent) should do anything.
no setterinherited
popped → Future<T?>
A future that completes when this route is popped off the navigator.
no setterinherited
restorationScopeId → ValueListenable<String?>
The restoration scope ID to be used for the RestorationScope surrounding this route.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings → RouteSettings
The settings for this route.
no setterinherited
willHandlePopInternally → bool
Whether calling didPop would return false.
no setterinherited

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.
inherited
changedInternalState() → void
Called whenever the internal state of the route has changed.
inherited
didAdd() → void
Called after install when the route is added to the navigator.
inherited
didChangeNext(Route? nextRoute) → void
This route's next route has changed to the given new route.
inherited
didChangePrevious(Route? previousRoute) → void
This route's previous route has changed to the given new route.
inherited
didComplete(T? result) → void
The route was popped or is otherwise being removed somewhat gracefully.
inherited
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.
inherited
didPopNext(Route nextRoute) → void
The given route, which was above this one, has been popped off the navigator.
inherited
didPush() → TickerFuture
Called after install when the route is pushed onto the navigator.
inherited
didReplace(Route? oldRoute) → void
Called after install when the route replaced another in the navigator.
inherited
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 nonexistent method or property is accessed.
inherited
onPopInvoked(bool didPop) → void
Called after a route pop was handled.
inherited
onPopInvokedWithResult(bool didPop, T? result) → void
Called after a route pop was handled.
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