io.flutter.plugin.editing.SpellCheckPlugin Class Reference

Inheritance diagram for io.flutter.plugin.editing.SpellCheckPlugin:

Public Member Functions
	SpellCheckPlugin ( @NonNull TextServicesManager textServicesManager, @NonNull SpellCheckChannel spellCheckChannel)
void	destroy ()
void	initiateSpellCheck ( @NonNull String locale, @NonNull String text, @NonNull MethodChannel.Result result)
void	performSpellCheck (@NonNull String locale, @NonNull String text)
void	onGetSentenceSuggestions (SentenceSuggestionsInfo[] results)
void	onGetSuggestions (SuggestionsInfo[] results)
void	initiateSpellCheck ( @NonNull String locale, @NonNull String text, @NonNull MethodChannel.Result result)

Static Public Attributes
static final String	START_INDEX_KEY = "startIndex"
static final String	END_INDEX_KEY = "endIndex"
static final String	SUGGESTIONS_KEY = "suggestions"

Package Attributes
MethodChannel.Result	pendingResult

Detailed Description

SpellCheckPlugin is the implementation of all functionality needed for spell check for text input.

The plugin handles requests for spell check sent by the io.flutter.embedding.engine.systemchannels.SpellCheckChannel via sending requests to the Android spell checker. It also receives the spell check results from the service and sends them back to the framework through the io.flutter.embedding.engine.systemchannels.SpellCheckChannel.

Definition at line 30 of file SpellCheckPlugin.java.

Constructor & Destructor Documentation

SpellCheckPlugin()

io.flutter.plugin.editing.SpellCheckPlugin.SpellCheckPlugin ( @NonNull TextServicesManager  textServicesManager, @NonNull SpellCheckChannel  spellCheckChannel  )

inline

Definition at line 48 of file SpellCheckPlugin.java.

                                                    {
    mTextServicesManager = textServicesManager;
    mSpellCheckChannel = spellCheckChannel;
 
    mSpellCheckChannel.setSpellCheckMethodHandler(this);
  }

Member Function Documentation

destroy()

void io.flutter.plugin.editing.SpellCheckPlugin.destroy ( )

inline

Unregisters this SpellCheckPlugin as the
SpellCheckChannel.SpellCheckMethodHandler, for the io.flutter.embedding.engine.systemchannels.SpellCheckChannel, and closes the most recently opened SpellCheckerSession.

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

Definition at line 65 of file SpellCheckPlugin.java.

                        {
    mSpellCheckChannel.setSpellCheckMethodHandler(null);
 
    if (mSpellCheckerSession != null) {
      mSpellCheckerSession.close();
    }
  }

initiateSpellCheck()

void io.flutter.plugin.editing.SpellCheckPlugin.initiateSpellCheck ( @NonNull String  locale, @NonNull String  text, @NonNull MethodChannel.Result  result  )

inline

Initiates call to native spell checker to spell check specified text if there is no result awaiting a response.

Implements io.flutter.embedding.engine.systemchannels.SpellCheckChannel.SpellCheckMethodHandler.

Definition at line 78 of file SpellCheckPlugin.java.

                                                                                          {
    if (pendingResult != null) {
      result.error("error", "Previous spell check request still pending.", null);
      return;
    }
 
    pendingResult = result;
 
    performSpellCheck(locale, text);
  }

onGetSentenceSuggestions()

void io.flutter.plugin.editing.SpellCheckPlugin.onGetSentenceSuggestions ( SentenceSuggestionsInfo[]  results )

inline

Callback for Android spell check API that decomposes results and send results through the SpellCheckChannel.

Spell check results are encoded as dictionaries with a format that looks like

{

  startIndex: 0,

  endIndex: 5,

  suggestions: [hello, ...]

}

where there may be up to 5 suggestions.

Definition at line 125 of file SpellCheckPlugin.java.

                                                                          {
    if (results.length == 0) {
      pendingResult.success(new ArrayList<HashMap<String, Object>>());
      pendingResult = null;
      return;
    }
 
    ArrayList<HashMap<String, Object>> spellCheckerSuggestionSpans =
        new ArrayList<HashMap<String, Object>>();
    SentenceSuggestionsInfo spellCheckResults = results[0];
    if (spellCheckResults == null) {
      pendingResult.success(new ArrayList<HashMap<String, Object>>());
      pendingResult = null;
      return;
    }
 
    for (int i = 0; i < spellCheckResults.getSuggestionsCount(); i++) {
      SuggestionsInfo suggestionsInfo = spellCheckResults.getSuggestionsInfoAt(i);
      int suggestionsCount = suggestionsInfo.getSuggestionsCount();
 
      if (suggestionsCount <= 0) {
        continue;
      }
 
      HashMap<String, Object> spellCheckerSuggestionSpan = new HashMap<String, Object>();
      int start = spellCheckResults.getOffsetAt(i);
      int end = start + spellCheckResults.getLengthAt(i);
 
      spellCheckerSuggestionSpan.put(START_INDEX_KEY, start);
      spellCheckerSuggestionSpan.put(END_INDEX_KEY, end);
 
      ArrayList<String> suggestions = new ArrayList<String>();
      boolean validSuggestionsFound = false;
      for (int j = 0; j < suggestionsCount; j++) {
        String suggestion = suggestionsInfo.getSuggestionAt(j);
        // TODO(camsim99): Support spell check on Samsung by retrieving accurate spell check
        // results, then remove this check: https://github.com/flutter/flutter/issues/120608.
        if (!suggestion.equals("")) {
          validSuggestionsFound = true;
          suggestions.add(suggestion);
        }
      }
 
      if (!validSuggestionsFound) {
        continue;
      }
      spellCheckerSuggestionSpan.put(SUGGESTIONS_KEY, suggestions);
      spellCheckerSuggestionSpans.add(spellCheckerSuggestionSpan);
    }
 
    pendingResult.success(spellCheckerSuggestionSpans);
    pendingResult = null;
  }

onGetSuggestions()

void io.flutter.plugin.editing.SpellCheckPlugin.onGetSuggestions ( SuggestionsInfo[]  results )

inline

Definition at line 180 of file SpellCheckPlugin.java.

                                                          {
    // Deprecated callback for Android spell check API; will not use.
  }

performSpellCheck()

void io.flutter.plugin.editing.SpellCheckPlugin.performSpellCheck ( @NonNull String  locale, @NonNull String  text  )

inline

Calls on the Android spell check API to spell check specified text.

referToSpellCheckerLanguageSettings=

Definition at line 91 of file SpellCheckPlugin.java.

                                                                              {
    Locale localeFromString = LocalizationPlugin.localeFromString(locale);
 
    if (mSpellCheckerSession == null) {
      mSpellCheckerSession =
          mTextServicesManager.newSpellCheckerSession(
              null,
              localeFromString,
              this,
              /** referToSpellCheckerLanguageSettings= */
              true);
    }
 
    TextInfo[] textInfos = new TextInfo[] {new TextInfo(text)};
    mSpellCheckerSession.getSentenceSuggestions(textInfos, MAX_SPELL_CHECK_SUGGESTIONS);
  }

Member Data Documentation

END_INDEX_KEY

final String io.flutter.plugin.editing.SpellCheckPlugin.END_INDEX_KEY = "endIndex"

static

Definition at line 39 of file SpellCheckPlugin.java.

pendingResult

MethodChannel.Result io.flutter.plugin.editing.SpellCheckPlugin.pendingResult

package

Definition at line 42 of file SpellCheckPlugin.java.

START_INDEX_KEY

final String io.flutter.plugin.editing.SpellCheckPlugin.START_INDEX_KEY = "startIndex"

static

Definition at line 38 of file SpellCheckPlugin.java.

SUGGESTIONS_KEY

final String io.flutter.plugin.editing.SpellCheckPlugin.SUGGESTIONS_KEY = "suggestions"

static

Definition at line 40 of file SpellCheckPlugin.java.

---

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

• shell/platform/android/io/flutter/plugin/editing/SpellCheckPlugin.java