A route with entrance and exit transitions.
- Inheritance
- Object
- Route<T>
- OverlayRoute<T>
- TransitionRoute
Constructors
Properties
- animation → Animation<double>
-
The animation that drives the route's transition and the previous route's forward transition.
read-only - completed → Future<T>
-
This future completes only once the transition itself has finished, after the overlay entries have been removed from the navigator's overlay.
read-only - controller → AnimationController
-
The animation controller that the route uses to drive the transitions.
read-only - debugLabel → String
-
A short description of this route useful for debugging.
read-only - finishedWhenPopped → bool
-
read-only
- forwardAnimation → Animation<double>
-
The animation for the route being pushed on top of this route. This animation lets this route coordinate with the entrance and exit transition of routes pushed on top of this route.
read-only - opaque → bool
-
Whether the route obscures previous routes when the transition is complete.
read-only - transitionDuration → Duration
-
The duration the transition lasts.
read-only - currentResult → T
-
When this route is popped (see
Navigator.pop) if the result isn't specified or if it's null, this value will be used instead.read-only, inherited - focusKey → GlobalKey
-
The key this route will use for its root
Focuswidget, if any.read-only, inherited - hashCode → int
-
Get a hash code for this object.
read-only, inherited - isActive → bool
-
Whether this route is on the navigator.
read-only, inherited - isCurrent → bool
-
Whether this route is the top-most route on the navigator.
read-only, inherited -
The navigator that the route is in, if any.
read-only, inherited - overlayEntries → List<OverlayEntry>
-
The entries this route has placed in the overlay.
read-only, inherited - popped → Future<T>
-
A future that completes when this route is popped off the navigator.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited - willHandlePopInternally → bool
-
Whether calling didPop() would return false.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
canTransitionFrom(
TransitionRoute nextRoute) → bool -
Whether this route can perform a transition from the given route.
-
canTransitionTo(
TransitionRoute nextRoute) → bool -
Whether this route can perform a transition to the given route.
-
createAnimation(
) → Animation<double> -
Called to create the animation that exposes the current progress of the transition controlled by the animation controller created by
createAnimationController(). -
createAnimationController(
) → AnimationController -
Called to create the animation controller that will drive the transitions to this route from the previous one, and back to the previous route from this one.
-
didChangeNext(
Route nextRoute) → void -
This route's next route has changed to the given new route. This is called on a route whenever the next route changes for any reason, except for cases when didPopNext() would be called, so long as it is in the history. nextRoute will be null if there's no next route.
-
didPop(
T result) → bool -
A request was made to pop this route. If the route can handle it internally (e.g. because it has its own stack of internal state) then return false, otherwise return true. Returning false will prevent the default behavior of NavigatorState.pop().
-
didPopNext(
Route nextRoute) → void -
The given route, which came after this one, has been popped off the navigator.
-
didPush(
) → void -
Called after install() when the route is pushed onto the navigator.
-
didReplace(
Route oldRoute) → void -
Called after install() when the route replaced another in the navigator.
-
dispose(
) → void -
The route should remove its overlays and free any other resources.
-
finished(
) → void -
Clears out the overlay entries.
-
install(
OverlayEntry insertionPoint) → void -
Called when the route is inserted into the navigator.
-
toString(
) → String -
Returns a string representation of this object.
-
createOverlayEntries(
) → Iterable<OverlayEntry> -
Subclasses should override this getter to return the builders for the overlay.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
startPopGesture(
) → NavigationGestureController -
If the route's transition can be popped via a user gesture (e.g. the iOS back gesture), this should return a controller object that can be used to control the transition animation's progress. Otherwise, it should return null.
inherited