StackRouter class abstract

Inheritance
Implementers

Constructors

StackRouter({required LocalKey key, OnNestedNavigateCallBack? onNavigate, RoutingController? parent, GlobalKey<NavigatorState>? navigatorKey})

Properties

activeGuardObserver → ActiveGuardObserver
latefinal
canNavigateBack → bool
no setterinherited
canPopSelfOrChildren → bool
no setteroverride
childControllers → List<RoutingController>
no setterinherited
current → RouteData
no setteroverride
currentChild → RouteData?
no setteroverride
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 setter
isRoot → bool
no setterinherited
isTopMost → bool
no setterinherited
key → LocalKey
final
managedByWidget → bool
no setterinherited
matcher → RouteMatcher
no setteroverride
no setterinherited
no setter
onNavigate → OnNestedNavigateCallBack?
final
pageBuilder → PageBuilder
no setteroverride
pageCount → int
no setterinherited
pagelessRoutesObserver → PagelessRoutesObserver
final
parentAsStackRouter → StackRouter?
no setterinherited
pendingRoutesHandler → PendingRoutesHandler
latefinal
root → StackRouter
no setterinherited
routeCollection → RouteCollection
no setteroverride
routeData → RouteData
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stack → List<StackedPage>
no setteroverride
stackData → List<RouteData>
no setterinherited
stateHash → int
no setteroverride
topMatch → RouteMatch
no setterinherited
topPage → StackedPage?
no setterinherited
topRoute → RouteData
no setteroverride
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
override
clear() → void
Clears all tracked pages and childControllers
inherited
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).
override
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
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>
override
popAndPush<T extends Object?, TO extends Object?>(PageRouteInfo route, {TO? result, OnNavigationFailure? onFailure}) → Future<T?>
popAndPushAll(List<PageRouteInfo> routes, {dynamic onFailure}) → Future<void>
popForced<T extends Object?>([T? result]) → void
popTop<T extends Object?>([T? result]) → Future<bool>
inherited
popUntil(RoutePredicate predicate) → void
popUntilRoot() → void
popUntilRouteWithName(String name) → void
popUntilRouteWithPath(String path) → void
push<T extends Object?>(PageRouteInfo route, {OnNavigationFailure? onFailure}) → Future<T?>
pushAll(List<PageRouteInfo> routes, {OnNavigationFailure? onFailure}) → Future<void>
pushAndPopUntil<T extends Object?>(PageRouteInfo route, {required RoutePredicate predicate, OnNavigationFailure? onFailure}) → Future<T?>
pushNamed<T extends Object?>(String path, {bool includePrefixMatches = false, OnNavigationFailure? onFailure}) → Future<T?>
pushNativeRoute<T extends Object?>(Route<T> route) → Future<T?>
pushWidget<T extends Object?>(Widget widget, {RouteTransitionsBuilder? transitionBuilder, bool fullscreenDialog = false, Duration transitionDuration = const Duration(milliseconds: 300)}) → Future<T?>
removeChildController(RoutingController childController) → void
inherited
removeLast() → bool
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
removeUntil(RouteDataPredicate predicate) → bool
removeWhere(RouteDataPredicate predicate, {bool notify = true}) → bool
replace<T extends Object?>(PageRouteInfo route, {OnNavigationFailure? onFailure}) → Future<T?>
replaceAll(List<PageRouteInfo> routes, {OnNavigationFailure? onFailure}) → Future<void>
replaceNamed<T extends Object?>(String path, {bool includePrefixMatches = false, OnNavigationFailure? onFailure}) → Future<T?>
topMostRouter({bool ignorePagelessRoutes = false}) → RoutingController
override
toString() → String
A string representation of this object.
inherited
updateDeclarativeRoutes(List<PageRouteInfo> routes) → void
updateRouteData(RouteData data) → void
inherited

Operators

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