Shift+page up/down works with single line fields and tests pass

justinmc · justinmc · commit a51735d85000 · 2022-06-23T10:35:56.000-07:00
diff --git a/packages/flutter/lib/src/widgets/editable_text.dart b/packages/flutter/lib/src/widgets/editable_text.dart
@@ -3309,7 +3309,8 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
 
     final ScrollableState? state = _scrollableKey.currentState as ScrollableState?;
     final double increment = ScrollAction.getIncrement(state!, intent);
-    final double destination = (position.pixels + increment).clamp(
+    final double destination = clampDouble(
+      position.pixels + increment,
       position.minScrollExtent,
       position.maxScrollExtent,
     );
@@ -3322,19 +3323,28 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
   /// Extend the selection down by page if the `forward` parameter is true, or
   /// up by page otherwise.
   void _extendSelectionByPage(ExtendSelectionByPageIntent intent) {
-    final ScrollPosition position = _scrollController.position;
+    if (widget.maxLines == 1) {
+      return;
+    }
+
     final TextSelection nextSelection;
     final Rect extentRect = renderEditable.getLocalRectForCaret(
       _value.selection.extent,
     );
+    final ScrollableState? state = _scrollableKey.currentState as ScrollableState?;
+    final double increment = ScrollAction.calculateScrollIncrement(
+      state!,
+      type: ScrollIncrementType.page,
+    );
+    final ScrollPosition position = _scrollController.position;
     if (intent.forward) {
       if (_value.selection.extentOffset >= _value.text.length) {
         return;
       }
       final Offset nextExtentOffset =
-          Offset(extentRect.left, extentRect.top + position.viewportDimension);
-      final double height = _scrollController.position.maxScrollExtent + renderEditable.size.height;
-      final TextPosition nextExtent = nextExtentOffset.dy + _scrollController.position.pixels >= height
+          Offset(extentRect.left, extentRect.top + increment);
+      final double height = position.maxScrollExtent + renderEditable.size.height;
+      final TextPosition nextExtent = nextExtentOffset.dy + position.pixels >= height
           ? TextPosition(offset: _value.text.length)
           : renderEditable.getPositionForPoint(
               renderEditable.localToGlobal(nextExtentOffset),
@@ -3347,8 +3357,8 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
         return;
       }
       final Offset nextExtentOffset =
-          Offset(extentRect.left, extentRect.top - position.viewportDimension);
-      final TextPosition nextExtent = nextExtentOffset.dy + _scrollController.position.pixels <= 0
+          Offset(extentRect.left, extentRect.top - increment);
+      final TextPosition nextExtent = nextExtentOffset.dy + position.pixels <= 0
           ? const TextPosition(offset: 0)
           : renderEditable.getPositionForPoint(
               renderEditable.localToGlobal(nextExtentOffset),
diff --git a/packages/flutter/lib/src/widgets/scrollable.dart b/packages/flutter/lib/src/widgets/scrollable.dart
@@ -1597,14 +1597,14 @@ class ScrollAction extends Action<ScrollIntent> {
     return false;
   }
 
-  // Returns the scroll increment for a single scroll request, for use when
-  // scrolling using a hardware keyboard.
-  //
-  // Must not be called when the position is null, or when any of the position
-  // metrics (pixels, viewportDimension, maxScrollExtent, minScrollExtent) are
-  // null. The type and state arguments must not be null, and the widget must
-  // have already been laid out so that the position fields are valid.
-  static double _calculateScrollIncrement(ScrollableState state, { ScrollIncrementType type = ScrollIncrementType.line }) {
+  /// Returns the scroll increment for a single scroll request, for use when
+  /// scrolling using a hardware keyboard.
+  ///
+  /// Must not be called when the position is null, or when any of the position
+  /// metrics (pixels, viewportDimension, maxScrollExtent, minScrollExtent) are
+  /// null. The type and state arguments must not be null, and the widget must
+  /// have already been laid out so that the position fields are valid.
+  static double calculateScrollIncrement(ScrollableState state, { ScrollIncrementType type = ScrollIncrementType.line }) {
     assert(type != null);
     assert(state.position != null);
     assert(state.position.hasPixels);
@@ -1631,7 +1631,7 @@ class ScrollAction extends Action<ScrollIntent> {
   /// Find out how much of an increment to move by, taking the different
   /// directions into account.
   static double getIncrement(ScrollableState state, ScrollIntent intent) {
-    final double increment = _calculateScrollIncrement(state, type: intent.type);
+    final double increment = calculateScrollIncrement(state, type: intent.type);
     switch (intent.direction) {
       case AxisDirection.down:
         switch (state.axisDirection) {
diff --git a/packages/flutter/test/widgets/editable_text_test.dart b/packages/flutter/test/widgets/editable_text_test.dart
@@ -7846,17 +7846,17 @@ void main() {
     );
     expect(scrollController.position.pixels, 0.0);
 
-    // Page Down scrolls by the height of the viewport.
+    // Page Down scrolls proportionally to the height of the viewport.
     await sendKeys(
       tester,
       <LogicalKeyboardKey>[
         LogicalKeyboardKey.pageDown,
       ],
       targetPlatform: defaultTargetPlatform,
     );
-    expect(scrollController.position.pixels, lineHeight * lines);
+    expect(scrollController.position.pixels, lineHeight * lines * 0.8);
 
-    // Another Page Down does nothing, since it's now at the bottom.
+    // Another Page Down reaches the bottom.
     await sendKeys(
       tester,
       <LogicalKeyboardKey>[
@@ -7866,7 +7866,17 @@ void main() {
     );
     expect(scrollController.position.pixels, lineHeight * lines);
 
-    // Page Up now scrolls back up.
+    // Page Up now scrolls back up proportionally to the height of the viewport.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageUp,
+      ],
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, lineHeight * lines - lineHeight * lines * 0.8);
+
+    // Another Page Up reaches the top.
     await sendKeys(
       tester,
       <LogicalKeyboardKey>[
@@ -7880,6 +7890,84 @@ void main() {
     variant: TargetPlatformVariant.all(),
   );
 
+  testWidgets('pageup/pagedown keys in a one line field', (WidgetTester tester) async {
+    final TextEditingController controller = TextEditingController(text: testText);
+    controller.selection = const TextSelection(
+      baseOffset: 0,
+      extentOffset: 0,
+      affinity: TextAffinity.upstream,
+    );
+    final ScrollController scrollController = ScrollController();
+    await tester.pumpWidget(MaterialApp(
+      home: Align(
+        alignment: Alignment.topLeft,
+        child: SizedBox(
+          width: 400,
+          child: EditableText(
+            minLines: 1,
+            controller: controller,
+            scrollController: scrollController,
+            showSelectionHandles: true,
+            autofocus: true,
+            focusNode: FocusNode(),
+            style: Typography.material2018().black.subtitle1!,
+            cursorColor: Colors.blue,
+            backgroundCursorColor: Colors.grey,
+            selectionControls: materialTextSelectionControls,
+            keyboardType: TextInputType.text,
+            textAlign: TextAlign.right,
+          ),
+        ),
+      ),
+    ));
+
+    await tester.pump(); // Wait for autofocus to take effect.
+
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+    expect(scrollController.position.pixels, 0.0);
+    final double lineHeight = findRenderEditable(tester).preferredLineHeight;
+
+    // Page Up scrolls to the end.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageUp,
+      ],
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, scrollController.position.maxScrollExtent);
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+
+    // Return scroll to the start.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.home,
+      ],
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, 0.0);
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+
+    // Page Down also scrolls to the end.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageDown,
+      ],
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, scrollController.position.maxScrollExtent);
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+  },
+    skip: kIsWeb, // [intended] on web these keys are handled by the browser.
+    variant: TargetPlatformVariant.all(),
+  );
+
   testWidgets('shift + pageup/pagedown keys', (WidgetTester tester) async {
     final TextEditingController controller = TextEditingController(text: testText);
     controller.selection = const TextSelection(
@@ -7943,12 +8031,26 @@ void main() {
       shift: true,
       targetPlatform: defaultTargetPlatform,
     );
-    expect(scrollController.position.pixels, lineHeight * 1);
+    expect(scrollController.position.pixels, 0.0);
+    expect(controller.value.selection.isCollapsed, isFalse);
+    expect(controller.value.selection.baseOffset, 0);
+    expect(controller.value.selection.extentOffset, 20);
+
+    // Another Page Down selects further down and scrolls.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageDown,
+      ],
+      shift: true,
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, 14.0);
     expect(controller.value.selection.isCollapsed, isFalse);
     expect(controller.value.selection.baseOffset, 0);
-    expect(controller.value.selection.extentOffset, 36);
+    expect(controller.value.selection.extentOffset, 54);
 
-    // Another Page Down selects everything.
+    // Another Page Down selects everything and scrolls to the bottom.
     await sendKeys(
       tester,
       <LogicalKeyboardKey>[
@@ -7962,7 +8064,6 @@ void main() {
     expect(controller.value.selection.baseOffset, 0);
     expect(controller.value.selection.extentOffset, controller.text.length);
 
-
     // Another Page Down does nothing, since it's now at the bottom.
     await sendKeys(
       tester,
@@ -8008,6 +8109,73 @@ void main() {
     variant: TargetPlatformVariant.all(),
   );
 
+  testWidgets('shift + pageup/pagedown keys in a one line field', (WidgetTester tester) async {
+    final TextEditingController controller = TextEditingController(text: testText);
+    controller.selection = const TextSelection(
+      baseOffset: 0,
+      extentOffset: 0,
+      affinity: TextAffinity.upstream,
+    );
+    final ScrollController scrollController = ScrollController();
+    await tester.pumpWidget(MaterialApp(
+      home: Align(
+        alignment: Alignment.topLeft,
+        child: SizedBox(
+          width: 400,
+          child: EditableText(
+            minLines: 1,
+            controller: controller,
+            scrollController: scrollController,
+            showSelectionHandles: true,
+            autofocus: true,
+            focusNode: FocusNode(),
+            style: Typography.material2018().black.subtitle1!,
+            cursorColor: Colors.blue,
+            backgroundCursorColor: Colors.grey,
+            selectionControls: materialTextSelectionControls,
+            keyboardType: TextInputType.text,
+            textAlign: TextAlign.right,
+          ),
+        ),
+      ),
+    ));
+
+    await tester.pump(); // Wait for autofocus to take effect.
+
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+    expect(scrollController.position.pixels, 0.0);
+
+    // Shift + Page Up does nothing.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageUp,
+      ],
+      shift: true,
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, 0.0);
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+
+    // Shift + Page Down does nothing either.
+    await sendKeys(
+      tester,
+      <LogicalKeyboardKey>[
+        LogicalKeyboardKey.pageDown,
+      ],
+      shift: true,
+      targetPlatform: defaultTargetPlatform,
+    );
+    expect(scrollController.position.pixels, 0.0);
+    expect(controller.value.selection.isCollapsed, isTrue);
+    expect(controller.value.selection.baseOffset, 0);
+  },
+    skip: kIsWeb, // [intended] on web these keys are handled by the browser.
+    variant: TargetPlatformVariant.all(),
+  );
+
   // Regression test for https://github.com/flutter/flutter/issues/31287
   testWidgets('text selection handle visibility', (WidgetTester tester) async {
     // Text with two separate words to select.
