DipNavDelegate class

A delegate that is used by the Router widget to build and configure a navigating widget.

Inheritance
Mixed in types

Constructors

DipNavDelegate({GlobalKey<NavigatorState>? key, required DipNavRoute initRoute, DipNavRoute? notFoundRoute, List<DipNavRoute> routes = const [], List<NavigatorObserver>? dipNavObservers, TransitionDelegate? transitionDelegate})

Properties

currentConfiguration → DipNavRoute?
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
dipNavObservers → List<NavigatorObserver>?
final
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initRoute → DipNavRoute
The DipNavRoute
final
key → GlobalKey<NavigatorState>?
The Navigator Key
final
The key used for retrieving the current navigator.
no setteroverride
notFoundRoute → DipNavRoute?
The DipNavRoute
final
routes → List<DipNavRoute>
The list of DipNavRoute
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
build(BuildContext context) → Widget
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
override
canPop() → bool
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
pushRoute<T>(DipNavRoute route, {bool removeUntil = false, bool replaceCurrent = false, bool rebuild = true, bool fullscreenDialog = false, bool maintainState = true}) → Future<T?>
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setInitialRoutePath(DipNavRoute configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
override
setNewRoutePath(DipNavRoute 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(DipNavRoute 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