APSController class

Class that allows navigation control.

Inheritance

Constructors

APSController.from({required ApsRouteMatcher routerMatcher, required ApsSnapshot initialConfiguration})
Creates a new APSController given an initialConfiguration configuration.
factory

Properties

buildContext ↔ BuildContext
BuildContext was used to build this APSController instance.
getter/setter pair
currentConfig → ApsRouteDescriptor
Shortcut to currentConfig.topConfiguration.
no setter
currentSnapshot ↔ ApsSnapshot
Snapshot used to create the current route/page stack.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialSnapshot ↔ ApsSnapshot
First snapshot created by this controller.
getter/setter pair
Global key set to the Navigator instance created internally by APSNavigator.
final
pages → List<Page>
List of pages used by APSNavigator to populate its internal Navigator's page list.
no setter
routerMatcher → ApsRouteMatcher
Router matcher.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
backToRoot() → void
It navigates back to the Root (the route provided to APSNavigator.from.initialRoute).
browserSetNewConfiguration(ApsParserData configuration) → void
Configures this ApsController instance to use an ApsSnapshot created based on the given configuration.
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<T extends Object>([T? result]) → bool
Pop top Page
push<T>({required String path, Map<String, dynamic> params = const {}}) → Future<T>
Pushes a new page to the top.
pushAll({int? position, required List<ApsPushParam> list}) → void
Pushes a list of Pages at the specified position.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeRange({required int start, required int end}) → void
Removes a range of Pages from the Page Stack.
toString() → String
A string representation of this object.
inherited
updateParams({required Map<String, dynamic> params}) → void
It requests the Browser to update its address bar based on the given params.

Operators

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