From b5139515c1f2fcb3732d7e1998588bf37100dad5 Mon Sep 17 00:00:00 2001 From: chunhtai <47866232+chunhtai@users.noreply.github.com> Date: Tue, 23 Feb 2021 11:25:01 -0800 Subject: [PATCH] Revert "fixes TextInputFormatter gets wrong old value of a selection (#75541)" (#76627) This reverts commit a46139a2cef8144444a3e13a3970e9a267304b91. --- .../flutter/lib/src/cupertino/text_field.dart | 1 - .../lib/src/material/selectable_text.dart | 8 +- .../flutter/lib/src/rendering/editable.dart | 151 +++++++++++------- .../flutter/lib/src/services/text_input.dart | 56 +------ .../lib/src/widgets/editable_text.dart | 114 ++++++------- .../lib/src/widgets/text_selection.dart | 64 +++----- .../test/cupertino/text_field_test.dart | 2 + .../test/material/text_field_focus_test.dart | 2 - .../test/material/text_field_test.dart | 55 +------ .../flutter/test/rendering/editable_test.dart | 3 - .../widgets/editable_text_cursor_test.dart | 15 +- .../test/widgets/editable_text_test.dart | 37 ++--- .../test/widgets/text_selection_test.dart | 1 - 13 files changed, 201 insertions(+), 308 deletions(-) diff --git a/packages/flutter/lib/src/cupertino/text_field.dart b/packages/flutter/lib/src/cupertino/text_field.dart index 6823db561b9..86841de0b67 100644 --- a/packages/flutter/lib/src/cupertino/text_field.dart +++ b/packages/flutter/lib/src/cupertino/text_field.dart @@ -102,7 +102,6 @@ class _CupertinoTextFieldSelectionGestureDetectorBuilder extends TextSelectionGe @override void onSingleTapUp(TapUpDetails details) { - editableText.hideToolbar(); // Because TextSelectionGestureDetector listens to taps that happen on // widgets in front of it, tapping the clear button will also trigger // this handler. If the clear button widget recognizes the up event, diff --git a/packages/flutter/lib/src/material/selectable_text.dart b/packages/flutter/lib/src/material/selectable_text.dart index 06eb64e6c18..b431d58f750 100644 --- a/packages/flutter/lib/src/material/selectable_text.dart +++ b/packages/flutter/lib/src/material/selectable_text.dart @@ -494,8 +494,6 @@ class _SelectableTextState extends State with AutomaticKeepAlive }); } - TextSelection? _lastSeenTextSelection; - void _handleSelectionChanged(TextSelection selection, SelectionChangedCause? cause) { final bool willShowSelectionHandles = _shouldShowSelectionHandles(cause); if (willShowSelectionHandles != _showSelectionHandles) { @@ -503,12 +501,10 @@ class _SelectableTextState extends State with AutomaticKeepAlive _showSelectionHandles = willShowSelectionHandles; }); } - // TODO(chunhtai): The selection may be the same. We should remove this - // check once this is fixed https://github.com/flutter/flutter/issues/76349. - if (widget.onSelectionChanged != null && _lastSeenTextSelection != selection) { + + if (widget.onSelectionChanged != null) { widget.onSelectionChanged!(selection, cause); } - _lastSeenTextSelection = selection; switch (Theme.of(context).platform) { case TargetPlatform.iOS: diff --git a/packages/flutter/lib/src/rendering/editable.dart b/packages/flutter/lib/src/rendering/editable.dart index 8151a5c1701..1fae8aaee1c 100644 --- a/packages/flutter/lib/src/rendering/editable.dart +++ b/packages/flutter/lib/src/rendering/editable.dart @@ -31,13 +31,39 @@ const Radius _kFloatingCaretRadius = Radius.circular(1.0); /// (including the cursor location). /// /// Used by [RenderEditable.onSelectionChanged]. -@Deprecated( - 'Signature of a deprecated class method, ' - 'textSelectionDelegate.userUpdateTextEditingValue. ' - 'This feature was deprecated after v1.26.0-17.2.pre.' -) typedef SelectionChangedHandler = void Function(TextSelection selection, RenderEditable renderObject, SelectionChangedCause cause); +/// Indicates what triggered the change in selected text (including changes to +/// the cursor location). +enum SelectionChangedCause { + /// The user tapped on the text and that caused the selection (or the location + /// of the cursor) to change. + tap, + + /// The user tapped twice in quick succession on the text and that caused + /// the selection (or the location of the cursor) to change. + doubleTap, + + /// The user long-pressed the text and that caused the selection (or the + /// location of the cursor) to change. + longPress, + + /// The user force-pressed the text and that caused the selection (or the + /// location of the cursor) to change. + forcePress, + + /// The user used the keyboard to change the selection or the location of the + /// cursor. + /// + /// Keyboard-triggered selection changes may be caused by the IME as well as + /// by accessibility tools (e.g. TalkBack on Android). + keyboard, + + /// The user used the mouse to change the selection by dragging over a piece + /// of text. + drag, +} + /// Signature for the callback that reports when the caret location changes. /// /// Used by [RenderEditable.onCaretChanged]. @@ -132,6 +158,10 @@ bool _isWhitespace(int codeUnit) { /// If, when the render object paints, the caret is found to have changed /// location, [onCaretChanged] is called. /// +/// The user may interact with the render object by tapping or long-pressing. +/// When the user does so, the selection is updated, and [onSelectionChanged] is +/// called. +/// /// Keyboard handling, IME handling, scrolling, toggling the [showCursor] value /// to actually blink the cursor, and other features not mentioned above are the /// responsibility of higher layers and not handled by this object. @@ -168,10 +198,6 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { double textScaleFactor = 1.0, TextSelection? selection, required ViewportOffset offset, - @Deprecated( - 'Uses the textSelectionDelegate.userUpdateTextEditingValue instead. ' - 'This feature was deprecated after v1.26.0-17.2.pre.' - ) this.onSelectionChanged, this.onCaretChanged, this.ignorePointer = false, @@ -375,10 +401,6 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { /// Called when the selection changes. /// /// If this is null, then selection changes will be ignored. - @Deprecated( - 'Uses the textSelectionDelegate.userUpdateTextEditingValue instead. ' - 'This feature was deprecated after v1.26.0-17.2.pre.' - ) SelectionChangedHandler? onSelectionChanged; double? _textLayoutLastMaxWidth; @@ -557,19 +579,7 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { // down in a multiline text field when selecting using the keyboard. bool _wasSelectingVerticallyWithKeyboard = false; - void _setTextEditingValue(TextEditingValue newValue, SelectionChangedCause cause) { - textSelectionDelegate.textEditingValue = newValue; - textSelectionDelegate.userUpdateTextEditingValue(newValue, cause); - } - - void _setSelection(TextSelection nextSelection, SelectionChangedCause cause) { - _handleSelectionChange(nextSelection, cause); - _setTextEditingValue( - textSelectionDelegate.textEditingValue.copyWith(selection: nextSelection), - cause, - ); - } - + // Call through to onSelectionChanged. void _handleSelectionChange( TextSelection nextSelection, SelectionChangedCause cause, @@ -632,7 +642,7 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { return; } - if (keyEvent is! RawKeyDownEvent) + if (keyEvent is! RawKeyDownEvent || onSelectionChanged == null) return; final Set keysPressed = LogicalKeyboardKey.collapseSynonyms(RawKeyboard.instance.keysPressed); final LogicalKeyboardKey key = keyEvent.logicalKey; @@ -898,10 +908,12 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { newSelection = TextSelection.fromPosition(TextPosition(offset: newOffset)); } - _setSelection( + _handleSelectionChange( newSelection, SelectionChangedCause.keyboard, ); + // Update the text selection delegate so that the engine knows what we did. + textSelectionDelegate.textEditingValue = textSelectionDelegate.textEditingValue.copyWith(selection: newSelection); } // Handles shortcut functionality including cut, copy, paste and select all @@ -949,10 +961,13 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { ); } if (value != null) { - _setTextEditingValue( - value, - SelectionChangedCause.keyboard, - ); + if (textSelectionDelegate.textEditingValue.selection != value.selection) { + _handleSelectionChange( + value.selection, + SelectionChangedCause.keyboard, + ); + } + textSelectionDelegate.textEditingValue = value; } } @@ -979,12 +994,15 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { } } final TextSelection newSelection = TextSelection.collapsed(offset: cursorPosition); - _setTextEditingValue( - TextEditingValue( - text: textBefore + textAfter, - selection: newSelection, - ), - SelectionChangedCause.keyboard, + if (selection != newSelection) { + _handleSelectionChange( + newSelection, + SelectionChangedCause.keyboard, + ); + } + textSelectionDelegate.textEditingValue = TextEditingValue( + text: textBefore + textAfter, + selection: newSelection, ); } @@ -1512,7 +1530,7 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { // callbacks are invoked, in which case the callbacks will crash... void _handleSetSelection(TextSelection selection) { - _setSelection(selection, SelectionChangedCause.keyboard); + _handleSelectionChange(selection, SelectionChangedCause.keyboard); } void _handleMoveCursorForwardByCharacter(bool extentSelection) { @@ -1521,9 +1539,8 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { if (extentOffset == null) return; final int baseOffset = !extentSelection ? extentOffset : selection!.baseOffset; - _setSelection( - TextSelection(baseOffset: baseOffset, extentOffset: extentOffset), - SelectionChangedCause.keyboard, + _handleSelectionChange( + TextSelection(baseOffset: baseOffset, extentOffset: extentOffset), SelectionChangedCause.keyboard, ); } @@ -1533,9 +1550,8 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { if (extentOffset == null) return; final int baseOffset = !extentSelection ? extentOffset : selection!.baseOffset; - _setSelection( - TextSelection(baseOffset: baseOffset, extentOffset: extentOffset), - SelectionChangedCause.keyboard + _handleSelectionChange( + TextSelection(baseOffset: baseOffset, extentOffset: extentOffset), SelectionChangedCause.keyboard, ); } @@ -1546,7 +1562,7 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { if (nextWord == null) return; final int baseOffset = extentSelection ? selection!.baseOffset : nextWord.start; - _setSelection( + _handleSelectionChange( TextSelection( baseOffset: baseOffset, extentOffset: nextWord.start, @@ -1562,12 +1578,12 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { if (previousWord == null) return; final int baseOffset = extentSelection ? selection!.baseOffset : previousWord.start; - _setSelection( + _handleSelectionChange( TextSelection( baseOffset: baseOffset, extentOffset: previousWord.start, ), - SelectionChangedCause.keyboard + SelectionChangedCause.keyboard, ); } @@ -1878,7 +1894,7 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { textSpan.recognizer?.addPointer(event); } - if (!ignorePointer) { + if (!ignorePointer && onSelectionChanged != null) { // Propagates the pointer event to selection handlers. _tap.addPointer(event); _longPress.addPointer(event); @@ -1976,6 +1992,9 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { assert(cause != null); assert(from != null); _layoutText(minWidth: constraints.minWidth, maxWidth: constraints.maxWidth); + if (onSelectionChanged == null) { + return; + } final TextPosition fromPosition = _textPainter.getPositionForOffset(globalToLocal(from - _paintOffset)); final TextPosition? toPosition = to == null ? null @@ -1989,7 +2008,8 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { extentOffset: extentOffset, affinity: fromPosition.affinity, ); - _setSelection(newSelection, cause); + // Call [onSelectionChanged] only when the selection actually changed. + _handleSelectionChange(newSelection, cause); } /// Select a word around the location of the last tap down. @@ -2009,16 +2029,22 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { assert(cause != null); assert(from != null); _layoutText(minWidth: constraints.minWidth, maxWidth: constraints.maxWidth); + if (onSelectionChanged == null) { + return; + } final TextPosition firstPosition = _textPainter.getPositionForOffset(globalToLocal(from - _paintOffset)); final TextSelection firstWord = _selectWordAtOffset(firstPosition); final TextSelection lastWord = to == null ? firstWord : _selectWordAtOffset(_textPainter.getPositionForOffset(globalToLocal(to - _paintOffset))); - final TextSelection newSelection = TextSelection( - baseOffset: firstWord.base.offset, - extentOffset: lastWord.extent.offset, - affinity: firstWord.affinity, + + _handleSelectionChange( + TextSelection( + baseOffset: firstWord.base.offset, + extentOffset: lastWord.extent.offset, + affinity: firstWord.affinity, + ), + cause, ); - _setSelection(newSelection, cause); } /// Move the selection to the beginning or end of a word. @@ -2028,15 +2054,22 @@ class RenderEditable extends RenderBox with RelayoutWhenSystemFontsChangeMixin { assert(cause != null); _layoutText(minWidth: constraints.minWidth, maxWidth: constraints.maxWidth); assert(_lastTapDownPosition != null); + if (onSelectionChanged == null) { + return; + } final TextPosition position = _textPainter.getPositionForOffset(globalToLocal(_lastTapDownPosition! - _paintOffset)); final TextRange word = _textPainter.getWordBoundary(position); - late TextSelection newSelection; if (position.offset - word.start <= 1) { - newSelection = TextSelection.collapsed(offset: word.start, affinity: TextAffinity.downstream); + _handleSelectionChange( + TextSelection.collapsed(offset: word.start, affinity: TextAffinity.downstream), + cause, + ); } else { - newSelection = TextSelection.collapsed(offset: word.end, affinity: TextAffinity.upstream); + _handleSelectionChange( + TextSelection.collapsed(offset: word.end, affinity: TextAffinity.upstream), + cause, + ); } - _setSelection(newSelection, cause); } TextSelection _selectWordAtOffset(TextPosition position) { diff --git a/packages/flutter/lib/src/services/text_input.dart b/packages/flutter/lib/src/services/text_input.dart index 9052a375b0b..7b7fd3e4577 100644 --- a/packages/flutter/lib/src/services/text_input.dart +++ b/packages/flutter/lib/src/services/text_input.dart @@ -754,60 +754,12 @@ class TextEditingValue { ); } -/// Indicates what triggered the change in selected text (including changes to -/// the cursor location). -enum SelectionChangedCause { - /// The user tapped on the text and that caused the selection (or the location - /// of the cursor) to change. - tap, - - /// The user tapped twice in quick succession on the text and that caused - /// the selection (or the location of the cursor) to change. - doubleTap, - - /// The user long-pressed the text and that caused the selection (or the - /// location of the cursor) to change. - longPress, - - /// The user force-pressed the text and that caused the selection (or the - /// location of the cursor) to change. - forcePress, - - /// The user used the keyboard to change the selection or the location of the - /// cursor. - /// - /// Keyboard-triggered selection changes may be caused by the IME as well as - /// by accessibility tools (e.g. TalkBack on Android). - keyboard, - - /// The user used the selection toolbar to change the selection or the - /// location of the cursor. - /// - /// An example is when the user taps on select all in the tool bar. - toolBar, - - /// The user used the mouse to change the selection by dragging over a piece - /// of text. - drag, -} - /// An interface for manipulating the selection, to be used by the implementor /// of the toolbar widget. abstract class TextSelectionDelegate { /// Gets the current text input. TextEditingValue get textEditingValue; - /// Indicates that the user has requested the delegate to replace its current - /// text editing state with [value]. - /// - /// The new [value] is treated as user input and thus may subject to input - /// formatting. - @Deprecated( - 'Use the userUpdateTextEditingValue instead. ' - 'This feature was deprecated after v1.26.0-17.2.pre.' - ) - set textEditingValue(TextEditingValue value) {} - /// Indicates that the user has requested the delegate to replace its current /// text editing state with [value]. /// @@ -816,10 +768,10 @@ abstract class TextSelectionDelegate { /// /// See also: /// - /// * [EditableTextState.userUpdateTextEditingValue]: an implementation that - /// applies additional pre-processing to the specified [value], before - /// updating the text editing state. - void userUpdateTextEditingValue(TextEditingValue value, SelectionChangedCause cause); + /// * [EditableTextState.textEditingValue]: an implementation that applies + /// additional pre-processing to the specified [value], before updating the + /// text editing state. + set textEditingValue(TextEditingValue value); /// Hides the text selection toolbar. void hideToolbar(); diff --git a/packages/flutter/lib/src/widgets/editable_text.dart b/packages/flutter/lib/src/widgets/editable_text.dart index fa8f13ea332..4515a799a4c 100644 --- a/packages/flutter/lib/src/widgets/editable_text.dart +++ b/packages/flutter/lib/src/widgets/editable_text.dart @@ -32,7 +32,8 @@ import 'text.dart'; import 'text_selection.dart'; import 'ticker_provider.dart'; -export 'package:flutter/services.dart' show SelectionChangedCause, TextEditingValue, TextSelection, TextInputType, SmartQuotesType, SmartDashesType; +export 'package:flutter/rendering.dart' show SelectionChangedCause; +export 'package:flutter/services.dart' show TextEditingValue, TextSelection, TextInputType, SmartQuotesType, SmartDashesType; /// Signature for the callback that reports when the user changes the selection /// (including the cursor location). @@ -1479,7 +1480,7 @@ class EditableText extends StatefulWidget { } /// State for a [EditableText]. -class EditableTextState extends State with AutomaticKeepAliveClientMixin, WidgetsBindingObserver, TickerProviderStateMixin, TextSelectionDelegate implements TextInputClient, AutofillClient { +class EditableTextState extends State with AutomaticKeepAliveClientMixin, WidgetsBindingObserver, TickerProviderStateMixin implements TextSelectionDelegate, TextInputClient, AutofillClient { Timer? _cursorTimer; bool _targetCursorVisibility = false; final ValueNotifier _cursorVisibilityNotifier = ValueNotifier(true); @@ -1714,7 +1715,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien if (value.text == _value.text && value.composing == _value.composing) { // `selection` is the only change. - _handleSelectionChanged(value.selection, SelectionChangedCause.keyboard); + _handleSelectionChanged(value.selection, renderEditable, SelectionChangedCause.keyboard); } else { hideToolbar(); _currentPromptRectRange = null; @@ -1727,7 +1728,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien } } - _formatAndSetValue(value, SelectionChangedCause.keyboard); + _formatAndSetValue(value); } if (_hasInputConnection) { @@ -1835,7 +1836,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien renderEditable.setFloatingCursor(FloatingCursorDragState.End, finalPosition, _lastTextPosition!); if (_lastTextPosition!.offset != renderEditable.selection!.baseOffset) // The cause is technically the force cursor, but the cause is listed as tap as the desired functionality is the same. - _handleSelectionChanged(TextSelection.collapsed(offset: _lastTextPosition!.offset), SelectionChangedCause.forcePress); + _handleSelectionChanged(TextSelection.collapsed(offset: _lastTextPosition!.offset), renderEditable, SelectionChangedCause.forcePress); _startCaretRect = null; _lastTextPosition = null; _pointOffsetOrigin = null; @@ -2101,7 +2102,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien } } - void _handleSelectionChanged(TextSelection selection, SelectionChangedCause? cause) { + void _handleSelectionChanged(TextSelection selection, RenderEditable renderObject, SelectionChangedCause? cause) { // We return early if the selection is not valid. This can happen when the // text of [EditableText] is updated at the same time as the selection is // changed by a gesture event. @@ -2113,43 +2114,37 @@ class EditableTextState extends State with AutomaticKeepAliveClien // This will show the keyboard for all selection changes on the // EditableWidget, not just changes triggered by user gestures. requestKeyboard(); - if (widget.selectionControls == null) { - _selectionOverlay?.hide(); - _selectionOverlay = null; - } else { - if (_selectionOverlay == null) { - _selectionOverlay = TextSelectionOverlay( - clipboardStatus: _clipboardStatus, - context: context, - value: _value, - debugRequiredFor: widget, - toolbarLayerLink: _toolbarLayerLink, - startHandleLayerLink: _startHandleLayerLink, - endHandleLayerLink: _endHandleLayerLink, - renderObject: renderEditable, - selectionControls: widget.selectionControls, - selectionDelegate: this, - dragStartBehavior: widget.dragStartBehavior, - onSelectionHandleTapped: widget.onSelectionHandleTapped, - ); - } else { - _selectionOverlay!.update(_value); - } + + _selectionOverlay?.hide(); + _selectionOverlay = null; + + if (widget.selectionControls != null) { + _selectionOverlay = TextSelectionOverlay( + clipboardStatus: _clipboardStatus, + context: context, + value: _value, + debugRequiredFor: widget, + toolbarLayerLink: _toolbarLayerLink, + startHandleLayerLink: _startHandleLayerLink, + endHandleLayerLink: _endHandleLayerLink, + renderObject: renderObject, + selectionControls: widget.selectionControls, + selectionDelegate: this, + dragStartBehavior: widget.dragStartBehavior, + onSelectionHandleTapped: widget.onSelectionHandleTapped, + ); _selectionOverlay!.handlesVisible = widget.showSelectionHandles; _selectionOverlay!.showHandles(); - } - // TODO(chunhtai): we should make sure selection actually changed before - // we call the onSelectionChanged. - // https://github.com/flutter/flutter/issues/76349. - try { - widget.onSelectionChanged?.call(selection, cause); - } catch (exception, stack) { - FlutterError.reportError(FlutterErrorDetails( - exception: exception, - stack: stack, - library: 'widgets', - context: ErrorDescription('while calling onSelectionChanged for $cause'), - )); + try { + widget.onSelectionChanged?.call(selection, cause); + } catch (exception, stack) { + FlutterError.reportError(FlutterErrorDetails( + exception: exception, + stack: stack, + library: 'widgets', + context: ErrorDescription('while calling onSelectionChanged for $cause'), + )); + } } // To keep the cursor from blinking while it moves, restart the timer here. @@ -2244,7 +2239,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien late final _WhitespaceDirectionalityFormatter _whitespaceFormatter = _WhitespaceDirectionalityFormatter(textDirection: _textDirection); - void _formatAndSetValue(TextEditingValue value, SelectionChangedCause? cause, {bool userInteraction = false}) { + void _formatAndSetValue(TextEditingValue value) { // Only apply input formatters if the text has changed (including uncommited // text in the composing region), or when the user committed the composing // text. @@ -2276,16 +2271,6 @@ class EditableTextState extends State with AutomaticKeepAliveClien // sending multiple `TextInput.updateEditingValue` messages. beginBatchEdit(); _value = value; - // Changes made by the keyboard can sometimes be "out of band" for listening - // components, so always send those events, even if we didn't think it - // changed. Also, the user long pressing should always send a selection change - // as well. - if (selectionChanged || - (userInteraction && - (cause == SelectionChangedCause.longPress || - cause == SelectionChangedCause.keyboard))) { - _handleSelectionChanged(value.selection, cause); - } if (textChanged) { try { widget.onChanged?.call(value.text); @@ -2299,6 +2284,19 @@ class EditableTextState extends State with AutomaticKeepAliveClien } } + if (selectionChanged) { + try { + widget.onSelectionChanged?.call(value.selection, null); + } catch (exception, stack) { + FlutterError.reportError(FlutterErrorDetails( + exception: exception, + stack: stack, + library: 'widgets', + context: ErrorDescription('while calling onSelectionChanged'), + )); + } + } + endBatchEdit(); } @@ -2409,7 +2407,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien _showCaretOnScreen(); if (!_value.selection.isValid) { // Place cursor at the end if the selection is invalid when we receive focus. - _handleSelectionChanged(TextSelection.collapsed(offset: _value.text.length), null); + _handleSelectionChanged(TextSelection.collapsed(offset: _value.text.length), renderEditable, null); } } else { WidgetsBinding.instance!.removeObserver(this); @@ -2471,8 +2469,9 @@ class EditableTextState extends State with AutomaticKeepAliveClien double get _devicePixelRatio => MediaQuery.of(context).devicePixelRatio; @override - void userUpdateTextEditingValue(TextEditingValue value, SelectionChangedCause? cause) { - _formatAndSetValue(value, cause, userInteraction: true); + set textEditingValue(TextEditingValue value) { + _selectionOverlay?.update(value); + _formatAndSetValue(value); } @override @@ -2635,6 +2634,7 @@ class EditableTextState extends State with AutomaticKeepAliveClien smartQuotesType: widget.smartQuotesType, enableSuggestions: widget.enableSuggestions, offset: offset, + onSelectionChanged: _handleSelectionChanged, onCaretChanged: _handleCaretChanged, rendererIgnoresPointer: widget.rendererIgnoresPointer, cursorWidth: widget.cursorWidth, @@ -2718,6 +2718,7 @@ class _Editable extends LeafRenderObjectWidget { required this.smartQuotesType, required this.enableSuggestions, required this.offset, + this.onSelectionChanged, this.onCaretChanged, this.rendererIgnoresPointer = false, required this.cursorWidth, @@ -2765,6 +2766,7 @@ class _Editable extends LeafRenderObjectWidget { final SmartQuotesType smartQuotesType; final bool enableSuggestions; final ViewportOffset offset; + final SelectionChangedHandler? onSelectionChanged; final CaretChangedHandler? onCaretChanged; final bool rendererIgnoresPointer; final double cursorWidth; @@ -2804,6 +2806,7 @@ class _Editable extends LeafRenderObjectWidget { locale: locale ?? Localizations.maybeLocaleOf(context), selection: value.selection, offset: offset, + onSelectionChanged: onSelectionChanged, onCaretChanged: onCaretChanged, ignorePointer: rendererIgnoresPointer, obscuringCharacter: obscuringCharacter, @@ -2848,6 +2851,7 @@ class _Editable extends LeafRenderObjectWidget { ..locale = locale ?? Localizations.maybeLocaleOf(context) ..selection = value.selection ..offset = offset + ..onSelectionChanged = onSelectionChanged ..onCaretChanged = onCaretChanged ..ignorePointer = rendererIgnoresPointer ..textHeightBehavior = textHeightBehavior diff --git a/packages/flutter/lib/src/widgets/text_selection.dart b/packages/flutter/lib/src/widgets/text_selection.dart index eaf0294582a..40c68875612 100644 --- a/packages/flutter/lib/src/widgets/text_selection.dart +++ b/packages/flutter/lib/src/widgets/text_selection.dart @@ -205,15 +205,12 @@ abstract class TextSelectionControls { Clipboard.setData(ClipboardData( text: value.selection.textInside(value.text), )); - delegate.userUpdateTextEditingValue( - TextEditingValue( - text: value.selection.textBefore(value.text) - + value.selection.textAfter(value.text), - selection: TextSelection.collapsed( - offset: value.selection.start - ) + delegate.textEditingValue = TextEditingValue( + text: value.selection.textBefore(value.text) + + value.selection.textAfter(value.text), + selection: TextSelection.collapsed( + offset: value.selection.start ), - SelectionChangedCause.toolBar, ); delegate.bringIntoView(delegate.textEditingValue.selection.extent); delegate.hideToolbar(); @@ -231,12 +228,9 @@ abstract class TextSelectionControls { text: value.selection.textInside(value.text), )); clipboardStatus?.update(); - delegate.userUpdateTextEditingValue( - TextEditingValue( - text: value.text, - selection: TextSelection.collapsed(offset: value.selection.end), - ), - SelectionChangedCause.toolBar, + delegate.textEditingValue = TextEditingValue( + text: value.text, + selection: TextSelection.collapsed(offset: value.selection.end), ); delegate.bringIntoView(delegate.textEditingValue.selection.extent); delegate.hideToolbar(); @@ -257,16 +251,13 @@ abstract class TextSelectionControls { final TextEditingValue value = delegate.textEditingValue; // Snapshot the input before using `await`. final ClipboardData? data = await Clipboard.getData(Clipboard.kTextPlain); if (data != null) { - delegate.userUpdateTextEditingValue( - TextEditingValue( - text: value.selection.textBefore(value.text) - + data.text! - + value.selection.textAfter(value.text), - selection: TextSelection.collapsed( - offset: value.selection.start + data.text!.length - ), + delegate.textEditingValue = TextEditingValue( + text: value.selection.textBefore(value.text) + + data.text! + + value.selection.textAfter(value.text), + selection: TextSelection.collapsed( + offset: value.selection.start + data.text!.length ), - SelectionChangedCause.toolBar, ); } delegate.bringIntoView(delegate.textEditingValue.selection.extent); @@ -281,15 +272,12 @@ abstract class TextSelectionControls { /// This is called by subclasses when their select-all affordance is activated /// by the user. void handleSelectAll(TextSelectionDelegate delegate) { - delegate.userUpdateTextEditingValue( - TextEditingValue( - text: delegate.textEditingValue.text, - selection: TextSelection( - baseOffset: 0, - extentOffset: delegate.textEditingValue.text.length, - ), + delegate.textEditingValue = TextEditingValue( + text: delegate.textEditingValue.text, + selection: TextSelection( + baseOffset: 0, + extentOffset: delegate.textEditingValue.text.length, ), - SelectionChangedCause.toolBar, ); delegate.bringIntoView(delegate.textEditingValue.selection.extent); } @@ -448,16 +436,13 @@ class TextSelectionOverlay { /// Builds the handles by inserting them into the [context]'s overlay. void showHandles() { - if (_handles != null) - return; - + assert(_handles == null); _handles = [ OverlayEntry(builder: (BuildContext context) => _buildHandle(context, _TextSelectionHandlePosition.start)), OverlayEntry(builder: (BuildContext context) => _buildHandle(context, _TextSelectionHandlePosition.end)), ]; - Overlay.of(context, rootOverlay: true, debugRequiredFor: debugRequiredFor)! - .insertAll(_handles!); + Overlay.of(context, rootOverlay: true, debugRequiredFor: debugRequiredFor)!.insertAll(_handles!); } /// Destroys the handles by removing them from overlay. @@ -628,13 +613,10 @@ class TextSelectionOverlay { textPosition = newSelection.base; break; case _TextSelectionHandlePosition.end: - textPosition = newSelection.extent; + textPosition =newSelection.extent; break; } - selectionDelegate!.userUpdateTextEditingValue( - _value.copyWith(selection: newSelection, composing: TextRange.empty), - SelectionChangedCause.drag, - ); + selectionDelegate!.textEditingValue = _value.copyWith(selection: newSelection, composing: TextRange.empty); selectionDelegate!.bringIntoView(textPosition); } } diff --git a/packages/flutter/test/cupertino/text_field_test.dart b/packages/flutter/test/cupertino/text_field_test.dart index c2ecf47e4c4..d87898cfce4 100644 --- a/packages/flutter/test/cupertino/text_field_test.dart +++ b/packages/flutter/test/cupertino/text_field_test.dart @@ -3475,6 +3475,7 @@ void main() { from: tester.getTopRight(find.byType(CupertinoApp)), cause: SelectionChangedCause.tap, ); + expect(state.showToolbar(), true); await tester.pumpAndSettle(); // -1 because we want to reach the end of the line, not the start of a new line. @@ -3535,6 +3536,7 @@ void main() { from: tester.getCenter(find.byType(EditableText)), cause: SelectionChangedCause.tap, ); + expect(state.showToolbar(), true); await tester.pumpAndSettle(); bottomLeftSelectionPosition = textOffsetToBottomLeftPosition(tester, state.renderEditable.selection!.baseOffset); diff --git a/packages/flutter/test/material/text_field_focus_test.dart b/packages/flutter/test/material/text_field_focus_test.dart index aa308d82773..1fe547b169f 100644 --- a/packages/flutter/test/material/text_field_focus_test.dart +++ b/packages/flutter/test/material/text_field_focus_test.dart @@ -119,8 +119,6 @@ void main() { expect(tester.testTextInput.isVisible, isTrue); tester.testTextInput.hide(); - final EditableTextState state = tester.state(find.byType(EditableText)); - state.connectionClosed(); expect(tester.testTextInput.isVisible, isFalse); diff --git a/packages/flutter/test/material/text_field_test.dart b/packages/flutter/test/material/text_field_test.dart index 662510582da..beef4ade025 100644 --- a/packages/flutter/test/material/text_field_test.dart +++ b/packages/flutter/test/material/text_field_test.dart @@ -18,8 +18,6 @@ import '../widgets/editable_text_utils.dart' show findRenderEditable, globalize, import '../widgets/semantics_tester.dart'; import 'feedback_tester.dart'; -typedef FormatEditUpdateCallback = void Function(TextEditingValue, TextEditingValue); - class MockClipboard { Object _clipboardData = { 'text': null, @@ -129,16 +127,6 @@ double getOpacity(WidgetTester tester, Finder finder) { ).opacity.value; } -class TestFormatter extends TextInputFormatter { - TestFormatter(this.onFormatEditUpdate); - FormatEditUpdateCallback onFormatEditUpdate; - @override - TextEditingValue formatEditUpdate(TextEditingValue oldValue, TextEditingValue newValue) { - onFormatEditUpdate(oldValue, newValue); - return newValue; - } -} - void main() { TestWidgetsFlutterBinding.ensureInitialized(); final MockClipboard mockClipboard = MockClipboard(); @@ -486,47 +474,6 @@ void main() { ); }, variant: const TargetPlatformVariant({ TargetPlatform.iOS, TargetPlatform.macOS })); - testWidgets('TextInputFormatter gets correct selection value', (WidgetTester tester) async { - late TextEditingValue actualOldValue; - late TextEditingValue actualNewValue; - final FormatEditUpdateCallback callBack = (TextEditingValue oldValue, TextEditingValue newValue) { - actualOldValue = oldValue; - actualNewValue = newValue; - }; - final FocusNode focusNode = FocusNode(); - final TextEditingController controller = TextEditingController(text: '123'); - await tester.pumpWidget( - boilerplate( - child: TextField( - controller: controller, - focusNode: focusNode, - inputFormatters: [TestFormatter(callBack)], - ), - ), - ); - - await tester.tap(find.byType(TextField)); - await tester.pumpAndSettle(); - - await tester.sendKeyEvent(LogicalKeyboardKey.backspace); - await tester.pumpAndSettle(); - - expect( - actualOldValue, - const TextEditingValue( - text: '123', - selection: TextSelection.collapsed(offset: 3, affinity: TextAffinity.upstream), - ), - ); - expect( - actualNewValue, - const TextEditingValue( - text: '12', - selection: TextSelection.collapsed(offset: 2), - ), - ); - }); - testWidgets('text field selection toolbar renders correctly inside opacity', (WidgetTester tester) async { await tester.pumpWidget( MaterialApp( @@ -1124,9 +1071,11 @@ void main() { )); expect(find.text('Paste'), findsNothing); + final Offset emptyPos = textOffsetToPosition(tester, 0); await tester.longPressAt(emptyPos, pointer: 7); await tester.pumpAndSettle(); + expect(find.text('Paste'), findsOneWidget); }); diff --git a/packages/flutter/test/rendering/editable_test.dart b/packages/flutter/test/rendering/editable_test.dart index 92438f1278e..812410fbcc2 100644 --- a/packages/flutter/test/rendering/editable_test.dart +++ b/packages/flutter/test/rendering/editable_test.dart @@ -18,9 +18,6 @@ class FakeEditableTextState with TextSelectionDelegate { @override TextEditingValue textEditingValue = TextEditingValue.empty; - @override - void userUpdateTextEditingValue(TextEditingValue value, SelectionChangedCause cause) { } - @override void hideToolbar() { } diff --git a/packages/flutter/test/widgets/editable_text_cursor_test.dart b/packages/flutter/test/widgets/editable_text_cursor_test.dart index 5303fe958c0..d57a7d8e277 100644 --- a/packages/flutter/test/widgets/editable_text_cursor_test.dart +++ b/packages/flutter/test/widgets/editable_text_cursor_test.dart @@ -48,7 +48,6 @@ void main() { }); testWidgets('cursor layout has correct width', (WidgetTester tester) async { - EditableText.debugDeterministicCursor = true; final GlobalKey editableTextKey = GlobalKey(); late String changedValue; @@ -88,7 +87,8 @@ void main() { await tester.pumpAndSettle(); await tester.tap(find.text('Paste')); - await tester.pump(); + // Wait for cursor to appear. + await tester.pump(const Duration(milliseconds: 600)); expect(changedValue, clipboardContent); @@ -96,7 +96,6 @@ void main() { find.byKey(const ValueKey(1)), matchesGoldenFile('editable_text_test.0.png'), ); - EditableText.debugDeterministicCursor = false; }); testWidgets('cursor layout has correct radius', (WidgetTester tester) async { @@ -788,7 +787,6 @@ void main() { }, variant: const TargetPlatformVariant({ TargetPlatform.iOS, TargetPlatform.macOS })); testWidgets('cursor layout', (WidgetTester tester) async { - EditableText.debugDeterministicCursor = true; final GlobalKey editableTextKey = GlobalKey(); late String changedValue; @@ -833,7 +831,8 @@ void main() { await tester.pumpAndSettle(); await tester.tap(find.text('Paste')); - await tester.pump(); + // Wait for cursor to appear. + await tester.pump(const Duration(milliseconds: 600)); expect(changedValue, clipboardContent); @@ -841,11 +840,9 @@ void main() { find.byKey(const ValueKey(1)), matchesGoldenFile('editable_text_test.2.png'), ); - EditableText.debugDeterministicCursor = false; }, variant: const TargetPlatformVariant({ TargetPlatform.iOS, TargetPlatform.macOS })); testWidgets('cursor layout has correct height', (WidgetTester tester) async { - EditableText.debugDeterministicCursor = true; final GlobalKey editableTextKey = GlobalKey(); late String changedValue; @@ -891,7 +888,8 @@ void main() { await tester.pumpAndSettle(); await tester.tap(find.text('Paste')); - await tester.pump(); + // Wait for cursor to appear. + await tester.pump(const Duration(milliseconds: 600)); expect(changedValue, clipboardContent); @@ -899,6 +897,5 @@ void main() { find.byKey(const ValueKey(1)), matchesGoldenFile('editable_text_test.3.png'), ); - EditableText.debugDeterministicCursor = false; }, variant: const TargetPlatformVariant({ TargetPlatform.iOS, TargetPlatform.macOS })); } diff --git a/packages/flutter/test/widgets/editable_text_test.dart b/packages/flutter/test/widgets/editable_text_test.dart index 622a6705c31..f8383ab430c 100644 --- a/packages/flutter/test/widgets/editable_text_test.dart +++ b/packages/flutter/test/widgets/editable_text_test.dart @@ -5199,7 +5199,7 @@ void main() { tester.testTextInput.log.clear(); final EditableTextState state = tester.state(find.byWidget(editableText)); - state.userUpdateTextEditingValue(const TextEditingValue(text: 'remoteremoteremote'), SelectionChangedCause.keyboard); + state.textEditingValue = const TextEditingValue(text: 'remoteremoteremote'); // Apply in order: length formatter -> listener -> onChanged -> listener. expect(controller.text, 'remote listener onChanged listener'); @@ -5355,7 +5355,6 @@ void main() { 'TextInput.setEditingState', 'TextInput.setEditingState', 'TextInput.show', - 'TextInput.show', ]; expect(tester.testTextInput.log.length, logOrder.length); int index = 0; @@ -5470,18 +5469,16 @@ void main() { log.clear(); final EditableTextState state = tester.firstState(find.byType(EditableText)); - // setEditingState is not called when only the remote changes - state.updateEditingValue(TextEditingValue( - text: 'a', - selection: controller.selection, - )); + // setEditingState is not called when only the remote changes + state.updateEditingValue(const TextEditingValue( + text: 'a', + )); expect(log.length, 0); // setEditingState is called when remote value modified by the formatter. - state.updateEditingValue(TextEditingValue( + state.updateEditingValue(const TextEditingValue( text: 'I will be modified by the formatter.', - selection: controller.selection, )); expect(log.length, 1); MethodCall methodCall = log[0]; @@ -5595,9 +5592,8 @@ void main() { final EditableTextState state = tester.firstState(find.byType(EditableText)); // setEditingState is called when remote value modified by the formatter. - state.updateEditingValue(TextEditingValue( + state.updateEditingValue(const TextEditingValue( text: 'I will be modified by the formatter.', - selection: controller.selection, )); expect(log.length, 1); expect(log, contains(matchesMethodCall( @@ -5669,9 +5665,8 @@ void main() { final EditableTextState state = tester.firstState(find.byType(EditableText)); - state.updateEditingValue(TextEditingValue( + state.updateEditingValue(const TextEditingValue( text: 'a', - selection: controller.selection, )); await tester.pump(); @@ -5694,9 +5689,8 @@ void main() { log.clear(); // Send repeat value from the engine. - state.updateEditingValue(TextEditingValue( + state.updateEditingValue(const TextEditingValue( text: 'a', - selection: controller.selection, )); await tester.pump(); @@ -5790,9 +5784,8 @@ void main() { final EditableTextState state = tester.firstState(find.byType(EditableText)); - state.updateEditingValue(TextEditingValue( + state.updateEditingValue(const TextEditingValue( text: 'a', - selection: controller.selection, )); await tester.pump(); @@ -6586,7 +6579,6 @@ void main() { final EditableTextState state = tester.state(find.byType(EditableText)); state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); controller.selection = const TextSelection.collapsed(offset: 2); @@ -6595,7 +6587,6 @@ void main() { // Reset the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); expect(state.currentTextEditingValue.composing, const TextRange(start: 4, end: 12)); @@ -6603,14 +6594,13 @@ void main() { // Positioning cursor after the composing range should clear the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); controller.selection = const TextSelection.collapsed(offset: 14); expect(state.currentTextEditingValue.composing, TextRange.empty); }); - testWidgets('Clears composing range if cursor moves outside that range - case two', (WidgetTester tester) async { + testWidgets('Clears composing range if cursor moves outside that range', (WidgetTester tester) async { final Widget widget = MaterialApp( home: EditableText( backgroundCursorColor: Colors.grey, @@ -6627,7 +6617,6 @@ void main() { final EditableTextState state = tester.state(find.byType(EditableText)); state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); controller.selection = const TextSelection(baseOffset: 1, extentOffset: 2); @@ -6636,7 +6625,6 @@ void main() { // Reset the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); expect(state.currentTextEditingValue.composing, const TextRange(start: 4, end: 12)); @@ -6644,7 +6632,6 @@ void main() { // Setting a selection within the composing range clears the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); controller.selection = const TextSelection(baseOffset: 5, extentOffset: 7); @@ -6653,7 +6640,6 @@ void main() { // Reset the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); expect(state.currentTextEditingValue.composing, const TextRange(start: 4, end: 12)); @@ -6661,7 +6647,6 @@ void main() { // Setting a selection after the composing range clears the composing range. state.updateEditingValue(const TextEditingValue( text: 'foo composing bar', - selection: TextSelection.collapsed(offset: 4), composing: TextRange(start: 4, end: 12), )); controller.selection = const TextSelection(baseOffset: 13, extentOffset: 15); diff --git a/packages/flutter/test/widgets/text_selection_test.dart b/packages/flutter/test/widgets/text_selection_test.dart index 67ae7f67a65..2f8a89caf15 100644 --- a/packages/flutter/test/widgets/text_selection_test.dart +++ b/packages/flutter/test/widgets/text_selection_test.dart @@ -797,7 +797,6 @@ class FakeRenderEditable extends RenderEditable { ), startHandleLayerLink: LayerLink(), endHandleLayerLink: LayerLink(), - ignorePointer: true, textAlign: TextAlign.start, textDirection: TextDirection.ltr, locale: const Locale('en', 'US'),