RootBackButtonDispatcher class

The default implementation of back button dispatcher for the root router.

This dispatcher listens to platform pop route notifications. When the platform wants to pop the current route, this dispatcher calls the BackButtonDispatcher.invokeCallback method to handle the request.

Inheritance
Mixed in types

Constructors

RootBackButtonDispatcher()
Create a root back button dispatcher.

Properties

hasCallbacks bool
Whether a callback is currently registered.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

addCallback(ValueGetter<Future<bool>> callback) → void
Register the callback to be called when the object changes. [...]
createChildBackButtonDispatcher() ChildBackButtonDispatcher
Creates a ChildBackButtonDispatcher that is a direct descendant of this back button dispatcher. [...]
inherited
deferTo(ChildBackButtonDispatcher child) → void
Mark the given child as taking priority over this object and the other children. [...]
inherited
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features. [...]
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground. [...]
inherited
didChangeLocales(List<Locale> locale) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings. [...]
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated. [...]
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes. [...]
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes. [...]
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory. [...]
inherited
didPopRoute() Future<bool>
Called when the system tells the app to pop the current route. For example, on Android, this is called when the user presses the back button. [...]
override
didPushRoute(String route) Future<bool>
Called when the host tells the application to push a new route onto the navigator. [...]
inherited
didPushRouteInformation(RouteInformation routeInformation) Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router. [...]
inherited
forget(ChildBackButtonDispatcher child) → void
Causes the given child to be removed from the list of children to which this object might defer, as if deferTo had never been called for that child. [...]
inherited
invokeCallback(Future<bool> defaultValue) Future<bool>
Handles a pop route request. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
removeCallback(ValueGetter<Future<bool>> callback) → void
Remove a previously registered callback. [...]
takePriority() → void
Make this BackButtonDispatcher take priority among its peers. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited