TransitionRoute<T> class
abstract
A route with entrance and exit transitions.
See also:
- Route, which documents the meaning of the
Tgeneric type argument.
- Inheritance
-
- Object
- Route<
T> - OverlayRoute<
T> - TransitionRoute
- Implemented types
- Implementers
Constructors
- TransitionRoute({RouteSettings? settings})
- Creates a route that animates itself when it is pushed or popped.
Properties
- allowSnapshotting → bool
-
Whether the route transition will prefer to animate a snapshot of the
entering/exiting routes.
no setter
-
animation
→ Animation<
double> ? -
The animation that drives the route's transition and the previous route's
forward transition.
no setter
-
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.
no setter
- controller → AnimationController?
-
The animation controller that the route uses to drive the transitions.
no setter
- 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.
no setterinherited
- debugLabel → String
-
A short description of this route useful for debugging.
no setter
- finishedWhenPopped → bool
-
Controls whether didPop calls NavigatorState.finalizeRoute.
no setteroverride
- hasActiveRouteBelow → bool
-
Whether there is at least one active route underneath this route.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isActive → bool
-
Whether this route is on the navigator.
no setterinherited
- isCurrent → bool
-
Whether this route is the top-most route on the navigator.
no setterinherited
- isFirst → bool
-
Whether this route is the bottom-most active route on the navigator.
no setterinherited
-
The navigator that the route is in, if any.
no setterinherited
- opaque → bool
-
Whether the route obscures previous routes when the transition is complete.
no setter
-
overlayEntries
→ List<
OverlayEntry> -
The overlay entries of this route.
no setterinherited
- popDisposition → RoutePopDisposition
-
Returns whether calling Navigator.maybePop when this Route is current
(isCurrent) should do anything.
no setterinherited
- popGestureEnabled → bool
-
Whether a pop gesture can be started by the user for this route.
no setterinherited
-
popped
→ Future<
T?> -
A future that completes when this route is popped off the navigator.
no setterinherited
-
restorationScopeId
→ ValueListenable<
String?> -
The restoration scope ID to be used for the RestorationScope surrounding
this route.
no setterinherited
- reverseTransitionDuration → Duration
-
The duration the transition going in reverse.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secondaryAnimation
→ 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 route pushed on top of this route.
no setter
- settings → RouteSettings
-
The settings for this route.
no setterinherited
- transitionDuration → Duration
-
The duration the transition going forwards.
no setter
- willDisposeAnimationController ↔ bool
-
Whether to takeover the controller created by createAnimationController.
getter/setter pair
- willHandlePopInternally → bool
-
Whether calling didPop would return false.
no setterinherited
Methods
-
canTransitionFrom(
TransitionRoute previousRoute) → bool -
Returns true if
previousRouteshould animate when this route is pushed on top of it or when then this route is popped off of it. -
canTransitionTo(
TransitionRoute nextRoute) → bool -
Returns true if this route supports a transition animation that runs
when
nextRouteis pushed on top of it or whennextRouteis popped off of it. -
changedExternalState(
) → void -
Called whenever the Navigator has updated in some manner that might
affect routes, to indicate that the route may wish to rebuild as well.
inherited
-
changedInternalState(
) → void -
Called whenever the internal state of the route has changed.
inherited
-
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.
-
createOverlayEntries(
) → Iterable< OverlayEntry> -
Subclasses should override this getter to return the builders for the overlay.
inherited
-
didAdd(
) → void -
Called after install when the route is added to the navigator.
override
-
didChangeNext(
Route? nextRoute) → void -
This route's next route has changed to the given new route.
override
-
didChangePrevious(
Route? previousRoute) → void -
This route's previous route has changed to the given new route.
inherited
-
didComplete(
T? result) → void -
The route was popped or is otherwise being removed somewhat gracefully.
inherited
-
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 (by returning the value of calling
super.didPop). Returning false will prevent the default behavior of NavigatorState.pop.override -
didPopNext(
Route nextRoute) → void -
The given route, which was above this one, has been popped off the
navigator.
override
-
didPush(
) → TickerFuture -
Called after install when the route is pushed onto the navigator.
override
-
didReplace(
Route? oldRoute) → void -
Called after install when the route replaced another in the navigator.
override
-
dispose(
) → void -
Discards any resources used by the object.
override
-
handleCancelBackGesture(
) → void -
Handles a predictive back gesture ending in cancellation.
override
-
handleCommitBackGesture(
) → void -
Handles a predictive back gesture ending successfully.
override
-
handleStartBackGesture(
{double progress = 0.0}) → void -
Handles a predictive back gesture starting.
override
-
handleUpdateBackGestureProgress(
{required double progress}) → void -
Handles a predictive back gesture updating as the user drags across the
screen.
override
-
install(
) → void -
Called when the route is inserted into the navigator.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onPopInvoked(
bool didPop) → void -
Called after a route pop was handled.
inherited
-
onPopInvokedWithResult(
bool didPop, T? result) → void -
Called after a route pop was handled.
inherited
-
toString(
) → String -
A string representation of this object.
override
-
willPop(
) → Future< RoutePopDisposition> -
Returns whether calling Navigator.maybePop when this Route is current
(isCurrent) should do anything.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited