The state for a Navigator widget.
Constructors
Properties
- overlay → OverlayState
-
The overlay this navigator uses for its visual presentation.
read-only - userGestureInProgress → bool
-
Whether a gesture controlled by a
NavigationGestureControlleris currently in progress.read-only - config → Navigator
-
The current configuration.
read-only, inherited - context → BuildContext
-
The location in the tree where this widget builds.
read-only, inherited - hashCode → int
-
Get a hash code for this object.
read-only, inherited - mounted → bool
-
Whether this
Stateobject is currently in a tree.read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
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 is no longer controlling the navigator.
-
didUpdateConfig(
Navigator oldConfig) → void -
Called whenever the configuration changes.
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
-
initState(
) → void -
Called when this object is inserted into the tree.
-
pop(
[result ]) → bool -
Removes the top route in the Navigator's history.
-
popUntil(
RoutePredicate predicate) → void -
Repeatedly calls pop until the given
predicatereturns true. -
push(
Route route) → Future -
Adds the given route to the navigator's history, and transitions to it.
-
pushNamed(
String name) → Future -
Looks up the route with the given name using Navigator.onGenerateRoute, and then pushes that route.
-
removeRouteBelow(
Route anchorRoute) → void -
Removes the route below the given
anchorRoute. The route to be removed must not currently be visible. TheanchorRoutemust 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.
-
startPopGesture(
) → NavigationGestureController -
Starts a gesture that results in popping the navigator.
-
createTicker(
TickerCallback onTick) → Ticker -
Creates a ticker with the given callback.
inherited -
deactivate(
) → void -
Called when this object is removed from the tree.
inherited -
debugFillDescription(
List<String> description) → void -
Add additional information to the given description for use by
toString.inherited -
dependenciesChanged(
) → void -
Called when a dependency of this
Stateobject 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.
inherited -
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited -
toString(
) → String -
Returns a string representation of this object.
inherited