Inheritance diagram for io.flutter.plugin.text.ProcessTextPlugin:

Public Member Functions
	ProcessTextPlugin (@NonNull ProcessTextChannel processTextChannel)

Map< String, String >	queryTextActions ()

void	processTextAction ( @NonNull String id, @NonNull String text, @NonNull boolean readOnly, @NonNull MethodChannel.Result result)

boolean	onActivityResult (int requestCode, int resultCode, @Nullable Intent intent)

void	destroy ()

void	onAttachedToEngine (@NonNull FlutterPluginBinding binding)

void	onDetachedFromEngine (@NonNull FlutterPluginBinding binding)

void	onAttachedToActivity (@NonNull ActivityPluginBinding binding)

void	onDetachedFromActivityForConfigChanges ()

void	onReattachedToActivityForConfigChanges (@NonNull ActivityPluginBinding binding)

void	onDetachedFromActivity ()

void	onAttachedToEngine (@NonNull FlutterPluginBinding binding)

void	onDetachedFromEngine (@NonNull FlutterPluginBinding binding)

void	onAttachedToActivity (@NonNull ActivityPluginBinding binding)

void	onDetachedFromActivityForConfigChanges ()

void	onReattachedToActivityForConfigChanges (@NonNull ActivityPluginBinding binding)

void	onDetachedFromActivity ()

boolean	onActivityResult (int requestCode, int resultCode, @Nullable Intent data)

Map< String, String >	queryTextActions ()

void	processTextAction ( @NonNull String id, @NonNull String input, @NonNull boolean readOnly, @NonNull MethodChannel.Result result)

Detailed Description

Definition at line 28 of file ProcessTextPlugin.java.

Constructor & Destructor Documentation

◆ ProcessTextPlugin()

io.flutter.plugin.text.ProcessTextPlugin.ProcessTextPlugin ( @NonNull ProcessTextChannel processTextChannel )

inline

Definition at line 44 of file ProcessTextPlugin.java.

                                                                           {
    this.processTextChannel = processTextChannel;
    this.packageManager = processTextChannel.packageManager;
 
    processTextChannel.setMethodHandler(this);
  }

Member Function Documentation

◆ destroy()

void io.flutter.plugin.text.ProcessTextPlugin.destroy ( )

inline

Unregisters this ProcessTextPlugin as the ProcessTextChannel.ProcessTextMethodHandler, for the io.flutter.embedding.engine.systemchannels.ProcessTextChannel.

Do not invoke any methods on a ProcessTextPlugin after invoking this method.

Definition at line 162 of file ProcessTextPlugin.java.

                        {
    processTextChannel.setMethodHandler(null);
  }

◆ onActivityResult()

boolean io.flutter.plugin.text.ProcessTextPlugin.onActivityResult	(	int	requestCode,
		int	resultCode,
		@Nullable Intent	intent
	)

inline

Executed when a text processing activity terminates.

When an activity returns a value, the request is completed successfully and returns the processed text.

When an activity does not return a value. the request is completed successfully and returns null.

Implements io.flutter.plugin.common.PluginRegistry.ActivityResultListener.

Definition at line 141 of file ProcessTextPlugin.java.

                                                                                            {
    // Return early if the result is not related to a request sent by this plugin.
    if (!requestsByCode.containsKey(requestCode)) {
      return false;
    }
 
    String result = null;
    if (resultCode == Activity.RESULT_OK) {
      result = intent.getStringExtra(Intent.EXTRA_PROCESS_TEXT);
    }
    requestsByCode.remove(requestCode).success(result);
    return true;
  }

◆ onAttachedToActivity()

void io.flutter.plugin.text.ProcessTextPlugin.onAttachedToActivity ( @NonNull ActivityPluginBinding binding )

inline

This ActivityAware io.flutter.embedding.engine.plugins.FlutterPlugin is now associated with an android.app.Activity.

This method can be invoked in 1 of 2 situations:

