expandTo method Null safety

TextSelection expandTo(
  1. TextPosition position,
  2. [bool extentAtIndex = false]
)

Returns the smallest TextSelection that this could expand to in order to include the given TextPosition.

If the given TextPosition is already inside of the selection, then returns this without change.

The returned selection will always be a strict superset of the current selection. In other words, the selection grows to include the given TextPosition.

If extentAtIndex is true, then the TextSelection.extentOffset will be placed at the given index regardless of the original order of it and TextSelection.baseOffset. Otherwise, their order will be preserved.

Difference with extendTo

In contrast with this method, extendTo is a pivot; it holds TextSelection.baseOffset fixed while moving TextSelection.extentOffset to the given TextPosition. It doesn't strictly grow the selection and may collapse it or flip its order.

Implementation

TextSelection expandTo(TextPosition position, [bool extentAtIndex = false]) {
  // If position is already within in the selection, there's nothing to do.
  if (position.offset >= start && position.offset <= end) {
    return this;
  }

  final bool normalized = baseOffset <= extentOffset;
  if (position.offset <= start) {
    // Here the position is somewhere before the selection: ..|..[...]....
    if (extentAtIndex) {
      return copyWith(
        baseOffset: end,
        extentOffset: position.offset,
        affinity: position.affinity,
      );
    }
    return copyWith(
      baseOffset: normalized ? position.offset : baseOffset,
      extentOffset: normalized ? extentOffset : position.offset,
    );
  }
  // Here the position is somewhere after the selection: ....[...]..|..
  if (extentAtIndex) {
    return copyWith(
      baseOffset: start,
      extentOffset: position.offset,
      affinity: position.affinity,
    );
  }
  return copyWith(
    baseOffset: normalized ? baseOffset : position.offset,
    extentOffset: normalized ? position.offset : extentOffset,
  );
}