The `goog.spell.SpellCheck` Class

goog.spell.SpellCheck
> goog.events.EventTarget
> goog.Disposable

`goog.spell.SpellCheck(opt_lookupFunction, opt_language)`

Support class for spell checker components. Provides basic functionality such as word lookup and caching.

opt_lookupFunction {Function=}: Function to use for word lookup. Must accept an array of words, an object reference and a callback function as parameters. It must also call the callback function (as a method on the object), once ready, with an array containing the original words, their spelling status and optionally an array of suggestions.
opt_language {string=}: Content language.

The `goog.spell.SpellCheck.CacheIndex` Enum

Fields for word array in cache. … more

The `goog.spell.SpellCheck.EventType` Enum

Constants for event names … more

`.SPLIT_REGEX` {`RegExp`}

Regular expression for splitting a string into individual words and blocks of separators. Matches zero or one word followed by zero or more separators.

`.WORD_BOUNDARY_CHARS` {`string`}

Regular expression for identifying word boundaries.

`.WORD_BOUNDARY_REGEX` {`RegExp`}

Regular expression for identifying word boundaries.

The `goog.spell.SpellCheck.WordChangedEvent` Class

Object representing a word changed event. Fired when the status of a word changes. … more

The `goog.spell.SpellCheck.WordStatus` Enum

Codes representing the status of an individual word. … more

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}: The type of the event to listen for.
handler {Function|Object}: The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}: In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}: Object in whose scope to call the listener.

`.addOnDisposeCallback(callback, opt_scope)`

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}: The callback function.
opt_scope {Object=}: An optional scope to call the callback in.

`.checkBlock(text)`

Checks spelling for a block of text.

text {string}: Block of text to spell check.

`.checkWord(word)`

Checks spelling for a single word. Returns the status of the supplied word, or UNKNOWN if it's not cached. If it's not cached the word is added to a queue and checked with the verification implementation with a short delay.

word {string}: Word to check spelling of.
returns {goog.spell.SpellCheck.WordStatus}: The status of the supplied word, or UNKNOWN if it's not cached.

`.creationStack` {`string`}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

`.dispatchEvent(e)`

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}: Event object.
returns {boolean}: If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

`.dispose()`

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}: Nothing.

`.disposeInternal()` [protected]

Inherited from goog.events.EventTarget .

Unattach listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners, it should be something like this:

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

`.getLanguage()`

Returns language.

returns {string}: Content language.

`.getParentEventTarget()`

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}: The parent EventTarget or null if there is no parent.

`.getSuggestions(word)`

Returns suggestions for the given word.

word {string}: Word to get suggestions for.
returns {Array.<string>}: An array of suggestions for the given word.

`.isDisposed()`

Inherited from goog.Disposable .

returns {boolean}: Whether the object has been disposed of.

`.processPending()`

Processes pending words unless a lookup operation has already been queued or is in progress.

@throws: {Error}

`.registerDisposable(disposable)`

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}: that will be disposed when this object is disposed.

`.removeEventListener(type, handler, opt_capture, opt_handlerScope)`

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}: The type of the event to listen for.
handler {Function|Object}: The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}: In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}: Object in whose scope to call the listener.

`.setLanguage(opt_language)`

Sets language.

opt_language {string=}: Content language.

`.setLookupFunction(f)`

Sets the lookup function.

f {Function}: Function to use for word lookup. Must accept an array of words, an object reference and a callback function as parameters. It must also call the callback function (as a method on the object), once ready, with an array containing the original words, their spelling status and optionally an array of suggestions.

`.setParentEventTarget(parent)`

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}: Parent EventTarget (null if none).

`.setWordStatus(word, status, opt_suggestions)`

Sets a words spelling status.

word {string}: Word to set status for.
status {goog.spell.SpellCheck.WordStatus}: Status of word.
opt_suggestions {Array.<string>=}: Suggestions. Example: obj.setWordStatus('word', VALID); obj.setWordStatus('wrod', INVALID, ['word', 'wood', 'rod']);.

The goog.spell.SpellCheck Class

goog.spell.SpellCheck(opt_lookupFunction, opt_language)

The goog.spell.SpellCheck.CacheIndex Enum

The goog.spell.SpellCheck.EventType Enum

.SPLIT_REGEX {RegExp}

.WORD_BOUNDARY_CHARS {string}

.WORD_BOUNDARY_REGEX {RegExp}

The goog.spell.SpellCheck.WordChangedEvent Class

The goog.spell.SpellCheck.WordStatus Enum

.addEventListener(type, handler, opt_capture, opt_handlerScope)

.addOnDisposeCallback(callback, opt_scope)

.checkBlock(text)

.checkWord(word)

.creationStack {string}

.dispatchEvent(e)

.dispose()

.disposeInternal() [protected]

.getDisposed [deprecated]

.getLanguage()

.getParentEventTarget()

.getSuggestions(word)

.isDisposed()

.processPending()

.registerDisposable(disposable)

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

.setLanguage(opt_language)

.setLookupFunction(f)

.setParentEventTarget(parent)

.setWordStatus(word, status, opt_suggestions)

The `goog.spell.SpellCheck` Class

`goog.spell.SpellCheck(opt_lookupFunction, opt_language)`

The `goog.spell.SpellCheck.CacheIndex` Enum

The `goog.spell.SpellCheck.EventType` Enum

`.SPLIT_REGEX` {`RegExp`}

`.WORD_BOUNDARY_CHARS` {`string`}

`.WORD_BOUNDARY_REGEX` {`RegExp`}

The `goog.spell.SpellCheck.WordChangedEvent` Class

The `goog.spell.SpellCheck.WordStatus` Enum

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

`.addOnDisposeCallback(callback, opt_scope)`

`.checkBlock(text)`

`.checkWord(word)`

`.creationStack` {`string`}

`.dispatchEvent(e)`

`.dispose()`

`.disposeInternal()` [protected]

`.getDisposed` [deprecated]

`.getLanguage()`

`.getParentEventTarget()`

`.getSuggestions(word)`

`.isDisposed()`

`.processPending()`

`.registerDisposable(disposable)`

`.removeEventListener(type, handler, opt_capture, opt_handlerScope)`

`.setLanguage(opt_language)`

`.setLookupFunction(f)`

`.setParentEventTarget(parent)`

`.setWordStatus(word, status, opt_suggestions)`