YimRouterDelegate class

Inheritance
Mixed-in types

Constructors

YimRouterDelegate(IAppNamePageBuilder namePageBuilder, GlobalKey<NavigatorState> routerNavigatorKey, {required IYimRouterUser<IYimRouterRole> user})

Properties

currentConfiguration → YimRouterPath?
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
namePageBuilder ↔ IAppNamePageBuilder
getter/setter pair
The key used for retrieving the current navigator.
no setteroverride
routerNavigatorKey → GlobalKey<NavigatorState>
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
user ↔ IYimRouterUser<IYimRouterRole>
getter/setter pair

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
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
pop() → void
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
pushMultipleName<T>(List<String> names, {int pop = 0, T? params}) → Future
pushName<T>(String name, {int pop = 0, T? params}) → Future
pushPage(YimPage pageBulder(BuildContext context)) → Future
pushPathItem<T>(List<YimRouterPathItem> items, {int pop = 0}) → Future
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setInitialRoutePath(YimRouterPath configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
override
setNewRoutePath(YimRouterPath 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(YimRouterPath 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