Version 0.2.9

* Removed from SelectableController the deprecated properties `text`, `selectionStart`, `selectionEnd`, and `rects`.
* Added the ability to customize how the rectangles of selected text is converted to selection rectangles via the new SelectableController `setCustomRectifier` method. See the included example app for an example of its use.

Author: ronjb

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## [0.2.9] - December 30, 2022
+
+* Removed from SelectableController the deprecated properties `text`, `selectionStart`, `selectionEnd`, and `rects`.
+* Added the ability to customize how the rectangles of selected text is converted to selection rectangles via the new SelectableController `setCustomRectifier` method. See the included example app for an example of its use.
+
 ## [0.2.8] - December 10, 2022
 
 * Added `int? get startIndex` and `int? get endIndex` to the Selection class.

example/android/app/build.gradle

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 31
+    compileSdkVersion 33
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8

example/lib/main.dart

@@ -49,8 +49,12 @@ class _MyHomePageState extends State<MyHomePage> {
     super.initState();
 
     _selectionController
-        // ..setCustomPainter(MySelectionPainter())
-        .addListener(_selectionChangedListener);
+      // ..setCustomPainter(MySelectionPainter())
+      // ..setCustomRectifier(SelectionRectifiers.merged)
+      ..setCustomRectifier((rects) => rects
+          .map((r) => Rect.fromLTRB(r.left - 2, r.top, r.right + 2, r.bottom))
+          .toList())
+      ..addListener(_selectionChangedListener);
 
     _timer =
         Timer.periodic(const Duration(seconds: 1), (_) => _selectRandomWord());
@@ -87,6 +91,16 @@ class _MyHomePageState extends State<MyHomePage> {
     });
   }
 
+  void _toggleRectifier() {
+    setState(() {
+      _selectionController.setCustomRectifier(
+          _selectionController.getCustomRectifier() ==
+                  SelectionRectifiers.identity
+              ? SelectionRectifiers.merged
+              : SelectionRectifiers.identity);
+    });
+  }
+
   void _selectRandomWord() {
     // final text = _selectionController.getContainedText();
     // if (text.isNotEmpty) {
@@ -173,9 +187,20 @@ class _MyHomePageState extends State<MyHomePage> {
         ],
       ),
       floatingActionButton: _isTextSelected
-          ? FloatingActionButton.extended(
-              onPressed: _toggleShowHideSelection,
-              label: Text(_showSelection ? 'hide selection' : 'show selection'),
+          ? Column(
+              mainAxisSize: MainAxisSize.min,
+              children: [
+                FloatingActionButton.extended(
+                  onPressed: _toggleShowHideSelection,
+                  label: Text(
+                      _showSelection ? 'hide selection' : 'show selection'),
+                ),
+                const SizedBox(height: 8),
+                FloatingActionButton.extended(
+                  onPressed: _toggleRectifier,
+                  label: const Text('switch rectifier'),
+                ),
+              ],
             )
           : null,
     );

example/pubspec.lock

@@ -148,7 +148,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.2.8"
+    version: "0.2.9"
   sky_engine:
     dependency: transitive
     description: flutter

lib/selectable.dart

@@ -4,6 +4,7 @@
 
 library selectable;
 
+export 'src/common.dart' show SelectionRectifiers;
 export 'src/ignore_selectable.dart';
 export 'src/inline_span_ext.dart';
 export 'src/selectable.dart';

lib/src/common.dart

@@ -100,6 +100,13 @@ extension SelectableExtOnListOfRect on List<Rect> {
       );
 }
 
+// ignore: avoid_classes_with_only_static_members
+class SelectionRectifiers {
+  static List<Rect> identity(List<Rect> rects) => rects;
+
+  static List<Rect> merged(List<Rect> rects) => rects.mergedToSelectionRects();
+}
+
 ///
 /// Iterable<Rect> extensions
 ///
