RouteObserver<R extends Route> class
A Navigator observer that notifies RouteAwares of changes to the state of their Route.
RouteObserver informs subscribers whenever a route of type R is pushed
on top of their own route of type R or popped from it. This is for example
useful to keep track of page transitions, e.g. a RouteObserver<PageRoute>
will inform subscribed RouteAwares whenever the user navigates away from
the current page route to another page route.
To be informed about route changes of any type, consider instantiating a
RouteObserver<Route>.
Type arguments
When using more aggressive lints,
in particular lints such as always_specify_types,
the Dart analyzer will require that certain types
be given with their type arguments. Since the Route class and its
subclasses have a type argument, this includes the arguments passed to this
class. Consider using dynamic to specify the entire class of routes rather
than only specific subtypes. For example, to watch for all ModalRoute
variants, the RouteObserver<ModalRoute<dynamic>> type may be used.
To create a local project with this code sample, run:
flutter create --sample=widgets.RouteObserver.1 mysample
See also:
- RouteAware, this is used with RouteObserver to make a widget aware of changes to the Navigator's session history.
- Inheritance
-
- Object
- NavigatorObserver
- RouteObserver
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
The navigator that the observer is observing, if any.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
debugObservingRoute(
R route) → bool - Whether this observer is managing changes for the specified route.
-
didChangeTop(
Route topRoute, Route? previousTopRoute) → void -
The top most route has changed.
inherited
-
didPop(
Route route, Route? previousRoute) → void -
The Navigator popped
route.override -
didPush(
Route route, Route? previousRoute) → void -
The Navigator pushed
route.override -
didRemove(
Route route, Route? previousRoute) → void -
The Navigator removed
route.inherited -
didReplace(
{Route? newRoute, Route? oldRoute}) → void -
The Navigator replaced
oldRoutewithnewRoute.inherited -
didStartUserGesture(
Route route, Route? previousRoute) → void -
The Navigator's routes are being moved by a user gesture.
inherited
-
didStopUserGesture(
) → void -
User gesture is no longer controlling the Navigator.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
subscribe(
RouteAware routeAware, R route) → void -
Subscribe
routeAwareto be informed about changes toroute. -
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribe(
RouteAware routeAware) → void -
Unsubscribe
routeAware.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited