Package ro.sync.ecss.extensions.api

Class SpellCheckingProblemInfo

java.lang.Object
ro.sync.ecss.extensions.api.SpellCheckingProblemInfo
Direct Known Subclasses:
SpellCheckingProblemInfoWithSuggestions
@API(type=NOT_EXTENDABLE, src=PUBLIC) public class SpellCheckingProblemInfo extends Object

  • Constructor Details

    • SpellCheckingProblemInfo

      public SpellCheckingProblemInfo(int startOffset, int endOffset, int errorCode, String lang, String word)
      Parameters:
      startOffset - Word start position.
      endOffset - Word end position.
      errorCode - Error code result from spellchecking.
      lang - ISO Name for the language of the word.
      word - Word between the offsets.

    • SpellCheckingProblemInfo

      public SpellCheckingProblemInfo(int startOffset, int endOffset, int errorCode, String lang, String word, List<String> suggestions)
      Parameters:
      startOffset - Word start position.
      endOffset - Word end position.
      errorCode - Error code result from spellchecking.
      lang - ISO Name for the language of the word.
      word - Word between the offsets.
      suggestions - The suggestions for the word.

    • SpellCheckingProblemInfo

      public SpellCheckingProblemInfo(int startOffset, int endOffset, int errorCode, String lang, String word, List<String> suggestions, WebAuthorSpellcheckErrorTypes errorType, String errorMessage)
      Parameters:
      startOffset - Word start position.
      endOffset - Word end position.
      errorCode - Error code result from spellchecking.
      lang - ISO Name for the language of the word.
      word - Word between the offsets.
      suggestions - The suggestions for the word.
      errorType - The error type.
      errorMessage - Error message for the word.
      Since:
      27.1
      **************************************
      EXPERIMENTAL - Subject to change
      **************************************

      Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

  • Method Details

    • getStartOffset

      public int getStartOffset()
      Returns:
      Returns the start.

    • getEndOffset

      public int getEndOffset()
      Returns:
      Returns the end.

    • getErrorCode

      public int getErrorCode()
      Returns:
      Returns the err.

    • getLanguageIsoName

      public String getLanguageIsoName()
      Returns:
      Returns the languageIsoName.

    • getWord

      public String getWord()
      Returns:
      Returns the word.

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also:

    • getSuggestions

      public List<String> getSuggestions()
      Get the suggestions for a word. Custom spell checking engines may provide suggestions on detection.
      Returns:
      Returns the suggestions for the word.
      Since:
      21

    • getErrorMessage

      public String getErrorMessage()
      Returns:
      Returns the error message for the word.
      Since:
      28
      **************************************
      EXPERIMENTAL - Subject to change
      **************************************

      Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

    • getErrorType

      public WebAuthorSpellcheckErrorTypes getErrorType()
      Returns:
      Returns the error type.
      Since:
      28
      **************************************
      EXPERIMENTAL - Subject to change
      **************************************

      Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.