ro.sync.ecss.extensions.api.webapp

Interface WebappSpellchecker

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WebappSpellchecker

Method Summary

Modifier and Type	Method and Description
java.util.List<SpellCheckingProblemInfo>	check(java.util.List<TextChunkDescriptor> textDescriptors) Performs a spellcheck of the given text descriptors.
SpellSuggestionsInfo	getSuggestionsForWordAtPosition(int position) Gets the suggestions for the word at a certain position.
java.util.List<TextChunkDescriptor>	getTextDescriptors(int startOffset, int endOffset) Returns the list of descriptors for chunks of text between the given offsets.
void	replaceWithSuggestion(int startOffset, int endOffset, java.lang.String newWord) Replaces word at a certain position.

Method Detail

getSuggestionsForWordAtPosition

SpellSuggestionsInfo getSuggestionsForWordAtPosition(int position)
                                              throws javax.swing.text.BadLocationException,
                                                     java.io.IOException

Gets the suggestions for the word at a certain position.

Parameters:

position - Position in the document.

Returns:

List of spellchecking suggestions for the word.

Throws:

javax.swing.text.BadLocationException

java.io.IOException

replaceWithSuggestion

void replaceWithSuggestion(int startOffset,
                           int endOffset,
                           java.lang.String newWord)
                    throws javax.swing.text.BadLocationException,
                           java.io.IOException

Replaces word at a certain position.

Parameters:

startOffset - Start offset for replacement.

endOffset - End offset for replacement.

newWord - Word to be inserted.

Throws:

javax.swing.text.BadLocationException

java.io.IOException

getTextDescriptors

java.util.List<TextChunkDescriptor> getTextDescriptors(int startOffset,
                                                       int endOffset)

Returns the list of descriptors for chunks of text between the given offsets.

Parameters:

startOffset - The start offset.

endOffset - The end offset.

Returns:

The list of text descriptors.

check

java.util.List<SpellCheckingProblemInfo> check(java.util.List<TextChunkDescriptor> textDescriptors)
                                        throws java.io.IOException

Performs a spellcheck of the given text descriptors. This method is thread-safe. Can be called on multiple threads and can also be called while other threads are modifying the document.

Parameters:

textDescriptors - The text descriptors.

Returns:

The list of spelling problems.

Throws:

java.io.IOException - If there is a problem reading the dictinaries.