NavigatorState class

The state for a Navigator widget.




focusScopeNode FocusScopeNode
The FocusScopeNode for the FocusScope that encloses the routes.
overlay OverlayState
The overlay this navigator uses for its visual presentation.
userGestureInProgress bool
Whether a route is currently being manipulated by the user, e.g. as during an iOS back gesture.
context BuildContext
The location in the tree where this widget builds. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
mounted bool
Whether this State object is currently in a tree. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
widget Navigator
The current configuration. [...]
read-only, inherited


build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
canPop() bool
Whether this navigator can be popped. [...]
didStartUserGesture() → void
The navigator is being controlled by a user gesture. [...]
didStopUserGesture() → void
A user gesture completed. [...]
didUpdateWidget(Navigator oldWidget) → void
Called whenever the widget configuration changes. [...]
dispose() → void
Called when this object is removed from the tree permanently. [...]
finalizeRoute(Route route) → void
Complete the lifecycle for a route that has been popped off the navigator. [...]
initState() → void
Called when this object is inserted into the tree. [...]
maybePop([result ]) Future<bool>
Tries to pop the current route, first giving the active route the chance to veto the operation using Route.willPop. This method is typically called instead of pop when the user uses a back button. For example on Android it's called by the binding for the system's back button. [...]
pop([result ]) bool
Removes the top route in the Navigator's history. [...]
popUntil(RoutePredicate predicate) → void
Repeatedly calls pop until the given predicate returns true. [...]
push(Route<Object> route) Future<Object>
Adds the given route to the navigator's history, and transitions to it. [...]
pushAndRemoveUntil(Route newRoute, RoutePredicate predicate) Future
Push the given route and then remove all the previous routes until the predicate returns true. [...]
pushNamed(String name) Future
Push a named route onto the navigator. [...]
pushNamedAndRemoveUntil(String routeName, RoutePredicate predicate) Future
Push the route with the given name and then remove all the previous routes until the predicate returns true. [...]
pushReplacement(Route newRoute, { result }) Future
Push the newRoute and dispose the old current Route. [...]
pushReplacementNamed(String name, { result }) Future
Push the route named name and dispose the old current route. [...]
removeRoute(Route route) → void
Immediately remove route and Route.dispose it. [...]
removeRouteBelow(Route anchorRoute) → void
Removes the route below the given anchorRoute. The route to be removed must not currently be visible. The anchorRoute must not be the first route in the history. [...]
replace({Route oldRoute, Route newRoute }) → void
Replaces a route that is not currently visible with a new route. [...]
replaceRouteBelow({Route anchorRoute, Route newRoute }) → void
Replaces a route that is not currently visible with a new route. [...]
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback. [...]
deactivate() → void
Called when this object is removed from the tree. [...]
@mustCallSuper, @protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder description) → void
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload. [...]
@mustCallSuper, @protected, inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed. [...]
@protected, inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this object.
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode. [...]


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