CupertinoDialogRoute<T> class
Null safety
A dialog route that shows an iOS-style dialog.
It is used internally by showCupertinoDialog or can be directly pushed onto the Navigator stack to enable state restoration. See showCupertinoDialog for a state restoration app example.
This function takes a builder
which typically builds a Dialog widget.
Content below the dialog is dimmed with a ModalBarrier. The widget
returned by the builder
does not share a context with the location that
showDialog
is originally called from. Use a StatefulBuilder or a
custom StatefulWidget if the dialog needs to update dynamically.
The context
argument is used to look up
CupertinoLocalizations.modalBarrierDismissLabel, which provides the
modal with a localized accessibility label that will be used for the
modal's barrier. However, a custom barrierLabel
can be passed in as well.
The barrierDismissible
argument is used to indicate whether tapping on the
barrier will dismiss the dialog. It is true
by default and cannot be null
.
The barrierColor
argument is used to specify the color of the modal
barrier that darkens everything below the dialog. If null
, then
CupertinoDynamicColor.resolve is used to compute the modal color.
The settings
argument define the settings for this route. See
RouteSettings for details.
A DisplayFeature can split the screen into sub-screens. The closest one to anchorPoint is used to render the content.
If no anchorPoint is provided, then Directionality is used:
- for TextDirection.ltr, anchorPoint is
Offset.zero
, which will cause the content to appear in the top-left sub-screen. - for TextDirection.rtl, anchorPoint is
Offset(double.maxFinite, 0)
, which will cause the content to appear in the top-right sub-screen.
If no anchorPoint is provided, and there is no Directionality ancestor widget in the tree, then the widget asserts during build in debug mode.
See also:
- showCupertinoDialog, which is a way to display an iOS-style dialog.
- showGeneralDialog, which allows for customization of the dialog popup.
- showDialog, which displays a Material dialog.
- DisplayFeatureSubScreen, which documents the specifics of how DisplayFeatures can split the screen into sub-screens.
- Inheritance
-
- Object
- Route<
T> - OverlayRoute<
T> - TransitionRoute<
T> - ModalRoute<
T> - PopupRoute<
T> - RawDialogRoute<
T> - CupertinoDialogRoute
Constructors
- CupertinoDialogRoute({required WidgetBuilder builder, required BuildContext context, bool barrierDismissible = true, Color? barrierColor, String? barrierLabel, Duration transitionDuration = const Duration(milliseconds: 250), RouteTransitionsBuilder? transitionBuilder = _buildCupertinoDialogTransitions, RouteSettings? settings, Offset? anchorPoint})
- A dialog route that shows an iOS-style dialog.
Properties
- anchorPoint → Offset?
-
The anchor point used to pick the closest sub-screen.
finalinherited
-
animation
→ Animation<
double> ? -
The animation that drives the route's transition and the previous route's
forward transition.
read-onlyinherited
- barrierColor → Color?
-
The color to use for the modal barrier. If this is null, the barrier will
be transparent.
read-onlyinherited
- barrierCurve → Curve
-
The curve that is used for animating the modal barrier in and out.
read-onlyinherited
- barrierDismissible → bool
-
Whether you can dismiss this route by tapping the modal barrier.
read-onlyinherited
- barrierLabel → String?
-
The semantic label used for a dismissible barrier.
read-onlyinherited
- canPop → bool
-
Whether this route can be popped.
read-onlyinherited
-
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-onlyinherited
- controller → AnimationController?
- The animation controller that the route uses to drive the transitions.
- 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-onlyinherited
- debugLabel → String
-
A short description of this route useful for debugging.
read-onlyinherited
- filter → ImageFilter?
-
The filter to add to the barrier.
finalinherited
- finishedWhenPopped → bool
-
Controls whether didPop calls NavigatorState.finalizeRoute.
read-onlyinherited
- hasActiveRouteBelow → bool
- Whether there is at least one active route underneath this route.
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- hasScopedWillPopCallback → bool
- True if one or more WillPopCallback callbacks exist.
- impliesAppBarDismissal → bool
-
Whether an AppBar in the route should automatically add a back button or
close button.
read-onlyinherited
- isActive → bool
-
Whether this route is on the navigator.
read-onlyinherited
- isCurrent → bool
-
Whether this route is the top-most route on the navigator.
read-onlyinherited
- isFirst → bool
-
Whether this route is the bottom-most active route on the navigator.
read-onlyinherited
- maintainState → bool
-
Whether the route should remain in memory when it is inactive.
read-onlyinherited
-
The navigator that the route is in, if any.
read-onlyinherited
- offstage ↔ bool
-
Whether this route is currently offstage.
read / writeinherited
- opaque → bool
-
Whether the route obscures previous routes when the transition is complete.
read-onlyinherited
-
overlayEntries
→ List<
OverlayEntry> -
The overlay entries of this route.
read-onlyinherited
-
popped
→ Future<
T?> -
A future that completes when this route is popped off the navigator.
read-onlyinherited
- preferRasterization → bool
-
Whether the route transition will prefer to animate a rasterized
snapshot of the entering/exiting routes.
read-onlyinherited
-
restorationScopeId
→ ValueListenable<
String?> -
The restoration scope ID to be used for the RestorationScope surrounding
this route.
read-onlyinherited
- reverseTransitionDuration → Duration
-
The duration the transition going in reverse.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
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-onlyinherited
- semanticsDismissible → bool
-
Whether the semantics of the modal barrier are included in the
semantics tree.
read-onlyinherited
- settings → RouteSettings
-
The settings for this route.
read-onlyinherited
- subtreeContext → BuildContext?
-
The build context for the subtree containing the primary content of this route.
read-onlyinherited
- transitionDuration → Duration
-
The duration the transition going forwards.
read-onlyinherited
- willDisposeAnimationController ↔ bool
-
Whether to takeover the controller created by createAnimationController.
read / writeinherited
- willHandlePopInternally → bool
-
Whether calling didPop would return false.
read-onlyinherited
Methods
-
addLocalHistoryEntry(
LocalHistoryEntry entry) → void -
Adds a local history entry to this route.
inherited
-
addScopedWillPopCallback(
WillPopCallback callback) → void -
Enables this route to veto attempts by the user to dismiss it.
inherited
-
buildPage(
BuildContext context, Animation< double> animation, Animation<double> secondaryAnimation) → Widget -
Override this method to build the primary content of this route.
inherited
-
buildTransitions(
BuildContext context, Animation< double> animation, Animation<double> secondaryAnimation, Widget child) → Widget -
Override this method to wrap the
child
with one or more transition widgets that define how the route arrives on and leaves the screen.inherited -
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.inherited -
canTransitionTo(
TransitionRoute nextRoute) → bool -
Returns true if this route supports a transition animation that runs
when
nextRoute
is pushed on top of it or whennextRoute
is popped off of it.inherited -
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().
inherited
-
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.
inherited
-
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.
inherited
-
didChangeNext(
Route? nextRoute) → void -
This route's next route has changed to the given new route.
inherited
-
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.
-
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.inherited -
didPopNext(
Route nextRoute) → void -
The given route, which was above this one, has been popped off the
navigator.
inherited
-
didPush(
) → TickerFuture -
Called after install when the route is pushed onto the navigator.
inherited
-
didReplace(
Route? oldRoute) → void -
Called after install when the route replaced another in the navigator.
inherited
-
dispose(
) → void -
Discards any resources used by the object.
inherited
-
install(
) → void -
Called when the route is inserted into the navigator.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
removeLocalHistoryEntry(
LocalHistoryEntry entry) → void -
Remove a local history entry from this route.
inherited
-
removeScopedWillPopCallback(
WillPopCallback callback) → void -
Remove one of the callbacks run by willPop.
inherited
-
setState(
VoidCallback fn) → void -
Schedule a call to buildTransitions.
protected">@protectedinherited
-
toString(
) → String -
A string representation of this object.
inherited
-
willPop(
) → Future< RoutePopDisposition> -
Returns RoutePopDisposition.doNotPop if any of callbacks added with
addScopedWillPopCallback returns either false or null. If they all
return true, the base Route.willPop's result will be returned. The
callbacks will be called in the order they were added, and will only be
called if all previous callbacks returned true.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited