FlutterTouchInterceptingView Class Reference

#include <FlutterPlatformViews_Internal.h>

Inheritance diagram for FlutterTouchInterceptingView:

Instance Methods
(instancetype)	- initWithEmbeddedView:platformViewsController:gestureRecognizersBlockingPolicy:
(void)	- releaseGesture
(void)	- blockGesture
(UIView *)	- embeddedView
(id)	- accessibilityContainer

Properties
id	flutterAccessibilityContainer
FlutterPlatformViewGestureRecognizersBlockingPolicy	blockingPolicy

Detailed Description

Definition at line 525 of file FlutterPlatformViews.mm.

Method Documentation

accessibilityContainer

- (id) accessibilityContainer

Provided by category FlutterTouchInterceptingView(Tests).

blockGesture

- (void) blockGesture

Definition at line 522 of file FlutterPlatformViews.mm.

                     {
  switch (_blockingPolicy) {
    case FlutterPlatformViewGestureRecognizersBlockingPolicyDoNotBlockGesture:
      // No-op. Handled by hit test.
      break;
    case FlutterPlatformViewGestureRecognizersBlockingPolicyEager:
      // We block all other gesture recognizers immediately in this policy.
      self.delayingRecognizer.state = UIGestureRecognizerStateEnded;
 
      // On iOS 18.2, WKWebView's internal recognizer likely caches the old state of its blocking
      // recognizers (i.e. delaying recognizer), resulting in non-tappable links. See
      // https://github.com/flutter/flutter/issues/158961. Removing and adding back the delaying
      // recognizer solves the problem, possibly because UIKit notifies all the recognizers related
      // to (blocking or blocked by) this recognizer. It is not possible to inject this workaround
      // from the web view plugin level. Right now we only observe this issue for
      // FlutterPlatformViewGestureRecognizersBlockingPolicyEager, but we should try it if a similar
      // issue arises for the other policy.
      if (@available(iOS 26.0, *)) {
        // This performs a nested DFS, with the outer one searching for any web view, and the inner
        // one searching for a TouchEventsGestureRecognizer inside the web view. Once found, disable
        // and immediately reenable it to reset its state.
        // TODO(hellohuanlin): remove this flag after it is battle tested.
        NSNumber* isWorkaroundDisabled =
            [[NSBundle mainBundle] objectForInfoDictionaryKey:@"FLTDisableWebViewGestureReset"];
        if (!isWorkaroundDisabled.boolValue) {
          [self searchAndFixWebView:self.embeddedView];
        }
      } else if (@available(iOS 18.2, *)) {
        // The 1P web view plugin provides a WKWebView itself as the platform view. However, some 3P
        // plugins provide wrappers of WKWebView instead, and AdMob banner has a WKWebView at
        // depth 7. So we perform DFS to search the view hierarchy.
        if ([self containsWebView:self.embeddedView]) {
          [self removeGestureRecognizer:self.delayingRecognizer];
          [self addGestureRecognizer:self.delayingRecognizer];
        }
      }
 
      break;
    case FlutterPlatformViewGestureRecognizersBlockingPolicyWaitUntilTouchesEnded:
      if (self.delayingRecognizer.touchedEndedWithoutBlocking) {
        // If touchesEnded of the `DelayingGesureRecognizer` has been already invoked,
        // we want to set the state of the `DelayingGesureRecognizer` to
        // `UIGestureRecognizerStateEnded` as soon as possible.
        self.delayingRecognizer.state = UIGestureRecognizerStateEnded;
      } else {
        // If touchesEnded of the `DelayingGesureRecognizer` has not been invoked,
        // We will set a flag to notify the `DelayingGesureRecognizer` to set the state to
        // `UIGestureRecognizerStateEnded` when touchesEnded is called.
        self.delayingRecognizer.shouldEndInNextTouchesEnded = YES;
      }
      break;
    default:
      break;
  }
}

embeddedView

- (UIView *) embeddedView

initWithEmbeddedView:platformViewsController:gestureRecognizersBlockingPolicy:

- (instancetype) initWithEmbeddedView:		(UIView*)	embeddedView
platformViewsController:		(FlutterPlatformViewsController*)	platformViewsController
gestureRecognizersBlockingPolicy:		(FlutterPlatformViewGestureRecognizersBlockingPolicy)	blockingPolicy

Definition at line 522 of file FlutterPlatformViews.mm.

                                    :(UIView*)embeddedView
             platformViewsController:(FlutterPlatformViewsController*)platformViewsController
    gestureRecognizersBlockingPolicy:
        (FlutterPlatformViewGestureRecognizersBlockingPolicy)blockingPolicy {
  self = [super initWithFrame:embeddedView.frame];
  if (self) {
    self.multipleTouchEnabled = YES;
    _embeddedView = embeddedView;
    _platformViewsController = platformViewsController;
    _flutterViewController = platformViewsController.flutterViewController;
    embeddedView.autoresizingMask =
        (UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight);
 
    [self addSubview:embeddedView];
 
    ForwardingGestureRecognizer* forwardingRecognizer =
        [[ForwardingGestureRecognizer alloc] initWithTarget:self
                                    platformViewsController:platformViewsController];
 
    _delayingRecognizer =
        [[FlutterDelayingGestureRecognizer alloc] initWithTarget:self
                                                          action:nil
                                            forwardingRecognizer:forwardingRecognizer];
    _blockingPolicy = blockingPolicy;
 
    // For hit test, don't block gestures using delaying recognizer. However, we still
    // forward touches so Flutter can process it in its gesture arena (e.g. dismiss a
    // drop-down menu when tapping outside of the menu but inside the platform view).
    if (blockingPolicy != FlutterPlatformViewGestureRecognizersBlockingPolicyDoNotBlockGesture) {
      [self addGestureRecognizer:_delayingRecognizer];
    }
    [self addGestureRecognizer:forwardingRecognizer];
  }
  return self;
}

releaseGesture

- (void) releaseGesture

Definition at line 522 of file FlutterPlatformViews.mm.

                       {
  self.delayingRecognizer.state = UIGestureRecognizerStateFailed;
}

Property Documentation

blockingPolicy

- (FlutterPlatformViewGestureRecognizersBlockingPolicy) blockingPolicy

readnonatomicassign

Definition at line 159 of file FlutterPlatformViews_Internal.h.

flutterAccessibilityContainer

- (id) flutterAccessibilityContainer

readwritenonatomicretain

Definition at line 158 of file FlutterPlatformViews_Internal.h.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/ios/framework/Source/FlutterPlatformViews.mm
• shell/platform/darwin/ios/framework/Source/FlutterPlatformViews_Internal.h