@@ -125,10 +132,6 @@ extension SelectableExtOnIterableOfRect on Iterable<Rect> {
   /// └──────────────────────┘
   /// ```
   List<Rect> mergedToSelectionRects() {
-    //
-    // IMPORTANT: If this algorithm is changed, please also change the
-    //            algorithm in Iterable<TextBox>.mergedToSelectionRects.
-    //
     Rect? firstLine;
     Rect? lastLine;
     final rect = fold<Rect?>(
@@ -172,72 +175,6 @@ extension SelectableExtOnIterableOfRect on Iterable<Rect> {
       rect.bottom.roundToDouble()));
 }
 
-///
-/// Iterable<TextBox> extensions
-///
-extension SelectableExtOnIterableOfTextBox on Iterable<TextBox> {
-  /// Merges the text boxes into, at most, three rects, where the first rect
-  /// is the bounding box containing all the rects in the first line, the
-  /// second rect is the bounding box of lines 1 through N - 1 (where N is
-  /// the number of lines), and the third rect is the bounding box of the
-  /// last line.
-  ///
-  /// Assumes that the text boxes are in 'reading order', i.e. left to right,
-  /// top to bottom. Does not support languages that have  an alternate order.
-  ///
-  /// For example:
-  /// ```
-  ///                 ┌─────────────────┐
-  ///                 │ first line      │
-  /// ┌───────────────┴─────────────────┤
-  /// │ middle line(s)                  │
-  /// |                                 |
-  /// ├──────────────────────┬──────────┘
-  /// │ last line            │
-  /// └──────────────────────┘
-  /// ```
-  List<Rect> mergedToSelectionRects() {
-    //
-    // IMPORTANT: If this algorithm is changed, please also change the
-    //            algorithm in Iterable<Rect>.mergedToSelectionRects.
-    //
-    Rect? firstLine;
-    Rect? lastLine;
-    final rect = fold<Rect?>(
-      null,
-      (previous, r) {
-        if (firstLine == null) {
-          firstLine = r.toRect();
-        } else if (lastLine == null &&
-            (r.vCenter < firstLine!.bottom || firstLine!.vCenter > r.top)) {
-          firstLine = firstLine!.expandToIncludeTextBox(r);
-        } else if (lastLine == null ||
-            (r.vCenter > lastLine!.bottom && lastLine!.vCenter < r.top)) {
-          lastLine = r.toRect();
-        } else {
-          lastLine = lastLine!.expandToIncludeTextBox(r);
-        }
-        return Rect.fromLTRB(
-          math.min(previous?.left ?? r.left, r.left),
-          math.min(previous?.top ?? r.top, r.top),
-          math.max(previous?.right ?? r.right, r.right),
-          math.max(previous?.bottom ?? r.bottom, r.bottom),
-        );
-      },
-    );
-    if (firstLine == null) return [];
-    if (lastLine == null) return [rect!];
-    if (firstLine!.bottom >= lastLine!.top) return [firstLine!, lastLine!];
-    return [
-      Rect.fromLTRB(
-          firstLine!.left, firstLine!.top, rect!.right, firstLine!.bottom),
-      Rect.fromLTRB(rect.left, firstLine!.bottom, rect.right, lastLine!.top),
-      Rect.fromLTRB(
-          rect.left, lastLine!.top, lastLine!.right, lastLine!.bottom),
-    ];
-  }
-}
-
 ///
 /// Rect extensions
 ///

lib/src/selectable.dart

@@ -18,7 +18,6 @@ import 'selection_controls.dart';
 import 'selection_painter.dart';
 import 'selection_paragraph.dart';
 import 'selections.dart';
-import 'tagged_text.dart';
 
 part 'selectable_controller.dart';
 
@@ -155,11 +154,11 @@ class _SelectableState extends State<Selectable>
     final sc = _selectionController!;
 
     if (sc.isTextSelected &&
-        _selections.main.isHidden != sc.getSelection()!.isHidden) {
+        (_selections.main?.isHidden ?? false) != sc.getSelection()!.isHidden) {
       // ignore: avoid_positional_boolean_parameters
       // String bToStr(bool isHidden) => isHidden ? 'hidden' : 'visible';
       // dmPrint('Selection state changed from '
-      //     '${bToStr(_selections.main.isHidden)} to '
+      //     '${bToStr(_selections.main?.isHidden ?? false)} to '
       //     '${bToStr(sc.isHidden)}.');
       _selectionIsHidden = sc.getSelection()!.isHidden;
       if (_selectionIsHidden) {
@@ -227,7 +226,8 @@ class _SelectableState extends State<Selectable>
     if (isScrolling != _buildHelper.isScrolling) {
       // dmPrint(isScrolling ? 'STARTED SCROLLING...' : 'STOPPED SCROLLING.');
       _buildHelper.isScrolling = isScrolling;
-      if (_selections.main.isTextSelected && _buildHelper.showPopupMenu) {
+      if ((_selections.main?.isTextSelected ?? false) &&
+          _buildHelper.showPopupMenu) {
         _refresh();
       }
     }
@@ -259,8 +259,8 @@ class _SelectableState extends State<Selectable>
 
     // Ignore taps if text is not selected, because the child might want to
     // handle them.
-    final ignoreTap =
-        !(widget.showSelectionControls && _selections.main.isTextSelected);
+    final ignoreTap = !(widget.showSelectionControls &&
+        (_selections.main?.isTextSelected ?? false));
 
     // This is how the selection color is set in the Flutter 2.5.2
     // version of src/material/selectable_text.dart, except that
@@ -300,33 +300,33 @@ class _SelectableState extends State<Selectable>
                 ? _selectionController?.getCustomPainter() ??
                     DefaultSelectionPainter(
                       color: selectionColor,
-                      opacityAnimation:
-                          _selectionIsHidden == _selections.main.isHidden
-                              ? _selectionOpacityController
-                              : _selections.main.isHidden
-                                  ? kAlwaysDismissedAnimation
-                                  : kAlwaysCompleteAnimation,
+                      opacityAnimation: _selectionIsHidden ==
+                              (_selections.main?.isHidden ?? false)
+                          ? _selectionOpacityController
+                          : (_selections.main?.isHidden ?? false)
+                              ? kAlwaysDismissedAnimation
+                              : kAlwaysCompleteAnimation,
                     )
                 : null,
             child: IgnorePointer(
               // Ignore gestures (e.g. taps) on the child if text is selected.
               ignoring: widget.showSelectionControls &&
                   (_selections.dragInfo.isSelectingWordOrDraggingHandle ||
-                      _selections.main.isTextSelected),
+                      (_selections.main?.isTextSelected ?? false)),
               child: widget.child,
             ),
           ),
         ),
         if (widget.showSelection &&
             (_selections.dragInfo.isSelectingWordOrDraggingHandle ||
-                _selections.main.isTextSelected ||
+                (_selections.main?.isTextSelected ?? false) ||
                 _buildHelper.showParagraphRects))
           Positioned.fill(
             child: LayoutBuilder(
               builder: (context, constraints) {
                 // If text is selected, and a handle is being dragged,
                 // autoscroll if necessary.
-                if (_selections.main.isTextSelected &&
+                if ((_selections.main?.isTextSelected ?? false) &&
                     _selections.dragInfo.isDraggingHandle) {
                   final paragraphs = _selections.cachedParagraphs.list;
                   assert(paragraphs.isNotEmpty);
@@ -346,16 +346,17 @@ class _SelectableState extends State<Selectable>
                 }
 
                 // dmPrint('selection.update resulted in '
-                //    '${_selections.main.rects?.length ?? 0} selection rects');
+                //   '${_selections.main?.rects?.length ?? 0} selection rects');
                 _selections.dragInfo
                   ..selectionPt = null
                   ..handleType = null;
 
-                if ((_selections.main.rects?.isNotEmpty ?? false) ||
+                if ((_selections.main?.rects?.isNotEmpty ?? false) ||
                     _buildHelper.showParagraphRects) {
                   return AnimatedOpacity(
-                    opacity: _selections.main.isHidden ? 0.0 : 1.0,
-                    duration: _selections.main.animationDuration,
+                    opacity: (_selections.main?.isHidden ?? false) ? 0.0 : 1.0,
+                    duration:
+                        (_selections.main?.animationDuration ?? Duration.zero),
                     child: Stack(
                       children: [
                         // if (_selections.main.rects?.isNotEmpty ?? false)
@@ -416,8 +417,13 @@ class _SelectableState extends State<Selectable>
     if (!mounted) return;
     final pt = localPosition;
     // dmPrint('onLongPressOrDoubleTap at: $pt');
-    if (pt != null && !_selections.main.containsPoint(pt)) {
+    if (pt != null && !(_selections.main?.containsPoint(pt) ?? false)) {
       _refresh(() {
+        if (_selections.main == null) {
+          // Create the main selection object, if needed.
+          _selections[0] =
+              _selectionController?.getSelection() ?? const Selection();
+        }
         _buildHelper.showPopupMenu = widget.showPopup;
         _selections.dragInfo
           ..selectionPt = pt
@@ -431,15 +437,15 @@ class _SelectableState extends State<Selectable>
     if (!mounted) return;
     final pt = localPosition;
     // dmPrint('onTap at: $pt');
-    if (pt != null && _selections.main.isTextSelected) {
+    if (pt != null && (_selections.main?.isTextSelected ?? false)) {
       _refresh(() {
         if (_buildHelper.usingCupertinoControls &&
-            _selections.main.containsPoint(pt)) {
+            (_selections.main?.containsPoint(pt) ?? false)) {
           if (widget.showPopup) {
             _buildHelper.showPopupMenu = !_buildHelper.showPopupMenu;
           }
-        } else {
-          _selections[0] = _selections.main.cleared();
+        } else if (_selections.main != null) {
+          _selections[0] = _selections.main!.cleared();
         }
       });
     }

lib/src/selectable_build_helper.dart

@@ -82,7 +82,7 @@ class SelectableBuildHelper {
 
   /// Builds the selection handles and optionally the popup menu.
   List<Widget> buildSelectionControls(
-    Selection selection,
+    Selection? selection,
     BuildContext context,
     BoxConstraints constraints,
     SelectionDelegate selectionDelegate,
@@ -91,7 +91,7 @@ class SelectableBuildHelper {
     double topOverlayHeight,
   ) {
     // If there is no selection, return an empty list.
-    if (!selection.isTextSelected) return []; //---------------------------->
+    if (selection == null || !selection.isTextSelected) return []; //------->
 
     final leftLineHeight = selection.rects!.first.height;
     final rightLineHeight = selection.rects!.last.height;