Commit 20e214fa authored by Hans Muller's avatar Hans Muller Committed by GitHub

Document the buildTransitions() method (#9182)

parent 896ffcdf
...@@ -29,8 +29,8 @@ class ShrinePageRoute<T> extends MaterialPageRoute<T> { ...@@ -29,8 +29,8 @@ class ShrinePageRoute<T> extends MaterialPageRoute<T> {
}) : super(builder: builder, settings: settings); }) : super(builder: builder, settings: settings);
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
return buildShrine(context, super.buildPage(context, animation, forwardAnimation)); return buildShrine(context, super.buildPage(context, animation, secondaryAnimation));
} }
} }
......
...@@ -231,7 +231,7 @@ class _ModalBottomSheetRoute<T> extends PopupRoute<T> { ...@@ -231,7 +231,7 @@ class _ModalBottomSheetRoute<T> extends PopupRoute<T> {
} }
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
Widget bottomSheet = new _ModalBottomSheet<T>(route: this); Widget bottomSheet = new _ModalBottomSheet<T>(route: this);
if (theme != null) if (theme != null)
bottomSheet = new Theme(data: theme, child: bottomSheet); bottomSheet = new Theme(data: theme, child: bottomSheet);
......
...@@ -337,12 +337,12 @@ class _DialogRoute<T> extends PopupRoute<T> { ...@@ -337,12 +337,12 @@ class _DialogRoute<T> extends PopupRoute<T> {
Color get barrierColor => Colors.black54; Color get barrierColor => Colors.black54;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
return theme != null ? new Theme(data: theme, child: child) : child; return theme != null ? new Theme(data: theme, child: child) : child;
} }
@override @override
Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation, Widget child) { Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
return new FadeTransition( return new FadeTransition(
opacity: new CurvedAnimation( opacity: new CurvedAnimation(
parent: animation, parent: animation,
......
...@@ -313,7 +313,7 @@ class _DropdownRoute<T> extends PopupRoute<_DropdownRouteResult<T>> { ...@@ -313,7 +313,7 @@ class _DropdownRoute<T> extends PopupRoute<_DropdownRouteResult<T>> {
Color get barrierColor => null; Color get barrierColor => null;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
Widget menu = new _DropdownMenu<T>(route: this); Widget menu = new _DropdownMenu<T>(route: this);
if (theme != null) if (theme != null)
menu = new Theme(data: theme, child: menu); menu = new Theme(data: theme, child: menu);
......
...@@ -149,7 +149,7 @@ class MaterialPageRoute<T> extends PageRoute<T> { ...@@ -149,7 +149,7 @@ class MaterialPageRoute<T> extends PageRoute<T> {
} }
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
final Widget result = builder(context); final Widget result = builder(context);
assert(() { assert(() {
if (result == null) { if (result == null) {
...@@ -164,7 +164,7 @@ class MaterialPageRoute<T> extends PageRoute<T> { ...@@ -164,7 +164,7 @@ class MaterialPageRoute<T> extends PageRoute<T> {
} }
@override @override
Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation, Widget child) { Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
if (Theme.of(context).platform == TargetPlatform.iOS) { if (Theme.of(context).platform == TargetPlatform.iOS) {
if (fullscreenDialog) if (fullscreenDialog)
return new CupertinoFullscreenDialogTransition( return new CupertinoFullscreenDialogTransition(
...@@ -174,7 +174,7 @@ class MaterialPageRoute<T> extends PageRoute<T> { ...@@ -174,7 +174,7 @@ class MaterialPageRoute<T> extends PageRoute<T> {
else else
return new CupertinoPageTransition( return new CupertinoPageTransition(
incomingRouteAnimation: animation, incomingRouteAnimation: animation,
outgoingRouteAnimation: forwardAnimation, outgoingRouteAnimation: secondaryAnimation,
child: child, child: child,
// In the middle of a back gesture drag, let the transition be linear to match finger // In the middle of a back gesture drag, let the transition be linear to match finger
// motions. // motions.
......
...@@ -402,7 +402,7 @@ class _PopupMenuRoute<T> extends PopupRoute<T> { ...@@ -402,7 +402,7 @@ class _PopupMenuRoute<T> extends PopupRoute<T> {
Color get barrierColor => null; Color get barrierColor => null;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
double selectedItemOffset; double selectedItemOffset;
if (initialValue != null) { if (initialValue != null) {
selectedItemOffset = 0.0; selectedItemOffset = 0.0;
......
...@@ -46,15 +46,15 @@ abstract class PageRoute<T> extends ModalRoute<T> { ...@@ -46,15 +46,15 @@ abstract class PageRoute<T> extends ModalRoute<T> {
/// primary contents. /// primary contents.
/// ///
/// See [ModalRoute.buildPage] for complete definition of the parameters. /// See [ModalRoute.buildPage] for complete definition of the parameters.
typedef Widget RoutePageBuilder(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation); typedef Widget RoutePageBuilder(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation);
/// Signature for the [PageRouteBuilder] function that builds the route's /// Signature for the [PageRouteBuilder] function that builds the route's
/// transitions. /// transitions.
/// ///
/// See [ModalRoute.buildTransitions] for complete definition of the parameters. /// See [ModalRoute.buildTransitions] for complete definition of the parameters.
typedef Widget RouteTransitionsBuilder(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation, Widget child); typedef Widget RouteTransitionsBuilder(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child);
Widget _defaultTransitionsBuilder(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation, Widget child) { Widget _defaultTransitionsBuilder(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
return child; return child;
} }
...@@ -110,13 +110,13 @@ class PageRouteBuilder<T> extends PageRoute<T> { ...@@ -110,13 +110,13 @@ class PageRouteBuilder<T> extends PageRoute<T> {
final bool maintainState; final bool maintainState;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
return pageBuilder(context, animation, forwardAnimation); return pageBuilder(context, animation, secondaryAnimation);
} }
@override @override
Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation, Widget child) { Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
return transitionsBuilder(context, animation, forwardAnimation, child); return transitionsBuilder(context, animation, secondaryAnimation, child);
} }
} }
...@@ -20,7 +20,7 @@ class TestRoute<T> extends PageRoute<T> { ...@@ -20,7 +20,7 @@ class TestRoute<T> extends PageRoute<T> {
bool get maintainState => false; bool get maintainState => false;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
return child; return child;
} }
} }
......
...@@ -41,7 +41,7 @@ class TestRoute<T> extends PageRoute<T> { ...@@ -41,7 +41,7 @@ class TestRoute<T> extends PageRoute<T> {
bool get maintainState => false; bool get maintainState => false;
@override @override
Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> forwardAnimation) { Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
return child; return child;
} }
} }
...@@ -94,7 +94,7 @@ void main() { ...@@ -94,7 +94,7 @@ void main() {
new TestTransition( new TestTransition(
childFirstHalf: new Text('C'), childFirstHalf: new Text('C'),
childSecondHalf: new Text('D'), childSecondHalf: new Text('D'),
animation: route.forwardAnimation animation: route.secondaryAnimation
), ),
] ]
); );
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment