RootStackRouter class abstract

Inheritance

Constructors

RootStackRouter([GlobalKey<NavigatorState>? navigatorKey])

Properties

activeGuardObserver → ActiveGuardObserver
latefinalinherited
canNavigateBack → bool
no setterinherited
canPopSelfOrChildren → bool
no setterinherited
childControllers → List<RoutingController>
no setterinherited
current → RouteData
no setterinherited
currentChild → RouteData?
no setterinherited
currentPath → String
no setterinherited
currentSegments → List<RouteMatch>
no setterinherited
currentUrl → String
no setterinherited
hasEntries → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
hasPagelessTopRoute → bool
no setterinherited
isRoot → bool
no setterinherited
isTopMost → bool
no setterinherited
key → LocalKey
finalinherited
managedByWidget → bool
no setteroverride
matcher → RouteMatcher
latefinal
no setteroverride
no setterinherited
onNavigate → OnNestedNavigateCallBack?
finalinherited
pageBuilder → PageBuilder
no setteroverride
pageCount → int
no setterinherited
pagelessRoutesObserver → PagelessRoutesObserver
finalinherited
pagesMap → Map<String, PageFactory>
no setter
parentAsStackRouter → StackRouter?
no setterinherited
pendingRoutesHandler → PendingRoutesHandler
latefinalinherited
root → StackRouter
no setterinherited
routeCollection → RouteCollection
latefinal
routeData → RouteData
no setteroverride
routes → List<RouteConfig>
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stack → List<StackedPage>
no setterinherited
stackData → List<RouteData>
no setterinherited
stateHash → int
no setterinherited
topMatch → RouteMatch
no setterinherited
topPage → StackedPage?
no setterinherited
topRoute → RouteData
no setterinherited
urlState → UrlState
no setterinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
attachChildController(RoutingController childController) → void
inherited
buildPageRoute(String? path, {bool includePrefixMatches = true}) → PageRouteInfo?
inherited
buildPageRoutesStack(String? path, {bool includePrefixMatches = true}) → List<PageRouteInfo>?
inherited
canPop({bool ignoreChildRoutes = false, bool ignoreParentRoutes = false, bool ignorePagelessRoutes = false}) → bool
inherited
clear() → void
Clears all tracked pages and childControllers
inherited
declarativeDelegate({required RoutesBuilder routes, String? navRestorationScopeId, RoutePopCallBack? onPopRoute, String? initialDeepLink, OnNavigateCallBack? onNavigate, NavigatorObserversBuilder navigatorObservers = NestedRouterDelegate.defaultNavigatorObserversBuilder}) → NestedRouterDelegate
defaultRouteParser({bool includePrefixMatches = false}) → DefaultRouteParser
delegate({List<PageRouteInfo>? initialRoutes, String? initialDeepLink, String? navRestorationScopeId, WidgetBuilder? placeholder, NavigatorObserversBuilder navigatorObservers = NestedRouterDelegate.defaultNavigatorObserversBuilder}) → NestedRouterDelegate
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
innerRouterOf<T extends RoutingController>(String routeName) → T?
inherited
isPathActive(String path) → bool
inherited
isRouteActive(String routeName) → bool
inherited
isRouteDataActive(RouteData data) → bool
inherited
markUrlStateForReplace() → void
inherited
inherited
inherited
inherited
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyAll({bool forceUrlRebuild = false}) → void
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
parent<T extends RoutingController>() → T?
inherited
pop<T extends Object?>([T? result]) → Future<bool>
inherited
popAndPush<T extends Object?, TO extends Object?>(PageRouteInfo route, {TO? result, OnNavigationFailure? onFailure}) → Future<T?>
inherited
popAndPushAll(List<PageRouteInfo> routes, {dynamic onFailure}) → Future<void>
inherited
popForced<T extends Object?>([T? result]) → void
inherited
popTop<T extends Object?>([T? result]) → Future<bool>
inherited
popUntil(RoutePredicate predicate) → void
inherited
popUntilRoot() → void
inherited
popUntilRouteWithName(String name) → void
inherited
popUntilRouteWithPath(String path) → void
inherited
push<T extends Object?>(PageRouteInfo route, {OnNavigationFailure? onFailure}) → Future<T?>
inherited
pushAll(List<PageRouteInfo> routes, {OnNavigationFailure? onFailure}) → Future<void>
inherited
pushAndPopUntil<T extends Object?>(PageRouteInfo route, {required RoutePredicate predicate, OnNavigationFailure? onFailure}) → Future<T?>
inherited
pushNamed<T extends Object?>(String path, {bool includePrefixMatches = false, OnNavigationFailure? onFailure}) → Future<T?>
inherited
pushNativeRoute<T extends Object?>(Route<T> route) → Future<T?>
inherited
pushWidget<T extends Object?>(Widget widget, {RouteTransitionsBuilder? transitionBuilder, bool fullscreenDialog = false, Duration transitionDuration = const Duration(milliseconds: 300)}) → Future<T?>
inherited
removeChildController(RoutingController childController) → void
inherited
removeLast() → bool
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeRoute(RouteData route, {bool notify = true}) → void
inherited
removeUntil(RouteDataPredicate predicate) → bool
inherited
removeWhere(RouteDataPredicate predicate, {bool notify = true}) → bool
inherited
replace<T extends Object?>(PageRouteInfo route, {OnNavigationFailure? onFailure}) → Future<T?>
inherited
replaceAll(List<PageRouteInfo> routes, {OnNavigationFailure? onFailure}) → Future<void>
inherited
replaceNamed<T extends Object?>(String path, {bool includePrefixMatches = false, OnNavigationFailure? onFailure}) → Future<T?>
inherited
routeInfoProvider({RouteInformation? initialRouteInformation, bool neglectWhen(String? location)?}) → StackedRouteInformationProvider
topMostRouter({bool ignorePagelessRoutes = false}) → RoutingController
inherited
toString() → String
A string representation of this object.
inherited
updateDeclarativeRoutes(List<PageRouteInfo> routes) → void
inherited
updateRouteData(RouteData data) → void
override

Operators

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