DBRouterDelegate class

Transport group exchange Flutter Application Router delegate. Manage the navigation stack/history of a Router.

Implemented types
Mixed in types


DBRouterDelegate({required DBPage initialPage, required List<DBPageBuilder> pageBuilders, GlobalKey<NavigatorState>? navigatorKey, List<NavigatorObserver>? navigatorObservers, @visibleForTesting Map<String, Completer<Object?>>? popResultTracker, String? restorationScopeId, bool reportPageUpdateToEngine = false})
Create a DBRouterDelegate with the provided pageBuilders and initialPage.
DBRouterDelegate.private(List<DBPage> _pages, List<DBPageBuilder> _pageBuilders, GlobalKey<NavigatorState> _navigatorKey, Map<String, Completer<Object?>> _popResultTracker, DBNavigationObserver _navigationObserver, List<NavigatorObserver> _customNavigatorObservers, String? _restorationScopeId, {bool reportPageUpdateToEngine = false})
Create a DBRouterDelegate from scratch.


currentConfiguration Destination?
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
The key used for retrieving the current navigator.
no setteroverride
pageBuilders List<DBPageBuilder>
List of DBPageBuilder that build the Page that compose the navigation stack.
no setter
pages List<DBPage>
Current navigation stack of this DBRouterDelegate.
no setter
reportPageUpdateToEngine bool
Report page update to the flutter engine when the top most page changes.
restorationScopeId String?
DBRouterDelegate restoration scope id.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
areNavigationStackEquals(Iterable<Destination> leftStack, Iterable<Destination> rightStack) bool
Check the equality between two list of destination.
build(BuildContext context) Widget
Called by the Router to obtain the widget tree that represents the current state.
canClose() bool
Can close the current location.
close<T extends Object?>([T? result]) → void
Close the current top most location.
closeUntil({required String location, Map<String, Object?>? resultMap}) → void
Close the current top most location and every location after it until location is visible.
closeUntilLast({Map<String, Object?>? resultMap}) → void
Close the current top most location and every location after it until the last location is visible.
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).
Navigate to the following location.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
notifyListeners() → void
Call all the registered listeners.
onPopPage(Route<Object?> route, [Object? result]) bool
Callback to handle imperative pop or operating system pop event.
popRoute() Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
reset(String initialPath, List<DBPageBuilder> newPageBuilders, {Object? arguments, List<Destination>? initialPageHistory}) Future<void>
Update the list of page builder composing this delegate. initialPath to use for this delegate.
setInitialRoutePath(Destination configuration) Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
setNewRoutePath(Destination configuration) Future<void>
Called by the Router when the Router.routeInformationProvider reports that a new route has been pushed to the application by the operating system.
setRestoredRoutePath(Destination configuration) Future<void>
Called by the Router during state restoration.
toString() String
A string representation of this object.


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

Static Methods

of(BuildContext context, {bool root = false}) DBRouterDelegate
Get the nearest DBRouterDelegate from the provided context.