page.dart 6.72 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'package:flutter/cupertino.dart';
6

7
import 'page_transitions_theme.dart';
8
import 'theme.dart';
9

10 11
/// A modal route that replaces the entire screen with a platform-adaptive
/// transition.
12
///
13
/// {@macro flutter.material.materialRouteTransitionMixin}
14
///
15 16 17
/// By default, when a modal route is replaced by another, the previous route
/// remains in memory. To free all the resources when this is not necessary, set
/// [maintainState] to false.
18
///
19 20
/// The `fullscreenDialog` property specifies whether the incoming route is a
/// fullscreen modal dialog. On iOS, those routes animate from the bottom to the
21
/// top rather than horizontally.
22
///
23
/// The type `T` specifies the return type of the route which can be supplied as
24 25
/// the route is popped from the stack via [Navigator.pop] by providing the
/// optional `result` argument.
26
///
27 28
/// See also:
///
29 30 31 32
///  * [MaterialRouteTransitionMixin], which provides the material transition
///    for this route.
///  * [MaterialPage], which is a [Page] of this class.
class MaterialPageRoute<T> extends PageRoute<T> with MaterialRouteTransitionMixin<T> {
33 34
  /// Construct a MaterialPageRoute whose contents are defined by [builder].
  ///
35
  /// The values of [builder], [maintainState], and [PageRoute.fullscreenDialog]
36
  /// must not be null.
37
  MaterialPageRoute({
38 39
    required this.builder,
    RouteSettings? settings,
40 41
    this.maintainState = true,
    bool fullscreenDialog = false,
42
  }) : assert(builder != null),
43 44
       assert(maintainState != null),
       assert(fullscreenDialog != null),
45 46 47
       super(settings: settings, fullscreenDialog: fullscreenDialog) {
    assert(opaque);
  }
48

49
  /// Builds the primary contents of the route.
50
  final WidgetBuilder builder;
Adam Barth's avatar
Adam Barth committed
51

52 53 54
  @override
  Widget buildContent(BuildContext context) => builder(context);

55 56 57
  @override
  final bool maintainState;

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  @override
  String get debugLabel => '${super.debugLabel}(${settings.name})';
}


/// A mixin that provides platform-adaptive transitions for a [PageRoute].
///
/// {@template flutter.material.materialRouteTransitionMixin}
/// For Android, the entrance transition for the page slides the route upwards
/// and fades it in. The exit transition is the same, but in reverse.
///
/// The transition is adaptive to the platform and on iOS, the route slides in
/// from the right and exits in reverse. The route also shifts to the left in
/// parallax when another page enters to cover it. (These directions are flipped
/// in environments with a right-to-left reading direction.)
/// {@endtemplate}
///
/// See also:
///
///  * [PageTransitionsTheme], which defines the default page transitions used
///    by the [MaterialRouteTransitionMixin.buildTransitions].
mixin MaterialRouteTransitionMixin<T> on PageRoute<T> {
  /// Builds the primary contents of the route.
81 82
  @protected
  Widget buildContent(BuildContext context);
83

84
  @override
85
  Duration get transitionDuration => const Duration(milliseconds: 300);
86 87

  @override
88
  Color? get barrierColor => null;
89

90
  @override
91
  String? get barrierLabel => null;
92

93 94 95
  @override
  bool canTransitionTo(TransitionRoute<dynamic> nextRoute) {
    // Don't perform outgoing animation if the next route is a fullscreen dialog.
96 97
    return (nextRoute is MaterialRouteTransitionMixin && !nextRoute.fullscreenDialog)
      || (nextRoute is CupertinoRouteTransitionMixin && !nextRoute.fullscreenDialog);
98 99
  }

100
  @override
101 102 103 104 105
  Widget buildPage(
    BuildContext context,
    Animation<double> animation,
    Animation<double> secondaryAnimation,
  ) {
106
    final Widget result = buildContent(context);
107
    assert(() {
108
      if (result == null) {
109 110 111 112
        throw FlutterError(
          'The builder for route "${settings.name}" returned null.\n'
          'Route builders must never return null.'
        );
113
      }
114
      return true;
115
    }());
116 117 118 119 120
    return Semantics(
      scopesRoute: true,
      explicitChildNodes: true,
      child: result,
    );
121 122
  }

123
  @override
124
  Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
125
    final PageTransitionsTheme theme = Theme.of(context).pageTransitionsTheme;
126
    return theme.buildTransitions<T>(this, context, animation, secondaryAnimation, child);
127
  }
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
}

/// A page that creates a material style [PageRoute].
///
/// {@macro flutter.material.materialRouteTransitionMixin}
///
/// By default, when the created route is replaced by another, the previous
/// route remains in memory. To free all the resources when this is not
/// necessary, set [maintainState] to false.
///
/// The `fullscreenDialog` property specifies whether the created route is a
/// fullscreen modal dialog. On iOS, those routes animate from the bottom to the
/// top rather than horizontally.
///
/// The type `T` specifies the return type of the route which can be supplied as
/// the route is popped from the stack via [Navigator.transitionDelegate] by
/// providing the optional `result` argument to the
/// [RouteTransitionRecord.markForPop] in the [TransitionDelegate.resolve].
///
/// See also:
///
///  * [MaterialPageRoute], which is the [PageRoute] version of this class
class MaterialPage<T> extends Page<T> {
  /// Creates a material page.
  const MaterialPage({
153
    required this.child,
154 155
    this.maintainState = true,
    this.fullscreenDialog = false,
156 157 158
    LocalKey? key,
    String? name,
    Object? arguments,
159
  }) : assert(child != null),
160 161 162 163
       assert(maintainState != null),
       assert(fullscreenDialog != null),
       super(key: key, name: name, arguments: arguments);

164 165
  /// The content to be shown in the [Route] created by this page.
  final Widget child;
166

167
  /// {@macro flutter.widgets.ModalRoute.maintainState}
168 169
  final bool maintainState;

170
  /// {@macro flutter.widgets.PageRoute.fullscreenDialog}
171
  final bool fullscreenDialog;
172

173
  @override
174 175 176 177 178 179 180 181 182 183 184
  Route<T> createRoute(BuildContext context) {
    return _PageBasedMaterialPageRoute<T>(page: this);
  }
}

// A page-based version of MaterialPageRoute.
//
// This route uses the builder from the page to build its content. This ensures
// the content is up to date after page updates.
class _PageBasedMaterialPageRoute<T> extends PageRoute<T> with MaterialRouteTransitionMixin<T> {
  _PageBasedMaterialPageRoute({
185
    required MaterialPage<T> page,
186
  }) : assert(page != null),
187 188 189
       super(settings: page) {
    assert(opaque);
  }
190 191 192 193

  MaterialPage<T> get _page => settings as MaterialPage<T>;

  @override
194 195 196
  Widget buildContent(BuildContext context) {
    return _page.child;
  }
197 198 199 200 201 202 203 204 205

  @override
  bool get maintainState => _page.maintainState;

  @override
  bool get fullscreenDialog => _page.fullscreenDialog;

  @override
  String get debugLabel => '${super.debugLabel}(${_page.name})';
206
}