FlutterPlatformViewController Class Reference

#import <FlutterPlatformViewController.h>

Inheritance diagram for FlutterPlatformViewController:

Instance Methods
(instancetype)	- init [implementation]
(void)	- onCreateWithViewIdentifier:viewType:arguments:result: [implementation]
(void)	- onDisposeWithViewID:result: [implementation]
(void)	- registerViewFactory:withId: [implementation]
(nullable NSView *)	- platformViewWithID: [implementation]
(void)	- handleMethodCall:result: [implementation]
(void)	- handleAcceptGesture:result: [implementation]
(void)	- handleRejectGesture:result: [implementation]
(void)	- disposePlatformViews [implementation]

Detailed Description

Definition at line 17 of file FlutterPlatformViewController.h.

Method Documentation

disposePlatformViews

- (void) disposePlatformViews

implementation

Removes platform views slated to be disposed via method handler calls.

Definition at line 17 of file FlutterPlatformViewController.mm.

                             {
  if (_platformViewsToDispose.empty()) {
    return;
  }
 
  FML_DCHECK([[NSThread currentThread] isMainThread])
      << "Must be on the main thread to handle disposing platform views";
  for (int64_t viewId : _platformViewsToDispose) {
    NSView* view = _platformViews[viewId];
    [view removeFromSuperview];
    _platformViews.erase(viewId);
  }
  _platformViewsToDispose.clear();
}

handleAcceptGesture:result:

- (void) handleAcceptGesture: (FlutterMethodCall*)  call result: (FlutterResult)  result

implementation

Definition at line 17 of file FlutterPlatformViewController.mm.

                           :(FlutterMethodCall*)call result:(FlutterResult)result {
  NSDictionary<NSString*, id>* args = [call arguments];
  NSAssert(args && args[@"id"], @"id argument is required");
  int64_t viewId = [args[@"id"] longLongValue];
  if (_platformViews.count(viewId) == 0) {
    result([FlutterError errorWithCode:@"unknown_view"
                               message:@"trying to set gesture state for an unknown view"
                               details:[NSString stringWithFormat:@"view id: '%lld'", viewId]]);
    return;
  }
 
  // TODO(cbracken): Implement. https://github.com/flutter/flutter/issues/124492
  result(nil);
}

handleMethodCall:result:

- (void) handleMethodCall: (nonnull FlutterMethodCall *)  call result: (nonnull FlutterResult)  result

implementation

Handles platform view related method calls, for example create, dispose, etc.

Definition at line 17 of file FlutterPlatformViewController.mm.

                        :(nonnull FlutterMethodCall*)call result:(nonnull FlutterResult)result {
  if ([[call method] isEqualToString:@"create"]) {
    NSMutableDictionary<NSString*, id>* args = [call arguments];
    if ([args objectForKey:@"id"]) {
      int64_t viewId = [args[@"id"] longLongValue];
      NSString* viewType = [NSString stringWithUTF8String:([args[@"viewType"] UTF8String])];
 
      id creationArgs = nil;
      NSObject<FlutterPlatformViewFactory>* factory = _platformViewFactories[viewType];
      if ([factory respondsToSelector:@selector(createArgsCodec)]) {
        NSObject<FlutterMessageCodec>* codec = [factory createArgsCodec];
        if (codec != nil && args[@"params"] != nil) {
          FlutterStandardTypedData* creationArgsData = args[@"params"];
          creationArgs = [codec decode:creationArgsData.data];
        }
      }
      [self onCreateWithViewIdentifier:viewId
                              viewType:viewType
                             arguments:creationArgs
                                result:result];
    } else {
      result([FlutterError errorWithCode:@"unknown_view"
                                 message:@"'id' argument must be passed to create a platform view."
                                 details:[NSString stringWithFormat:@"'id' not specified."]]);
    }
  } else if ([[call method] isEqualToString:@"dispose"]) {
    NSNumber* arg = [call arguments];
    int64_t viewId = [arg longLongValue];
    [self onDisposeWithViewID:viewId result:result];
  } else if ([[call method] isEqualToString:@"acceptGesture"]) {
    [self handleAcceptGesture:call result:result];
  } else if ([[call method] isEqualToString:@"rejectGesture"]) {
    [self handleRejectGesture:call result:result];
  } else {
    result(FlutterMethodNotImplemented);
  }
}

handleRejectGesture:result:

- (void) handleRejectGesture: (FlutterMethodCall*)  call result: (FlutterResult)  result

implementation

Definition at line 17 of file FlutterPlatformViewController.mm.

                           :(FlutterMethodCall*)call result:(FlutterResult)result {
  NSDictionary<NSString*, id>* args = [call arguments];
  NSAssert(args && args[@"id"], @"id argument is required");
  int64_t viewId = [args[@"id"] longLongValue];
  if (_platformViews.count(viewId) == 0) {
    result([FlutterError errorWithCode:@"unknown_view"
                               message:@"trying to set gesture state for an unknown view"
                               details:[NSString stringWithFormat:@"view id: '%lld'", viewId]]);
    return;
  }
 
  // TODO(cbracken): Implement. https://github.com/flutter/flutter/issues/124492
  result(nil);
}

init

- (instancetype) init

implementation

Definition at line 17 of file FlutterPlatformViewController.mm.

                     {
  self = [super init];
  if (self) {
    _platformViewFactories = [[NSMutableDictionary alloc] init];
  }
  return self;
}

onCreateWithViewIdentifier:viewType:arguments:result:

- (void) onCreateWithViewIdentifier: (int64_t)  viewId viewType: (nonnull NSString *)  viewType arguments: (nullable id)  args result: (nonnull FlutterResult)  result

implementation

Creates a platform view of viewType with viewId and arguments passed from the framework's creationParams constructor parameter. FlutterResult is updated to contain nil for success or to contain a FlutterError if there is an error.

Definition at line 17 of file FlutterPlatformViewController.mm.

                                  :(int64_t)viewId
                          viewType:(nonnull NSString*)viewType
                         arguments:(nullable id)args
                            result:(nonnull FlutterResult)result {
  if (_platformViews.count(viewId) != 0) {
    result([FlutterError errorWithCode:@"recreating_view"
                               message:@"trying to create an already created view"
                               details:[NSString stringWithFormat:@"view id: '%lld'", viewId]]);
    return;
  }
 
  NSObject<FlutterPlatformViewFactory>* factory = _platformViewFactories[viewType];
  if (!factory) {
    result([FlutterError
        errorWithCode:@"unregistered_view_type"
              message:[NSString stringWithFormat:@"A UIKitView widget is trying to create a "
                                                 @"PlatformView with an unregistered type: < %@ >",
                                                 viewType]
              details:@"If you are the author of the PlatformView, make sure `registerViewFactory` "
                      @"is invoked.\n"
                      @"See: "
                      @"https://docs.flutter.dev/development/platform-integration/"
                      @"platform-views#on-the-platform-side-1 for more details.\n"
                      @"If you are not the author of the PlatformView, make sure to call "
                      @"`GeneratedPluginRegistrant.register`."]);
    return;
  }
 
  NSView* platform_view = [factory createWithViewIdentifier:viewId arguments:args];
  // Flutter compositing requires CALayer-backed platform views.
  // Force the platform view to be backed by a CALayer.
  [platform_view setWantsLayer:YES];
  _platformViews[viewId] = platform_view;
  result(nil);
}

onDisposeWithViewID:result:

- (void) onDisposeWithViewID: (int64_t)  viewId result: (nonnull FlutterResult)  result

implementation

Disposes the platform view with viewId. FlutterResult is updated to contain nil for success or a FlutterError if there is an error.

Definition at line 17 of file FlutterPlatformViewController.mm.

                           :(int64_t)viewId result:(nonnull FlutterResult)result {
  if (_platformViews.count(viewId) == 0) {
    result([FlutterError errorWithCode:@"unknown_view"
                               message:@"trying to dispose an unknown"
                               details:[NSString stringWithFormat:@"view id: '%lld'", viewId]]);
    return;
  }
 
  // The following disposePlatformViews call will dispose the views.
  _platformViewsToDispose.insert(viewId);
  result(nil);
}

platformViewWithID:

- (nullable NSView *) platformViewWithID: (int64_t)  viewId

implementation

Returns the platform view associated with the viewId.

Definition at line 17 of file FlutterPlatformViewController.mm.

                                      :(int64_t)viewId {
  if (_platformViews.count(viewId)) {
    return _platformViews[viewId];
  } else {
    return nil;
  }
}

registerViewFactory:withId:

- (void) registerViewFactory: (nonnull NSObject< FlutterPlatformViewFactory > *)  factory withId: (nonnull NSString *)  factoryId

implementation

Register a view factory by adding an entry into the platformViewFactories map with key factoryId and value factory.

Definition at line 17 of file FlutterPlatformViewController.mm.

                           :(nonnull NSObject<FlutterPlatformViewFactory>*)factory
                     withId:(nonnull NSString*)factoryId {
  _platformViewFactories[factoryId] = factory;
}

---

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

• shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController.h
• shell/platform/darwin/macos/framework/Source/FlutterPlatformViewController.mm