TransitionRoute<T> class Null safety

A route with entrance and exit transitions.

Inheritance
Implementers

Constructors

TransitionRoute({RouteSettings? settings})
Creates a route that animates itself when it is pushed or popped.

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.
@protected, 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
debugLabel String
A short description of this route useful for debugging.
read-only
finishedWhenPopped bool
Controls whether didPop calls NavigatorState.finalizeRoute.
read-only, override
hasActiveRouteBelow bool
Whether there is at least one active route underneath this route.
@protected, read-only, inherited
hashCode int
The 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
isFirst bool
Whether this route is the bottom-most active route on the navigator.
read-only, inherited
The navigator that the route is in, if any.
read-only, inherited
opaque bool
Whether the route obscures previous routes when the transition is complete.
read-only
overlayEntries List<OverlayEntry>
The overlay entries of this route.
read-only, inherited
popped Future<T?>
A future that completes when this route is popped off the navigator.
read-only, inherited
restorationScopeId ValueListenable<String?>
The restoration scope ID to be used for the RestorationScope surrounding this route.
read-only, inherited
reverseTransitionDuration Duration
The duration the transition going in reverse.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
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.
read-only
settings RouteSettings
The settings for this route.
read-only, inherited
transitionDuration Duration
The duration the transition going forwards.
read-only
willDisposeAnimationController bool
Whether to takeover the controller created by createAnimationController.
read / write
willHandlePopInternally bool
Whether calling didPop would return false.
read-only, inherited

Methods

canTransitionFrom(TransitionRoute previousRoute) bool
Returns true if previousRoute should 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 nextRoute is pushed on top of it or when nextRoute is 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.
@mustCallSuper, @protected, inherited
changedInternalState() → void
Called whenever the internal state of the route has changed.
@mustCallSuper, @protected, 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.
@factory, 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.
@mustCallSuper, @protected, inherited
didComplete(T? result) → void
The route was popped or is otherwise being removed somewhat gracefully.
@mustCallSuper, @protected, 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
install() → void
Called when the route is inserted into the navigator.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
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