io.flutter.embedding.engine.systemchannels.SpellCheckChannel Class Reference

Classes
interface	SpellCheckMethodHandler

Public Member Functions
	SpellCheckChannel (@NonNull DartExecutor dartExecutor)
void	setSpellCheckMethodHandler ( @Nullable SpellCheckMethodHandler spellCheckMethodHandler)

Public Attributes
final MethodChannel	channel
final MethodChannel.MethodCallHandler	parsingMethodHandler

Detailed Description

SpellCheckChannel is a platform channel that is used by the framework to initiate spell check in the embedding and for the embedding to send back the results.

When there is new text to be spell checked, the framework will send to the embedding the message SpellCheck.initiateSpellCheck with the String locale to spell check with and the String of text to spell check as arguments. In response, the io.flutter.plugin.editing.SpellCheckPlugin will make a call to Android's spell check service to fetch spell check results for the specified text.

Once the spell check results are received by the io.flutter.plugin.editing.SpellCheckPlugin, it will send back to the framework the
ArrayList<HashMap<String,Object>> of spell check results (see io.flutter.plugin.editing.SpellCheckPlugin#onGetSentenceSuggestions for details). The io.flutter.plugin.editing.SpellCheckPlugin only handles one request to fetch spell check results at a time; see io.flutter.plugin.editing.SpellCheckPlugin#initiateSpellCheck for details.

io.flutter.plugin.editing.SpellCheckPlugin implements SpellCheckMethodHandler to initiate spell check. Implement SpellCheckMethodHandler to respond to spell check requests.

Definition at line 37 of file SpellCheckChannel.java.

Constructor & Destructor Documentation

SpellCheckChannel()

io.flutter.embedding.engine.systemchannels.SpellCheckChannel.SpellCheckChannel ( @NonNull DartExecutor  dartExecutor )

inline

Definition at line 75 of file SpellCheckChannel.java.

                                                               {
    channel = new MethodChannel(dartExecutor, "flutter/spellcheck", StandardMethodCodec.INSTANCE);
    channel.setMethodCallHandler(parsingMethodHandler);
  }

Member Function Documentation

setSpellCheckMethodHandler()

void io.flutter.embedding.engine.systemchannels.SpellCheckChannel.setSpellCheckMethodHandler ( @Nullable SpellCheckMethodHandler  spellCheckMethodHandler )

inline

Sets the SpellCheckMethodHandler which receives all requests to spell check the specified text sent through this channel.

Definition at line 84 of file SpellCheckChannel.java.

                                                                 {
    this.spellCheckMethodHandler = spellCheckMethodHandler;
  }

Member Data Documentation

channel

final MethodChannel io.flutter.embedding.engine.systemchannels.SpellCheckChannel.channel

Definition at line 40 of file SpellCheckChannel.java.

parsingMethodHandler

final MethodChannel.MethodCallHandler io.flutter.embedding.engine.systemchannels.SpellCheckChannel.parsingMethodHandler

Initial value:

=
      new MethodChannel.MethodCallHandler() {
        @Override
        public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
          if (spellCheckMethodHandler == null) {
            Log.v(
                TAG,
                "No SpellCheckeMethodHandler registered, call not forwarded to spell check API.");
            return;
          }
          String method = call.method;
          Object args = call.arguments;
          Log.v(TAG, "Received '" + method + "' message.");
          switch (method) {
            case "SpellCheck.initiateSpellCheck":
              try {
                final ArrayList<String> argumentList = (ArrayList<String>) args;
                String locale = argumentList.get(0);
                String text = argumentList.get(1);
                spellCheckMethodHandler.initiateSpellCheck(locale, text, result);
              } catch (IllegalStateException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            default:
              result.notImplemented();
              break;
          }
        }
      }

Definition at line 44 of file SpellCheckChannel.java.

                                            {
        @Override
        public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result result) {
          if (spellCheckMethodHandler == null) {
            Log.v(
                TAG,
                "No SpellCheckeMethodHandler registered, call not forwarded to spell check API.");
            return;
          }
          String method = call.method;
          Object args = call.arguments;
          Log.v(TAG, "Received '" + method + "' message.");
          switch (method) {
            case "SpellCheck.initiateSpellCheck":
              try {
                final ArrayList<String> argumentList = (ArrayList<String>) args;
                String locale = argumentList.get(0);
                String text = argumentList.get(1);
                spellCheckMethodHandler.initiateSpellCheck(locale, text, result);
              } catch (IllegalStateException exception) {
                result.error("error", exception.getMessage(), null);
              }
              break;
            default:
              result.notImplemented();
              break;
          }
        }
      };

---

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

• shell/platform/android/io/flutter/embedding/engine/systemchannels/SpellCheckChannel.java