DefaultRouterDelegate class

Inheritance
Mixed-in types

Constructors

DefaultRouterDelegate.new({required BuildContext context, required void onNestedPathUpdate(AdvancedRouteInformation?), required String initialLocation, required Map<PathGroup, List<Page> Function(PathArguments)> paths, required PathFactory? onGeneratePath, required PathFactory? onUnknownPath, required Map<String, Page Function(Object?)> pages, required PageFactory? onGeneratePage, required PageFactory? onUnknownPage, required PopPageCallback? onPopPage, required RouteFactory? onGenerateRoute, required RouteFactory? onUnknownRoute, required TransitionDelegate transitionDelegate, required bool reportsRouteUpdateToEngine, required List<NavigatorObserver> observers, required String? restorationScopeId, required String? tag})

Properties

context → BuildContext
final
currentConfiguration → AdvancedRouteInformation
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialLocation → String
final
The key used for retrieving the current navigator.
final
observers → List<NavigatorObserver>
final
onGeneratePage → PageFactory?
final
onGeneratePath → PathFactory?
final
onGenerateRoute → RouteFactory?
final
onNestedPathUpdate → void Function(AdvancedRouteInformation?)
final
onPopPage → PopPageCallback?
final
onUnknownPage → PageFactory?
final
onUnknownPath → PathFactory?
final
onUnknownRoute → RouteFactory?
final
pages → Map<String, Page Function(Object?)>
final
paths → Map<PathGroup, List<Page> Function(PathArguments)>
final
reportsRouteUpdateToEngine → bool
final
restorationScopeId → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tag → String?
final
transitionDelegate → TransitionDelegate
final

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
attach<T extends Object>(Route<T> route) → Future<T?>
Adds pageless route to top of navigator route stack.
attachNamed<T extends Object>(String routeName, {Object? arguments}) → Future<T?>
Adds pageless route with given name to top of navigator route stack.
build(BuildContext context) → Widget
Called by the Router to obtain the widget tree that represents the current state.
override
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
open(List<Page> pages, {Object? state}) → void
Opens given path with its entire history stack.
openNamed(String location, {Object? state, Object? arguments}) → Future<void>
Opens path from given location reference with its entire history stack.
pop<T extends Object>([T? result]) → void
Pops topmost route and its corresponding page, if any.
popRoute() → Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
inherited
push<T extends Object>(Page<T> page) → Future<T?>
TODO: Return T from page route
pushNamed<T extends Object?>(String name, {Object? arguments}) → Future<T?>
TODO: Return T from page route
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setInitialRoutePath(AdvancedRouteInformation configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
inherited
setNewRoutePath(covariant AdvancedRouteInformation configuration) → SynchronousFuture<void>
Called by the Router when the Router.routeInformationProvider reports that a new route has been pushed to the application by the operating system.
override
setRestoredRoutePath(AdvancedRouteInformation configuration) → Future<void>
Called by the Router during state restoration.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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