This ActivityAware io.flutter.embedding.engine.plugins.FlutterPlugin was just added to a io.flutter.embedding.engine.FlutterEngine that was already connected to a running android.app.Activity.
This ActivityAware io.flutter.embedding.engine.plugins.FlutterPlugin was already added to a io.flutter.embedding.engine.FlutterEngine and that io.flutter.embedding.engine.FlutterEngine was just connected to an android.app.Activity.

The given ActivityPluginBinding contains android.app.Activity-related references that an ActivityAware io.flutter.embedding.engine.plugins.FlutterPlugin may require, such as a reference to the actual android.app.Activity in question. The ActivityPluginBinding may be referenced until either onDetachedFromActivityForConfigChanges() or onDetachedFromActivity() is invoked. At the conclusion of either of those methods, the binding is no longer valid. Clear any references to the binding or its resources, and do not invoke any further methods on the binding or its resources.

Implements io.flutter.embedding.engine.plugins.activity.ActivityAware.

Definition at line 180 of file ProcessTextPlugin.java.

                                                                           {
    this.activityBinding = binding;
    this.activityBinding.addActivityResultListener(this);
  };

◆ onAttachedToEngine()

void io.flutter.plugin.text.ProcessTextPlugin.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 168 of file ProcessTextPlugin.java.

                                                                        {
    // Nothing to do because this plugin is instantiated by the engine.
  }

◆ onDetachedFromActivity()

void io.flutter.plugin.text.ProcessTextPlugin.onDetachedFromActivity ( )

inline

This plugin has been detached from an android.app.Activity.

Detachment can occur for a number of reasons.

The app is no longer visible and the android.app.Activity instance has been destroyed.
The io.flutter.embedding.engine.FlutterEngine that this plugin is connected to has been detached from its io.flutter.embedding.android.FlutterView.
This ActivityAware plugin has been removed from its io.flutter.embedding.engine.FlutterEngine.

By the end of this method, the android.app.Activity that was made available in onAttachedToActivity(ActivityPluginBinding) is no longer valid. Any references to the associated android.app.Activity or ActivityPluginBinding should be cleared.

Any Lifecycle listeners that were registered in onAttachedToActivity(ActivityPluginBinding) or onReattachedToActivityForConfigChanges(ActivityPluginBinding) should be deregistered here to avoid a possible memory leak and other side effects.

Implements io.flutter.embedding.engine.plugins.activity.ActivityAware.

Definition at line 195 of file ProcessTextPlugin.java.

                                       {
    this.activityBinding.removeActivityResultListener(this);
    this.activityBinding = null;
  }

◆ onDetachedFromActivityForConfigChanges()

void io.flutter.plugin.text.ProcessTextPlugin.onDetachedFromActivityForConfigChanges ( )

inline

The android.app.Activity that was attached and made available in onAttachedToActivity(ActivityPluginBinding) has been detached from this ActivityAware's io.flutter.embedding.engine.FlutterEngine for the purpose of processing a configuration change.

By the end of this method, the android.app.Activity that was made available in onAttachedToActivity(ActivityPluginBinding) is no longer valid. Any references to the associated android.app.Activity or ActivityPluginBinding should be cleared.

This method should be quickly followed by onReattachedToActivityForConfigChanges(ActivityPluginBinding), which signifies that a new android.app.Activity has been created with the new configuration options. That method provides a new ActivityPluginBinding, which references the newly created and associated android.app.Activity.

Any Lifecycle listeners that were registered in onAttachedToActivity(ActivityPluginBinding) should be deregistered here to avoid a possible memory leak and other side effects.

Implements io.flutter.embedding.engine.plugins.activity.ActivityAware.

Definition at line 185 of file ProcessTextPlugin.java.

                                                       {
    this.activityBinding.removeActivityResultListener(this);
    this.activityBinding = null;
  }

◆ onDetachedFromEngine()

void io.flutter.plugin.text.ProcessTextPlugin.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 172 of file ProcessTextPlugin.java.

                                                                          {
    // Nothing to do because this plugin is instantiated by the engine.
  }

◆ onReattachedToActivityForConfigChanges()

void io.flutter.plugin.text.ProcessTextPlugin.onReattachedToActivityForConfigChanges ( @NonNull ActivityPluginBinding binding )

inline

This plugin and its io.flutter.embedding.engine.FlutterEngine have been re-attached to an android.app.Activity after the android.app.Activity was recreated to handle configuration changes.

binding includes a reference to the new instance of the android.app.Activity. binding and its references may be cached and used from now until either onDetachedFromActivityForConfigChanges() or onDetachedFromActivity() is invoked. At the conclusion of either of those methods, the binding is no longer valid. Clear any references to the binding or its resources, and do not invoke any further methods on the binding or its resources.

Implements io.flutter.embedding.engine.plugins.activity.ActivityAware.

Definition at line 190 of file ProcessTextPlugin.java.

                                                                                             {
    this.activityBinding = binding;
    this.activityBinding.addActivityResultListener(this);
  }

◆ processTextAction()

void io.flutter.plugin.text.ProcessTextPlugin.processTextAction	(	@NonNull String	id,
		@NonNull String	input,
		@NonNull boolean	readOnly,
		@NonNull MethodChannel.Result	result
	)

inline

Requests to run a text action on a given input text.

Parameters

id	The ID of the text action returned by `ProcessText.queryTextActions`.
input	The text to be processed.
readOnly	Indicates to the activity if the processed text will be used as read-only. see https://developer.android.com/reference/android/content/Intent#EXTRA_PROCESS_TEXT_READONLY
result	The method channel result instance used to reply.

Implements io.flutter.embedding.engine.systemchannels.ProcessTextChannel.ProcessTextMethodHandler.

Definition at line 65 of file ProcessTextPlugin.java.

                                            {
    if (activityBinding == null) {
      result.error("error", "Plugin not bound to an Activity", null);
      return;
    }
 
    if (Build.VERSION.SDK_INT < API_LEVELS.API_23) {
      result.error("error", "Android version not supported", null);
      return;
    }
 
    if (resolveInfosById == null) {
      result.error("error", "Can not process text actions before calling queryTextActions", null);
      return;
    }
 
    final ResolveInfo info = resolveInfosById.get(id);
    if (info == null) {
      result.error("error", "Text processing activity not found", null);
      return;
    }
 
    Integer requestCode = result.hashCode();
    requestsByCode.put(requestCode, result);
 
    Intent intent = new Intent();
    intent.setClassName(info.activityInfo.packageName, info.activityInfo.name);
    intent.setAction(Intent.ACTION_PROCESS_TEXT);
    intent.setType("text/plain");
    intent.putExtra(Intent.EXTRA_PROCESS_TEXT, text);
    intent.putExtra(Intent.EXTRA_PROCESS_TEXT_READONLY, readOnly);
 
    // Start the text processing activity. When the activity completes, the onActivityResult
    // callback
    // is called.
    activityBinding.getActivity().startActivityForResult(intent, requestCode);
  }

◆ queryTextActions()

Map< String, String > io.flutter.plugin.text.ProcessTextPlugin.queryTextActions ( )

inline

Requests the map of text actions. Each text action has a unique id and a localized label.

Implements io.flutter.embedding.engine.systemchannels.ProcessTextChannel.ProcessTextMethodHandler.

Definition at line 52 of file ProcessTextPlugin.java.

                                                {
    if (resolveInfosById == null) {
      cacheResolveInfos();
    }
    Map<String, String> result = new HashMap<String, String>();
    for (String id : resolveInfosById.keySet()) {
      final ResolveInfo info = resolveInfosById.get(id);
      result.put(id, info.loadLabel(packageManager).toString());
    }
    return result;
  }

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

shell/platform/android/io/flutter/plugin/text/ProcessTextPlugin.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ProcessTextPlugin()

Member Function Documentation

◆ destroy()

◆ onActivityResult()

◆ onAttachedToActivity()

◆ onAttachedToEngine()

◆ onDetachedFromActivity()

◆ onDetachedFromActivityForConfigChanges()

◆ onDetachedFromEngine()

◆ onReattachedToActivityForConfigChanges()

◆ processTextAction()

◆ queryTextActions()