io.flutter.embedding.engine.plugins.shim.ShimRegistrar Class Reference

Inheritance diagram for io.flutter.embedding.engine.plugins.shim.ShimRegistrar:

Public Member Functions
	ShimRegistrar (@NonNull String pluginId, @NonNull Map< String, Object > globalRegistrarMap)
Activity	activity ()
Context	context ()
Context	activeContext ()
BinaryMessenger	messenger ()
TextureRegistry	textures ()
PlatformViewRegistry	platformViewRegistry ()
FlutterView	view ()
String	lookupKeyForAsset (String asset)
String	lookupKeyForAsset (String asset, String packageName)
PluginRegistry.Registrar	publish (Object value)
PluginRegistry.Registrar	addRequestPermissionsResultListener (PluginRegistry.RequestPermissionsResultListener listener)
PluginRegistry.Registrar	addActivityResultListener (PluginRegistry.ActivityResultListener listener)
PluginRegistry.Registrar	addNewIntentListener (PluginRegistry.NewIntentListener listener)
PluginRegistry.Registrar	addUserLeaveHintListener (PluginRegistry.UserLeaveHintListener listener)
PluginRegistry.Registrar	addWindowFocusChangedListener (PluginRegistry.WindowFocusChangedListener listener)
PluginRegistry.Registrar	addViewDestroyListener ( @NonNull PluginRegistry.ViewDestroyListener listener)
void	onAttachedToEngine (@NonNull FlutterPluginBinding binding)
void	onDetachedFromEngine (@NonNull FlutterPluginBinding binding)
void	onAttachedToActivity (@NonNull ActivityPluginBinding binding)
void	onDetachedFromActivityForConfigChanges ()
void	onReattachedToActivityForConfigChanges (@NonNull ActivityPluginBinding binding)
void	onDetachedFromActivity ()

Detailed Description

A PluginRegistry.Registrar that is shimmed let old plugins use the new Android embedding and plugin API behind the scenes.

Instances of ShimRegistrars are vended internally by a ShimPluginRegistry.

Definition at line 30 of file ShimRegistrar.java.

Constructor & Destructor Documentation

ShimRegistrar()

io.flutter.embedding.engine.plugins.shim.ShimRegistrar.ShimRegistrar ( @NonNull String  pluginId, @NonNull Map< String, Object >  globalRegistrarMap  )

inline

Definition at line 47 of file ShimRegistrar.java.

                                                                                                  {
    this.pluginId = pluginId;
    this.globalRegistrarMap = globalRegistrarMap;
  }

Member Function Documentation

activeContext()

Context io.flutter.embedding.engine.plugins.shim.ShimRegistrar.activeContext ( )

inline

Definition at line 63 of file ShimRegistrar.java.

                                 {
    return activityPluginBinding == null ? context() : activity();
  }

activity()

Activity io.flutter.embedding.engine.plugins.shim.ShimRegistrar.activity ( )

inline

Definition at line 53 of file ShimRegistrar.java.

                             {
    return activityPluginBinding != null ? activityPluginBinding.getActivity() : null;
  }

addActivityResultListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addActivityResultListener ( PluginRegistry.ActivityResultListener  listener )

inline

Definition at line 117 of file ShimRegistrar.java.

                                                      {
    activityResultListeners.add(listener);
 
    if (activityPluginBinding != null) {
      activityPluginBinding.addActivityResultListener(listener);
    }
 
    return this;
  }

addNewIntentListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addNewIntentListener ( PluginRegistry.NewIntentListener  listener )

inline

Definition at line 129 of file ShimRegistrar.java.

                                                                                                  {
    newIntentListeners.add(listener);
 
    if (activityPluginBinding != null) {
      activityPluginBinding.addOnNewIntentListener(listener);
    }
 
    return this;
  }

addRequestPermissionsResultListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addRequestPermissionsResultListener ( PluginRegistry.RequestPermissionsResultListener  listener )

inline

Definition at line 105 of file ShimRegistrar.java.

                                                                {
    requestPermissionsResultListeners.add(listener);
 
    if (activityPluginBinding != null) {
      activityPluginBinding.addRequestPermissionsResultListener(listener);
    }
 
    return this;
  }

addUserLeaveHintListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addUserLeaveHintListener ( PluginRegistry.UserLeaveHintListener  listener )

inline

Definition at line 140 of file ShimRegistrar.java.

                                                     {
    userLeaveHintListeners.add(listener);
 
    if (activityPluginBinding != null) {
      activityPluginBinding.addOnUserLeaveHintListener(listener);
    }
 
    return this;
  }

addViewDestroyListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addViewDestroyListener ( @NonNull PluginRegistry.ViewDestroyListener  listener )

inline

Definition at line 165 of file ShimRegistrar.java.

                                                            {
    viewDestroyListeners.add(listener);
    return this;
  }

addWindowFocusChangedListener()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.addWindowFocusChangedListener ( PluginRegistry.WindowFocusChangedListener  listener )

inline

Definition at line 152 of file ShimRegistrar.java.

                                                          {
    WindowFocusChangedListeners.add(listener);
 
    if (activityPluginBinding != null) {
      activityPluginBinding.addOnWindowFocusChangedListener(listener);
    }
 
    return this;
  }

context()

Context io.flutter.embedding.engine.plugins.shim.ShimRegistrar.context ( )

inline

