GetDelegate<T> class

Inheritance
Mixed-in types

Constructors

GetDelegate({required List<GetPage<T>> pages, GetPage<T>? notFoundRoute, List<NavigatorObserver>? navigatorObservers, TransitionDelegate? transitionDelegate, PopMode backButtonPopMode = PopMode.history, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.reorderRoutes, Iterable<GetPage> pickPagesForRootNavigator(RouteDecoder currentNavStack)?, String? restorationScopeId, bool showHashOnUrl = false, GlobalKey<NavigatorState>? navigatorKey})
GetDelegate.createDelegate({GetPage<T>? notFoundRoute, List<GetPage> pages = const <GetPage<dynamic>>[], List<NavigatorObserver>? navigatorObservers, TransitionDelegate? transitionDelegate, PopMode backButtonPopMode = PopMode.history, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.reorderRoutes, GlobalKey<NavigatorState>? navigatorKey})
factory

Properties

activePages → List<RouteDecoder>
no setter
backButtonPopMode → PopMode
final
canBack → bool
no setter
currentConfiguration → RouteDecoder<T>?
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.
getter/setter pairoverride-getter
final
notFoundRoute → GetPage
final
pageSettings → PageSettings?
no setter
parameters → Map<String, String>
no setter
pickPagesForRootNavigator → Iterable<GetPage> Function(RouteDecoder currentNavStack)?
final
preventDuplicateHandlingMode → PreventDuplicateHandlingMode
final
registeredRoutes → List<GetPage<T>>
no setter
restorationScopeId → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transitionDelegate → TransitionDelegate?
final

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
addPage(GetPage<T> getPage) → void
addPages(List<GetPage<T>> getPages) → void
arguments() → T
back([T? result]) → void
Navigates back in the navigation stack.
override
backAndtoNamed(String page, {Object? result, Object? arguments}) → Future<T?>
Navigates back to a named page with an optional result and arguments.
override
backUntil(bool predicate(GetPage)) → void
Navigates back until a certain condition is met.
override
build(BuildContext context) → Widget
Called by the Router to obtain the widget tree that represents the current state.
override
canPopHistory() → Future<bool>
canPopPage() → Future<bool>
clearRouteTree() → void
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
getVisualPages(RouteDecoder? currentHistory) → Iterable<GetPage>
gets the visual pages from the current _activePages entry
goToUnknownPage([bool clearPages = false]) → Future<void>
Navigates to an unknown page.
override
handlePopupRoutes({Object? result}) → Future<bool>
matchRoute(String name, {PageSettings? arguments}) → RouteDecoder<T>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
off(Widget page(), {bool? opaque, Transition? transition, Curve? curve, Duration? duration, String? id, String? routeName, bool fullscreenDialog = false, Object? arguments, List<BindingsInterface> bindings = const <BindingsInterface>[], bool preventDuplicates = true, bool? popGesture, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?}) → Future<T?>
Navigates off the current page and returns a result of type T.
override
offAll(Widget page(), {bool predicate(GetPage route)?, bool opaque = true, bool? popGesture, String? id, String? routeName, Object? arguments, List<BindingsInterface> bindings = const <BindingsInterface>[], bool fullscreenDialog = false, Transition? transition, Curve? curve, Duration? duration, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?}) → Future<T?>?
Navigates off all pages and returns a result of type T.
override
offAllNamed(String newRouteName, {Object? arguments, String? id, Map<String, String>? parameters}) → Future<T?>?
Navigates off all named pages and returns a result of type T.
override
offNamed(String page, {Object? arguments, String? id, Map<String, String>? parameters}) → Future<T?>
Navigates off a named page and returns a result of type T.
override
offNamedUntil(String page, {bool predicate(GetPage<T> route)?, Object? arguments, String? id, Map<String, String>? parameters}) → Future<T?>?
Navigates off a named page until a certain condition is met and returns a result of type T.
override
offUntil(Widget page(), bool predicate(GetPage), [Object? arguments]) → Future<T?>
Navigates off a page until a certain condition is met, returns a result of type T.
override
popHistory(T? result) → Future<T?>
popModeUntil(String fullRoute, {PopMode popMode = PopMode.history}) → Future<void>
Removes routes according to PopMode until it reaches the specific fullRoute, DOES NOT remove the fullRoute
override
popRoute({Object? result, PopMode? popMode}) → Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removePage(GetPage<T> getPage) → void
removeRoute(String name) → void
Removes a route from the navigation stack.
override
runMiddleware(RouteDecoder config) → Future<RouteDecoder?>
setInitialRoutePath(RouteDecoder<T> configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
inherited
setNewRoutePath(RouteDecoder 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.
override
setRestoredRoutePath(RouteDecoder<T> configuration) → Future<void>
Called by the Router during state restoration.
inherited
to(Widget page(), {bool? opaque, Transition? transition, Curve? curve, Duration? duration, String? id, String? routeName, bool fullscreenDialog = false, Object? arguments, List<BindingsInterface> bindings = const <BindingsInterface>[], bool preventDuplicates = true, bool? popGesture, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?, bool rebuildStack = true, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.reorderRoutes}) → Future<T?>
Navigates to a new page and returns a result of type T.
override
toNamed(String page, {Object? arguments, String? id, bool preventDuplicates = true, Map<String, String>? parameters}) → Future<T?>
Navigates to a named page and returns a result of type T.
override
toNamedAndOffUntil(String page, bool predicate(GetPage), [Object? data]) → Future<T?>
Navigates to a named page and pops pages until a certain condition is met, returns a result of type T.
override
toString() → String
A string representation of this object.
inherited

Operators

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