NavigatorState class

The state for a Navigator widget.

Inheritance
Mixed in types

Constructors

Properties

focusScopeNode FocusScopeNode
The FocusScopeNode for the FocusScope that encloses the routes.
final
overlay OverlayState
The overlay this navigator uses for its visual presentation.
read-only
userGestureInProgress bool
Whether a route is currently being manipulated by the user, e.g. as during an iOS back gesture.
read-only
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

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
override
canPop() bool
Whether the navigator can be popped. [...]
didStartUserGesture() → void
The navigator is being controlled by a user gesture. [...]
didStopUserGesture() → void
A user gesture completed. [...]
didUpdateWidget(covariant Navigator oldWidget) → void
Called whenever the widget configuration changes. [...]
override
dispose() → void
Called when this object is removed from the tree permanently. [...]
override
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. [...]
override
maybePop<T extends Object>([T result ]) Future<bool>
Returns the value of the current route's Route.willPop method for the navigator. [...]
@optionalTypeArgs
pop<T extends Object>([T result ]) bool
Pop the top-most route off the navigator. [...]
@optionalTypeArgs
popAndPushNamed<T extends Object, TO extends Object>(String routeName, { TO result, Object arguments }) Future<T>
Pop the current route off the navigator and push a named route in its place. [...]
@optionalTypeArgs
popUntil(RoutePredicate predicate) → void
Calls pop repeatedly until the predicate returns true. [...]
push<T extends Object>(Route<T> route) Future<T>
Push the given route onto the navigator. [...]
@optionalTypeArgs
pushAndRemoveUntil<T extends Object>(Route<T> newRoute, RoutePredicate predicate) Future<T>
Push the given route onto the navigator, and then remove all the previous routes until the predicate returns true. [...]
@optionalTypeArgs
pushNamed<T extends Object>(String routeName, { Object arguments }) Future<T>
Push a named route onto the navigator. [...]
@optionalTypeArgs
pushNamedAndRemoveUntil<T extends Object>(String newRouteName, RoutePredicate predicate, { Object arguments }) Future<T>
Push the route with the given name onto the navigator, and then remove all the previous routes until the predicate returns true. [...]
@optionalTypeArgs
pushReplacement<T extends Object, TO extends Object>(Route<T> newRoute, { TO result }) Future<T>
Replace the current route of the navigator by pushing the given route and then disposing the previous route once the new route has finished animating in. [...]
@optionalTypeArgs
pushReplacementNamed<T extends Object, TO extends Object>(String routeName, { TO result, Object arguments }) Future<T>
Replace the current route of the navigator by pushing the route named routeName and then disposing the previous route once the new route has finished animating in. [...]
@optionalTypeArgs
removeRoute(Route route) → void
Immediately remove route from the navigator, and Route.dispose it. [...]
removeRouteBelow(Route anchorRoute) → void
Immediately remove a route from the navigator, and Route.dispose it. The route to be replaced is the one below the given anchorRoute. [...]
replace<T extends Object>({Route oldRoute, Route<T> newRoute }) → void
Replaces a route on the navigator with a new route. [...]
@optionalTypeArgs
replaceRouteBelow<T extends Object>({Route anchorRoute, Route<T> newRoute }) → void
Replaces a route on the navigator with a new route. The route to be replaced is the one below the given anchorRoute. [...]
@optionalTypeArgs
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback. [...]
inherited
deactivate() → void
Called when this object is removed from the tree. [...]
@mustCallSuper, @protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
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 DiagnosticsNode.toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns a string representation of this object.
inherited
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode. [...]
inherited

Operators

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