goog.ui.PlainTextSpellChecker
Classgoog.ui.PlainTextSpellChecker
> goog.ui.AbstractSpellChecker
> goog.ui.Component
> goog.events.EventTarget
> goog.Disposable
goog.ui.PlainTextSpellChecker(handler, opt_domHelper)
Plain text spell checker implementation.
handler
{goog.spell.SpellCheck
}
opt_domHelper
{goog.dom.DomHelper
=}
.addChild(child, opt_render)
Inherited from goog.ui.Component
.
Adds the specified component as the last child of this component. See {@link goog.ui.Component#addChildAt} for detailed semantics.
child
{goog.ui.Component
}
opt_render
{boolean
=}
.addChildAt(child, index, opt_render)
Inherited from goog.ui.Component
.
Adds the specified component as a child of this component at the given 0-based index. Both {@code addChild} and {@code addChildAt} assume the following contract between parent and child components:
child
{goog.ui.Component
}
index
{number
}
opt_render
{boolean
=}
void
}
.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
}
handler
{Function
|Object
}
opt_capture
{boolean
=}
opt_handlerScope
{Object
=}
.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
}
opt_scope
{Object
=}
.blockReadyEvents()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Blocks processing of spell checker READY events. This is used in dictionary recharge and async mode so that completion is not signaled prematurely.
.canDecorate(element)
Inherited from goog.ui.Component
.
Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.
element
{Element
}
boolean
}
.check()
Checks spelling for all text and displays correction UI.
.clearWordElements()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Clears the word to element references map used by replace/ignore.
.continueAsyncProcessing()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Continues processing started by processTextAsync. Calls virtual processWord_ and processRange_ methods.
goog.ui.AbstractSpellChecker.AsyncResult
}
.correctedWordClassName
{string
}Class name for corrected words.
.correctionPaneClassName
{string
}Class name for correction pane.
.createDom()
Creates the initial DOM representation for the component.
.createWordElement_(word, status)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Creates an element for a specified word and stores a reference to it.
word
{string
}
status
{goog.spell.SpellCheck.WordStatus
}
HTMLSpanElement
}
.creationStack
{string
}Inherited from goog.Disposable
.
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
.decorate(element)
Inherited from goog.ui.Component
.
Decorates the element for the UI component.
element
{Element
}
.decorateInternal(element)
[protected]Inherited from goog.ui.Component
.
Actually decorates the element. Should be overridden by inheriting objects. This method can assume there are checks to ensure the component has not already been rendered have occurred and that enter document will be called afterwards. This method is considered protected.
element
{Element
}
.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
}
boolean
}
.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.
void
}
.disposeInternal()
[protected]Disposes of the component. Calls {@code exitDocument}, which is expected to remove event handlers and clean up the component. Propagates the call to the component's children, if any. Removes the component's DOM from the document unless it was decorated.
.dom_
[protected] {!goog.dom.DomHelper
}Inherited from goog.ui.Component
.
DomHelper used to interact with the document, allowing components to be created in a different window.
.enterDocument()
.excludeMarker
[protected] {Array
.<string
>|string
|RegExp
|undefined
}Inherited from goog.ui.AbstractSpellChecker
.
Markers for the text that does not need to be included in the processing. For rich text editor this is a list of strings formatted as tagName.className or className. If both are specified, the element will be excluded if BOTH are matched. If only a className is specified, then we will exclude regions with the className. If only one marker is needed, it may be passed as a string. For plain text editor this is a RegExp that matches the excluded text. Used exclusively by the derived classes
.exitDocument()
.finishAsyncProcessing()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Finalizes asynchronous processing mode. Should be called after there is no more text to process and processTextAsync and/or continueAsyncProcessing returned FINISHED.
.forEachChild(f, opt_obj)
Inherited from goog.ui.Component
.
Calls the given function on each of this component's children in order. If {@code opt_obj} is provided, it will be used as the 'this' object in the function when called. The function should take two arguments: the child component and its 0-based index. The return value is ignored.
f
{Function
}
opt_obj
{Object
=}
.getChild(id)
Inherited from goog.ui.Component
.
Returns the child with the given ID, or null if no such child exists.
id
{string
}
goog.ui.Component
?}
.getChildAt(index)
Inherited from goog.ui.Component
.
Returns the child at the given index, or null if the index is out of bounds.
index
{number
}
goog.ui.Component
?}
.getChildCount()
Inherited from goog.ui.Component
.
Returns the number of children of this component.
number
}
.getChildIds()
Inherited from goog.ui.Component
.
Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.
Array
.<string
>}
.getContentElement()
Inherited from goog.ui.Component
.
Returns the DOM element into which child components are to be rendered, or null if the component itself hasn't been rendered yet. This default implementation returns the component's root element. Subclasses with complex DOM structures must override this method.
Element
}
.getDisposed
[deprecated]Deprecated. Use {@link #isDisposed} instead.
Inherited from goog.Disposable
.
boolean
}
.getDomHelper()
Inherited from goog.ui.Component
.
Returns the dom helper that is being used on this component.
goog.dom.DomHelper
}
.getElement()
Inherited from goog.ui.Component
.
Gets the component's element.
Element
}
.getElementByClass(className)
Inherited from goog.ui.Component
.
Returns the first element in this component's DOM with the provided className.
className
{string
}
Element
}
.getElementByFragment(idFragment)
Inherited from goog.ui.Component
.
Helper function for returning an element in the document with a unique id generated using makeId().
idFragment
{string
}
Element
}
.getElementById(id)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Returns the span element that matches the given number id.
id
{number
}
Element
}
.getElementProperties(status)
[protected]Returns desired element properties for the specified status.
status
{goog.spell.SpellCheck.WordStatus
}
Object
}
.getElementsByClass(className)
Inherited from goog.ui.Component
.
Returns an array of all the elements in this component's DOM with the provided className.
className
{string
}
goog.array.ArrayLike
}
.getFragmentFromId(id)
Inherited from goog.ui.Component
.
Helper function for returning the fragment portion of an id generated using makeId().
id
{string
}
string
}
.getHandler()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Returns the event handler for this component, lazily created the first time this method is called.
goog.spell.SpellCheck
}
.getId()
Inherited from goog.ui.Component
.
Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.
string
}
.getMenu()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
goog.ui.PopupMenu
|undefined
}
.getMenuEdit()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
goog.ui.MenuItem
|undefined
}
.getModel()
Inherited from goog.ui.Component
.
Returns the model associated with the UI component.
.getParent()
Inherited from goog.ui.Component
.
Returns the component's parent, if any.
goog.ui.Component
?}
.getParentEventTarget()
Inherited from goog.events.EventTarget
.
Returns the parent of this event target to use for bubbling.
goog.events.EventTarget
}
.handleOverlayKeyEvent(e)
Handles key down for overlay.
e
{goog.events.BrowserEvent
}
boolean
|undefined
}
.hasChildren()
Inherited from goog.ui.Component
.
Returns true if the component has children.
boolean
}
.ignoreWord(word)
Inherited from goog.ui.AbstractSpellChecker
.
Ignores spelling of word.
word
{string
}
.indexOfChild(child)
Inherited from goog.ui.Component
.
Returns the 0-based index of the given child component, or -1 if no such child is found.
child
{goog.ui.Component
?}
number
}
.initSuggestionsMenu()
[protected]Initializes suggestions menu. Populates menu with separator and ignore option that are always valid. Suggestions are later added above the separator.
.initializeAsyncMode()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Starts asynchronous processing mode.
.invalidWordClassName
{string
}Class name for invalid words.
.isDisposed()
Inherited from goog.Disposable
.
boolean
}
.isInDocument()
Inherited from goog.ui.Component
.
Determines whether the component has been added to the document.
boolean
}
.isRightToLeft()
Inherited from goog.ui.Component
.
Returns true if the component is rendered right-to-left, false otherwise. The first time this function is invoked, the right-to-left rendering property is set if it has not been already.
boolean
}
.isVisible()
Inherited from goog.ui.AbstractSpellChecker
.
boolean
}
.makeElementId(opt_id)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Generates unique Ids for spell checker elements.
opt_id
{number
=}
string
}
.makeId(idFragment)
Inherited from goog.ui.Component
.
Helper function for subclasses that gets a unique id for a given fragment, this can be used by components to generate unique string ids for DOM elements.
idFragment
{string
}
string
}
.makeIds(object)
Inherited from goog.ui.Component
.
Makes a collection of ids. This is a convenience method for makeId. The object's values are the id fragments and the new values are the generated ids. The key will remain the same.
object
{Object
}
Object
}
.markCorrected
{boolean
}Inherited from goog.ui.AbstractSpellChecker
.
Whether corrected words should be highlighted.
.onCorrectionAction(event)
[protected]Handles correction menu actions.
event
{goog.events.Event
}
.populateDictionary(text, words)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Precharges local dictionary cache. This is optional, but greatly reduces amount of subsequent churn in the DOM tree because most of the words become known from the very beginning.
text
{string
}
words
{number
}
number
}
.processRange(node, text)
[protected]Processes range of text - recognized words and separators.
node
{Node
}
text
{string
}
.processTextAsync(node, text)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Splits text into individual words and blocks of separators. Calls virtual processWord_ and processRange_ methods.
node
{Node
}
text
{string
}
goog.ui.AbstractSpellChecker.AsyncResult
}
.processWord(node, word, status)
[protected]Processes word.
node
{Node
}
word
{string
}
status
{goog.spell.SpellCheck.WordStatus
}
.registerDisposable(disposable)
Inherited from goog.Disposable
.
Associates a disposable object with this object so that they will be disposed together.
disposable
{goog.disposable.IDisposable
}
.registerWordElement_(word, el)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Stores a reference to word element.
word
{string
}
el
{HTMLSpanElement
}
.removeChild(child, opt_unrender)
Inherited from goog.ui.Component
.
Removes the given child from this component, and returns it. Throws an error if the argument is invalid or if the specified child isn't found in the parent component. The argument can either be a string (interpreted as the ID of the child component to remove) or the child component itself. If {@code opt_unrender} is true, calls {@link goog.ui.component#exitDocument} on the removed child, and subsequently detaches the child's DOM from the document. Otherwise it is the caller's responsibility to clean up the child component's DOM.
child
{string
|goog.ui.Component
|null
}
opt_unrender
{boolean
=}
goog.ui.Component
}
.removeChildAt(index, opt_unrender)
Inherited from goog.ui.Component
.
Removes the child at the given index from this component, and returns it. Throws an error if the argument is out of bounds, or if the specified child isn't found in the parent. See {@link goog.ui.Component#removeChild} for detailed semantics.
index
{number
}
opt_unrender
{boolean
=}
goog.ui.Component
}
.removeChildren(opt_unrender)
Inherited from goog.ui.Component
.
Removes every child component attached to this one and returns them.
opt_unrender
{boolean
=}
Array
.<goog.ui.Component
>|undefined
}
.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
}
handler
{Function
|Object
}
opt_capture
{boolean
=}
opt_handlerScope
{Object
=}
.removeMarkup(el)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Removes spell-checker markup and restore the node to text.
el
{Element
}
.render(opt_parentElement)
Inherited from goog.ui.Component
.
Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body. If this component has a parent component, and the parent component is not in the document already, then this will not call {@code enterDocument} on this component. Throws an Error if the component is already rendered.
opt_parentElement
{Element
=}
.renderBefore(sibling)
Inherited from goog.ui.Component
.
Renders the component before another element. The other element should be in the document already. Throws an Error if the component is already rendered.
sibling
{Node
}
.replaceWord(el, old, word)
Inherited from goog.ui.AbstractSpellChecker
.
Replaces word.
el
{Element
}
old
{string
}
word
{string
}
.resume()
Hides correction UI.
.setElementInternal(element)
[protected]Inherited from goog.ui.Component
.
Sets the component's root element to the given element. Considered protected and final. This should generally only be called during createDom. Setting the element does not actually change which element is rendered, only the element that is associated with this UI component.
element
{Element
}
.setExcludeMarker(marker)
Inherited from goog.ui.AbstractSpellChecker
.
Sets the marker for the excluded text. {@see goog.ui.AbstractSpellChecker.prototype.excludeMarker}
marker
{Array
.<string
>|string
|RegExp
|null
}
.setHandler(handler)
Inherited from goog.ui.AbstractSpellChecker
.
Sets the handler used for caching and lookups.
handler
{goog.spell.SpellCheck
}
.setId(id)
Inherited from goog.ui.Component
.
Assigns an ID to this component instance. It is the caller's responsibility to guarantee that the ID is unique. If the component is a child of a parent component, then the parent component's child index is updated to reflect the new ID; this may throw an error if the parent already has a child with an ID that conflicts with the new ID.
id
{string
}
.setModel(obj)
Inherited from goog.ui.Component
.
Sets the model associated with the UI component.
obj
{*}
.setParent(parent)
Inherited from goog.ui.Component
.
Sets the parent of this component to use for event bubbling. Throws an error if the component already has a parent or if an attempt is made to add a component to itself as a child. Callers must use {@code removeChild} or {@code removeChildAt} to remove components from their containers before calling this method.
parent
{goog.ui.Component
}
.setParentEventTarget(parent)
Inherited from goog.ui.Component
.
Overrides {@link goog.events.EventTarget#setParentEventTarget} to throw an error if the parent component is set, and the argument is not the parent.
parent
{goog.events.EventTarget
?}
.setRightToLeft(rightToLeft)
Inherited from goog.ui.Component
.
Set is right-to-left. This function should be used if the component needs to know the rendering direction during dom creation (i.e. before {@link #enterDocument} is called and is right-to-left is set).
rightToLeft
{boolean
}
.showSuggestionsMenu(el, opt_pos)
Inherited from goog.ui.AbstractSpellChecker
.
Displays suggestions menu.
el
{Element
}
opt_pos
{goog.events.BrowserEvent
|goog.math.Coordinate
=}
.suggestionsMenuClassName
{string
}Inherited from goog.ui.AbstractSpellChecker
.
Class name for suggestions menu.
.unblockReadyEvents()
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Unblocks processing of spell checker READY events. This is used in dictionary recharge and async mode so that completion is not signaled prematurely.
.updateElement(el, word, status)
[protected]Inherited from goog.ui.AbstractSpellChecker
.
Updates element based on word status. Either converts it to a text node, or merges it with the previous or next text node if the status of the world is VALID, in which case the element itself is eliminated.
el
{Element
}
word
{string
}
status
{goog.spell.SpellCheck.WordStatus
}
.wasDecorated()
Inherited from goog.ui.Component
.
boolean
}