From f00b3a4b06a0999d34f9406e18c394f0daeb3aa0 Mon Sep 17 00:00:00 2001
From: Adam Barth <github@adambarth.com>
Date: Mon, 3 Apr 2017 20:58:17 -0700
Subject: [PATCH] Remove ScrollBehavior.getGlowColor (#9145)

This method seemed overly specific to the needs of one particular
subclass. This patch duplicates some code but makes the API conceptually
cleaner.

Fixes #8267
---
 packages/flutter/lib/src/material/app.dart    | 17 +++++++++--
 .../lib/src/widgets/scroll_configuration.dart | 29 +++++++++++++++----
 .../widgets/overscroll_indicator_test.dart    | 16 +++++++---
 3 files changed, 50 insertions(+), 12 deletions(-)

diff --git a/packages/flutter/lib/src/material/app.dart b/packages/flutter/lib/src/material/app.dart
index 8a1827534c..ccddbe2319 100644
--- a/packages/flutter/lib/src/material/app.dart
+++ b/packages/flutter/lib/src/material/app.dart
@@ -174,8 +174,21 @@ class _MaterialScrollBehavior extends ScrollBehavior {
   }
 
   @override
-  Color getGlowColor(BuildContext context) {
-    return Theme.of(context).accentColor;
+  Widget buildViewportChrome(BuildContext context, Widget child, AxisDirection axisDirection) {
+    // When modifying this function, consider modifying the implementation in
+    // the base class as well.
+    switch (getPlatform(context)) {
+      case TargetPlatform.iOS:
+        return child;
+      case TargetPlatform.android:
+      case TargetPlatform.fuchsia:
+        return new GlowingOverscrollIndicator(
+          child: child,
+          axisDirection: axisDirection,
+          color: Theme.of(context).accentColor,
+        );
+    }
+    return null;
   }
 }
 
diff --git a/packages/flutter/lib/src/widgets/scroll_configuration.dart b/packages/flutter/lib/src/widgets/scroll_configuration.dart
index 6963279f28..6fb3f68eea 100644
--- a/packages/flutter/lib/src/widgets/scroll_configuration.dart
+++ b/packages/flutter/lib/src/widgets/scroll_configuration.dart
@@ -9,7 +9,14 @@ import 'framework.dart';
 import 'overscroll_indicator.dart';
 import 'scroll_physics.dart';
 
+const Color _kDefaultGlowColor = const Color(0xFFFFFFFF);
+
+/// Describes how [Scrollable] widgets should behave.
+///
+/// Used by [ScrollConfiguration] to configure the [Scrollable] widgets in a
+/// subtree.
 class ScrollBehavior {
+  /// Creates a description of how [Scrollable] widgets should behave.
   const ScrollBehavior();
 
   /// The platform whose scroll physics should be implemented.
@@ -17,13 +24,14 @@ class ScrollBehavior {
   /// Defaults to the current platform.
   TargetPlatform getPlatform(BuildContext context) => defaultTargetPlatform;
 
-  /// The color to use for the glow effect when [platform] indicates a platform
-  /// that uses a [GlowingOverscrollIndicator].
+  /// Wraps the given widget, which scrolls in the given [AxisDirection].
   ///
-  /// Defaults to white.
-  Color getGlowColor(BuildContext context) => const Color(0xFFFFFFFF);
-
+  /// For example, on Android, this method wraps the given widget with a
+  /// [GlowingOverscrollIndicator] to provide visual feedback when the user
+  /// overscrolls.
   Widget buildViewportChrome(BuildContext context, Widget child, AxisDirection axisDirection) {
+    // When modifying this function, consider modifying the implementation in
+    // _MaterialScrollBehavior as well.
     switch (getPlatform(context)) {
       case TargetPlatform.iOS:
         return child;
@@ -32,7 +40,7 @@ class ScrollBehavior {
         return new GlowingOverscrollIndicator(
           child: child,
           axisDirection: axisDirection,
-          color: getGlowColor(context),
+          color: _kDefaultGlowColor,
         );
     }
     return null;
@@ -56,15 +64,24 @@ class ScrollBehavior {
   bool shouldNotify(covariant ScrollBehavior oldDelegate) => false;
 }
 
+/// Controls how [Scrollable] widgets behave in a subtree.
+///
+/// The scroll configuration determines the [ScrollPhysics] and viewport
+/// decorations used by decendants of [child].
 class ScrollConfiguration extends InheritedWidget {
+  /// Creates a widget that controls how [Scrollable] widgets behave in a subtree.
+  ///
+  /// The [behavior] and [child] arguments must not be null.
   const ScrollConfiguration({
     Key key,
     @required this.behavior,
     @required Widget child,
   }) : super(key: key, child: child);
 
+  /// How [Scrollable] widgets that are decendants of [child] should behave.
   final ScrollBehavior behavior;
 
+  /// The [ScrollBehavior] for [Scrollable] widgets in the given [BuildContext].
   static ScrollBehavior of(BuildContext context) {
     final ScrollConfiguration configuration = context.inheritFromWidgetOfExactType(ScrollConfiguration);
     return configuration?.behavior ?? const ScrollBehavior();
diff --git a/packages/flutter/test/widgets/overscroll_indicator_test.dart b/packages/flutter/test/widgets/overscroll_indicator_test.dart
index 9f20eab1ef..279f58feaa 100644
--- a/packages/flutter/test/widgets/overscroll_indicator_test.dart
+++ b/packages/flutter/test/widgets/overscroll_indicator_test.dart
@@ -267,14 +267,22 @@ void main() {
 
 class TestScrollBehavior1 extends ScrollBehavior {
   @override
-  Color getGlowColor(BuildContext context) {
-    return const Color(0xFF00FF00);
+  Widget buildViewportChrome(BuildContext context, Widget child, AxisDirection axisDirection) {
+    return new GlowingOverscrollIndicator(
+      child: child,
+      axisDirection: axisDirection,
+      color: const Color(0xFF00FF00),
+    );
   }
 }
 
 class TestScrollBehavior2 extends ScrollBehavior {
   @override
-  Color getGlowColor(BuildContext context) {
-    return const Color(0xFF0000FF);
+  Widget buildViewportChrome(BuildContext context, Widget child, AxisDirection axisDirection) {
+    return new GlowingOverscrollIndicator(
+      child: child,
+      axisDirection: axisDirection,
+      color: const Color(0xFF0000FF),
+    );
   }
 }