Definition at line 58 of file ShimRegistrar.java.

                           {
    return pluginBinding != null ? pluginBinding.getApplicationContext() : null;
  }

lookupKeyForAsset() [1/2]

String io.flutter.embedding.engine.plugins.shim.ShimRegistrar.lookupKeyForAsset ( String  asset )

inline

Definition at line 89 of file ShimRegistrar.java.

                                                {
    return FlutterInjector.instance().flutterLoader().getLookupKeyForAsset(asset);
  }

lookupKeyForAsset() [2/2]

String io.flutter.embedding.engine.plugins.shim.ShimRegistrar.lookupKeyForAsset ( String  asset, String  packageName  )

inline

Definition at line 94 of file ShimRegistrar.java.

                                                                    {
    return FlutterInjector.instance().flutterLoader().getLookupKeyForAsset(asset, packageName);
  }

messenger()

BinaryMessenger io.flutter.embedding.engine.plugins.shim.ShimRegistrar.messenger ( )

inline

Definition at line 68 of file ShimRegistrar.java.

                                     {
    return pluginBinding != null ? pluginBinding.getBinaryMessenger() : null;
  }

onAttachedToActivity()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onAttachedToActivity ( @NonNull ActivityPluginBinding  binding )

inline

Definition at line 191 of file ShimRegistrar.java.

                                                                           {
    Log.v(TAG, "Attached to an Activity.");
    activityPluginBinding = binding;
    addExistingListenersToActivityPluginBinding();
  }

onAttachedToEngine()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onAttachedToEngine ( @NonNull FlutterPluginBinding  binding )

inline

This FlutterPlugin has been associated with a io.flutter.embedding.engine.FlutterEngine instance.

Relevant resources that this FlutterPlugin may need are provided via the
binding. The binding may be cached and referenced until onDetachedFromEngine(FlutterPluginBinding) is invoked and returns.

Implements io.flutter.embedding.engine.plugins.FlutterPlugin.

Definition at line 172 of file ShimRegistrar.java.

                                                                        {
    Log.v(TAG, "Attached to FlutterEngine.");
    pluginBinding = binding;
  }

onDetachedFromActivity()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onDetachedFromActivity ( )

inline

Definition at line 211 of file ShimRegistrar.java.

                                       {
    Log.v(TAG, "Detached from an Activity.");
    activityPluginBinding = null;
  }

onDetachedFromActivityForConfigChanges()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onDetachedFromActivityForConfigChanges ( )

inline

Definition at line 198 of file ShimRegistrar.java.

                                                       {
    Log.v(TAG, "Detached from an Activity for config changes.");
    activityPluginBinding = null;
  }

onDetachedFromEngine()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onDetachedFromEngine ( @NonNull FlutterPluginBinding  binding )

inline

This FlutterPlugin has been removed from a io.flutter.embedding.engine.FlutterEngine instance.

The binding passed to this method is the same instance that was passed in onAttachedToEngine(FlutterPluginBinding). It is provided again in this method as a convenience. The binding may be referenced during the execution of this method, but it must not be cached or referenced after this method returns.

FlutterPlugins should release all resources in this method.

Implements io.flutter.embedding.engine.plugins.FlutterPlugin.

Definition at line 178 of file ShimRegistrar.java.

                                                                          {
    Log.v(TAG, "Detached from FlutterEngine.");
    for (PluginRegistry.ViewDestroyListener listener : viewDestroyListeners) {
      // The following invocation might produce unexpected behavior in old plugins because
      // we have no FlutterNativeView to pass to onViewDestroy(). This is a limitation of this shim.
      listener.onViewDestroy(null);
    }
 
    pluginBinding = null;
    activityPluginBinding = null;
  }

onReattachedToActivityForConfigChanges()

void io.flutter.embedding.engine.plugins.shim.ShimRegistrar.onReattachedToActivityForConfigChanges ( @NonNull ActivityPluginBinding  binding )

inline

Definition at line 204 of file ShimRegistrar.java.

                                                                                             {
    Log.v(TAG, "Reconnected to an Activity after config changes.");
    activityPluginBinding = binding;
    addExistingListenersToActivityPluginBinding();
  }

platformViewRegistry()

PlatformViewRegistry io.flutter.embedding.engine.plugins.shim.ShimRegistrar.platformViewRegistry ( )

inline

Definition at line 78 of file ShimRegistrar.java.

                                                     {
    return pluginBinding != null ? pluginBinding.getPlatformViewRegistry() : null;
  }

publish()

PluginRegistry.Registrar io.flutter.embedding.engine.plugins.shim.ShimRegistrar.publish ( Object  value )

inline

Definition at line 99 of file ShimRegistrar.java.

                                                        {
    globalRegistrarMap.put(pluginId, value);
    return this;
  }

textures()

TextureRegistry io.flutter.embedding.engine.plugins.shim.ShimRegistrar.textures ( )

inline

Definition at line 73 of file ShimRegistrar.java.

                                    {
    return pluginBinding != null ? pluginBinding.getTextureRegistry() : null;
  }

view()

FlutterView io.flutter.embedding.engine.plugins.shim.ShimRegistrar.view ( )

inline

Definition at line 83 of file ShimRegistrar.java.

                            {
    throw new UnsupportedOperationException(
        "The new embedding does not support the old FlutterView.");
  }

---

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

• shell/platform/android/io/flutter/embedding/engine/plugins/shim/ShimRegistrar.java