UIStateInformationParser class

The default RouteInformationParser implementation for UIStateWorkflow.

This class manages location changes and faciliates them with the state of UIStateManager. Location changes coming from the system are validated and aligned to corresponding states in the state manager. Also changes of the state manager are reflected by transfering valid locations back to the system.

This class is passed into a Router or MaterialApp instance as route information parser. It should not be instantiated autonomously. Instead UIStateWorkflow should be used to get hold on an instance. For further information see UIStateWorkflow.

Inheritance

Constructors

UIStateInformationParser({required UIStateManager manager, bool enableLocations = false, bool useFullLocations = false, LocationConverter? locationConverter})
Creates an instance of UIStateInformationParser.

Properties

enableLocations → bool
Specifies whether locations should be enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
locationConverter → LocationConverter
The used location converter.
final
manager → UIStateManager
The manager of parser.
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

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseRouteInformation(RouteInformation routeInformation) → Future<PageConfiguration>
Converts the given route information into parsed data to pass to a RouterDelegate.
override
parseRouteInformationWithDependencies(RouteInformation routeInformation, BuildContext context) → Future<PageConfiguration>
Converts the given route information into parsed data to pass to a RouterDelegate.
inherited
restoreRouteInformation(PageConfiguration configuration) → RouteInformation?
Restore the route information from the given configuration.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited