invoke method

  1. @override
void invoke(
  1. ScrollIntent intent, [
  2. BuildContext? context
])
override

Called when the action is to be performed.

This is called by the ActionDispatcher when an action is invoked via Actions.invoke, or when an action is invoked using ActionDispatcher.invokeAction directly.

This method is only meant to be invoked by an ActionDispatcher, or by its subclasses, and only when isEnabled is true.

The optional context parameter is the context of the invocation of the action, and in the case of an action invoked by a ShortcutManager, via a Shortcuts widget, will be the context of the Shortcuts widget.

When overriding this method, the returned value can be any Object, but changing the return type of the override to match the type of the returned value provides more type safety.

For instance, if an override of invoke returned an int, then it might be defined like so:

class IncrementIntent extends Intent {
  const IncrementIntent({required this.index});

  final int index;
}

class MyIncrementAction extends ContextAction<IncrementIntent> {
  @override
  int invoke(IncrementIntent intent, [BuildContext? context]) {
    return intent.index + 1;
  }
}

Implementation

@override
void invoke(ScrollIntent intent, [BuildContext? context]) {
  assert(context != null, 'Cannot scroll without a context.');
  ScrollableState? state = Scrollable.maybeOf(context!);
  if (state == null) {
    final ScrollController primaryScrollController = PrimaryScrollController.of(context);
    assert (() {
      if (primaryScrollController.positions.length != 1) {
        throw FlutterError.fromParts(<DiagnosticsNode>[
          ErrorSummary(
            'A ScrollAction was invoked with the PrimaryScrollController, but '
            'more than one ScrollPosition is attached.',
          ),
          ErrorDescription(
            'Only one ScrollPosition can be manipulated by a ScrollAction at '
            'a time.',
          ),
          ErrorHint(
            'The PrimaryScrollController can be inherited automatically by '
            'descendant ScrollViews based on the TargetPlatform and scroll '
            'direction. By default, the PrimaryScrollController is '
            'automatically inherited on mobile platforms for vertical '
            'ScrollViews. ScrollView.primary can also override this behavior.',
          ),
        ]);
      }
      return true;
    }());

    if (primaryScrollController.position.context.notificationContext == null
        && Scrollable.maybeOf(primaryScrollController.position.context.notificationContext!) == null) {
      return;
    }
    state = Scrollable.maybeOf(primaryScrollController.position.context.notificationContext!);
  }
  assert(state != null, '$ScrollAction was invoked on a context that has no scrollable parent');
  assert(state!.position.hasPixels, 'Scrollable must be laid out before it can be scrolled via a ScrollAction');

  // Don't do anything if the user isn't allowed to scroll.
  if (state!.resolvedPhysics != null && !state.resolvedPhysics!.shouldAcceptUserOffset(state.position)) {
    return;
  }
  final double increment = getDirectionalIncrement(state, intent);
  if (increment == 0.0) {
    return;
  }
  state.position.moveTo(
    state.position.pixels + increment,
    duration: const Duration(milliseconds: 100),
    curve: Curves.easeInOut,
  );
}