spell.SpellCheck Extends goog.events.EventTarget
Support class for spell checker components. Provides basic functionality such as word lookup and caching.

Inheritance

Constructor

goog.spell.SpellCheck(opt_lookupFunctionopt_language)

Parameters

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.

Instance Methods

Public Protected Private
checkBlock(text)
Checks spelling for a block of text.
Arguments:
text : string
Block of text to spell check.
code »
checkWord(word) goog.spell.SpellCheck.WordStatus
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.
Arguments:
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.
code »
checkWord_(word) goog.spell.SpellCheck.WordStatus
Checks spelling for a single word. Returns the status of the supplied word, or UNKNOWN if it's not cached.
Arguments:
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.
code »
getLanguage() string
Returns language.
Returns: string  Content language.
code »
getSuggestions(word) Array.<string>
Returns suggestions for the given word.
Arguments:
word : string
Word to get suggestions for.
Returns: Array.<string>  An array of suggestions for the given word.
code »
lookupCallback_(data)
Callback for lookup function.
Arguments:
data : Array.<Array>
Data array. Each word is represented by an array containing the word, the status and optionally an array of suggestions. Passing null indicates that the operation failed.
code »
processPending()
Processes pending words unless a lookup operation has already been queued or is in progress.
code »
processPending_()
Processes pending words using the verification callback.
code »
setLanguage(opt_language)
Sets language.
Arguments:
opt_language : string=
Content language.
code »
setLookupFunction(f)
Sets the lookup function.
Arguments:
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.
code »
setWordStatus(wordstatusopt_suggestions)
Sets a words spelling status.
Arguments:
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']);.
code »
setWordStatus_(wordstatusopt_suggestions)
Sets a words spelling status.
Arguments:
word : string
Word to set status for.
status : goog.spell.SpellCheck.WordStatus
Status of word.
opt_suggestions : Array.<string>>
Suggestions.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes 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.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

cache_ :
Cache for set language. Reference to the element corresponding to the set language in the static goog.spell.SpellCheck.cache_.
Code »
constructor :
No description.
Code »
language_ :
Content Language.
Code »
lookupFunction_ :
Function used to lookup spelling of words.
Code »
lookupInProgress_ :
Whether a lookup operation is in progress.
Code »
queueTimer_ :
Id for timer processing the pending queue.
Code »
unknownWords_ : goog.structs.Set
Cache for words not yet checked with lookup function.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.spell.SpellCheck.LOOKUP_DELAY_ :
Delay, in ms, to wait for additional words to be entered before a lookup operation is triggered.
Code »
goog.spell.SpellCheck.SPLIT_REGEX :
Regular expression for splitting a string into individual words and blocks of separators. Matches zero or one word followed by zero or more separators.
Code »
goog.spell.SpellCheck.WORD_BOUNDARY_CHARS :
Regular expression for identifying word boundaries.
Code »
goog.spell.SpellCheck.WORD_BOUNDARY_REGEX :
Regular expression for identifying word boundaries.
Code »
goog.spell.SpellCheck.cache_ :
Cache. Shared across all spell checker instances. Map with langauge as the key and a cache for that language as the value.
Code »
goog.spell.SpellCheck.superClass_ :
No description.
Code »

Enumerations

goog.spell.SpellCheck.CacheIndex :
Fields for word array in cache.
Constants:
STATUS
No description.
SUGGESTIONS
No description.
Code »
goog.spell.SpellCheck.EventType :
Constants for event names
Constants:
ERROR
No description.
READY
No description.
WORD_CHANGED
No description.
Code »
goog.spell.SpellCheck.WordStatus :
Codes representing the status of an individual word.
Constants:
CORRECTED
No description.
IGNORED
No description.
INVALID
No description.
UNKNOWN
No description.
VALID
No description.
Code »

Package spell

Package Reference