NavigationController class

The class controls the navigation, it serves as RouterDelegate for the Router. Also it holds the current NavigationStack and provides interface to update it.

Inheritance

• Object
• Listenable
• RouterDelegate<NavigationStack>
• NavigationController

Mixed in types

• ChangeNotifier
• PopNavigatorRouterDelegateMixin<NavigationStack>

Constructors

NavigationController({required PageFactory pageFactory, required NavigationStack initial})

Creates a NavigationController.

Properties

currentConfiguration → NavigationStack

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

navigatorKey ↔ GlobalKey<NavigatorState>

The key used for retrieving the current navigator.

getter/setter pair, override-getter

pageFactory → PageFactory

PageFactory helps to build Page out of NavigationStack and Destinations.

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 context) → Widget

Called by the Router to obtain the widget tree that represents the current state.

override

buildPages(BuildContext context) → List<Page>

Builds Pages out of NavigationStack and Destinations. Derived classes can override this method to alter the bulding behaviour.

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

navigateTo(Destination destination) → void

Navigate to the destination automatically by routing rules.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

Call all the registered listeners.

inherited

onPopPage(Route route, dynamic result) → bool

Behaviour when page pop is requested.

popRoute() → Future<bool>

Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.

inherited

removeListener(VoidCallback listener) → void

Remove a previously registered closure from the list of closures that are notified when the object changes.

inherited

setCurrent(NavigationStack value) → void

Set current NavigationStack and notify listeners.

setInitialRoutePath(NavigationStack configuration) → Future<void>

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

inherited

setNewRoutePath(NavigationStack 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(NavigationStack 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