NavStackDelegate class

Inheritance

• Object
• Listenable
• RouterDelegate<String>
• NavStackDelegate

Mixed in types

• ChangeNotifier
• PopNavigatorRouterDelegateMixin<String>

Constructors

NavStackDelegate({required PathStack onGenerateStack(BuildContext context, NavStackController controller), String? initialPath, void onRouteChanging(String value)?})

Properties

controller ↔ NavStackController

late, final

currentConfiguration → String?

Called by the Router when it detects a route information may have changed as a result of rebuild.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

initialPath → String?

final

navigatorKey ↔ GlobalKey<NavigatorState>

The key used for retrieving the current navigator.

getter/setter pair, override-getter

onGenerateStack → PathStack Function(BuildContext context, NavStackController controller)

final

onRouteChanging → (void Function(String value)?)

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

build(BuildContext _) → Widget

Returns a Navigator with a single page. Wraps the page in a PathStackPathProvider so the top-most PathStack can grab the current route path. Calls NavigatorState.widget.stackBuilder to build the page contents.

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

popRoute() → 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

setInitialRoutePath(String initialPath) → Future<void>

Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.

override

setNewRoutePath(String path) → 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(String 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