UIStateDelegate class
The default RouterDelegate implementation for UIStateWorkflow.
This class manages the changes on the route locations manages the communication between UIStateManager and Router. Therefore it subscribes to the change events of the state manager. Location changes coming from the system over UIStateInformationParser are also reflected by updating the state manager.
This class is passed into a Router or MaterialApp instance as router delegate. It should not be instantiated autonomously. Instead UIStateWorkflow should be used to get hold on an instance. For further information see UIStateWorkflow.
- Inheritance
-
- Object
- Listenable
- RouterDelegate<
PageConfiguration> - UIStateDelegate
- Mixed in types
Constructors
- UIStateDelegate({required UIStateManager manager, required UIStatePage pageSelector(PageConfiguration?), bool enableLocations = false, bool useFullLocations = false, LocationConverter? locationConverter})
- Creates an instance of UIStateDelegate.
Properties
- currentConfiguration → PageConfiguration?
-
Called by the Router when it detects a route information may have
changed as a result of rebuild.
no setteroverride
- enableLocations → bool
-
Specifies whether locations should be enabled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- locationConverter → LocationConverter
-
The used location converter.
final
- manager → UIStateManager
-
The used manager of this delegate.
final
-
The key used for retrieving the current navigator.
no setteroverride
- pageSelector → UIStatePage Function(PageConfiguration?)
-
The used page selector.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useFullLocations → bool
-
Specifies whether full location names should be used.
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 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).
override
-
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.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
setInitialRoutePath(
PageConfiguration configuration) → Future< void> -
Called by the Router at startup with the structure that the
RouteInformationParser obtained from parsing the initial route.
inherited
-
setNewRoutePath(
PageConfiguration 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(
PageConfiguration 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
Static Methods
-
of(
BuildContext context) → UIStateDelegate