dojox/editor/plugins/SpellCheck.js

• Provides:

  • dojox.editor.plugins.SpellCheck

• Requires:

  • dijit.form.TextBox in common
  • dijit.form.DropDownButton in common
  • dijit.TooltipDialog in common
  • dijit.form.MultiSelect in common
  • dojo.io.script in common
  • dijit.Menu in common

• dojox.editor.plugins._spellCheckControl

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    The widget that is used for the UI of the batch spelling check

• dojox.editor.plugins._spellCheckControl.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins._spellCheckControl.templateString

  • type

    String

• dojox.editor.plugins._spellCheckControl.constructor

  • constructor - constructor
  • type

    Function

• dojox.editor.plugins._spellCheckControl.postMixInProperties

  • type

    Function

• dojox.editor.plugins._spellCheckControl.id

  • type

    Object

• dojox.editor.plugins._spellCheckControl.textId

  • type

    String

• dojox.editor.plugins._spellCheckControl.selectId

  • type

    String

• dojox.editor.plugins._spellCheckControl.postCreate

  • type

    Function

• dojox.editor.plugins._spellCheckControl.suggestionSelect

• dojox.editor.plugins._spellCheckControl.suggestionSelect.addItems

  • parameters:
    • items: (typeof Array)

      An array of items be added to the select

  • summary

    Add items to the select widget

  • tags: public
  • type

    Function

• dojox.editor.plugins._spellCheckControl.suggestionSelect.removeItems

  • summary

    Remove all the items within the select widget

  • tags: public
  • type

    Function

• dojox.editor.plugins._spellCheckControl.suggestionSelect.deselectAll

  • summary

    De-select all the selected items

  • tags: public
  • type

    Function

• dojox.editor.plugins._spellCheckControl.containerNode.selectedIndex

  • type

    Number

• dojox.editor.plugins._spellCheckControl.onSkip

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onSkipAll

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onAddToDic

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onReplace

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onReplaceAll

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onCancel

  • type

    Function

• dojox.editor.plugins._spellCheckControl.onEnter

  • type

    Function

• dojox.editor.plugins._spellCheckControl.focus

  • summary

    Set the focus of the control

  • tags: public
  • type

    Function

• dojox.editor.plugins._spellCheckControl._cancel

  • parameters:
    • evt: (typeof Event)

      The event object

  • summary

    Handle the cancel event

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._enter

  • parameters:
    • evt: (typeof Event)

      The event object

  • summary

    Handle the enter event

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._unfoundTextBoxChange

  • summary

    Indicate that the Not Found textbox is changed or not

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl.isChanged

  • type

    bool

• dojox.editor.plugins._spellCheckControl._setUnfoundWordAttr

  • parameters:
    • value: (typeof String)

      The value of the Not Found textbox

  • summary

    Set the value of the Not Found textbox

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._getUnfoundWordAttr

  • summary

    Get the value of the Not Found textbox

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._setSuggestionListAttr

  • parameters:
    • values: (typeof Array)

      The list of the suggestion items

  • summary

    Set the items of the suggestion list

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._getSelectedWordAttr

  • summary

    Get the suggested word.
    If the select box is selected, the value is the selected item's value,
    else the value the the textbox's value

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._setDisabledAttr

  • parameters:
    • disabled: (typeof Boolean)
  • summary

    Enable/disable the control

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl._setInProgressAttr

  • parameters:
    • show: (typeof Boolean)
  • summary

    Set the visibility of the progress icon

  • tags:
  • type

    Function

• dojox.editor.plugins._spellCheckControl.ignoreChange

  • type

    bool

• dojox.editor.plugins._spellCheckControl.isOpen

  • type

    bool

• dojox.editor.plugins._spellCheckControl.closable

  • type

    Object

• dojox.editor.plugins._SpellCheckScriptMultiPart

  • type

    Function

  • summary

    It is a base network service component. It transfers text to a remote service port
    with cross domain ability enabled. It can split text into specified pieces and send
    them out one by one so that it can handle the case when the service has a limitation of
    the capability.
    The encoding is UTF-8.

• dojox.editor.plugins._SpellCheckScriptMultiPart.ACTION_QUERY

  • type

    Object

• dojox.editor.plugins._SpellCheckScriptMultiPart.ACTION_UPDATE

  • type

    String

• dojox.editor.plugins._SpellCheckScriptMultiPart.callbackHandle

  • type

    String

• dojox.editor.plugins._SpellCheckScriptMultiPart.maxBufferLength

  • type

    Number

• dojox.editor.plugins._SpellCheckScriptMultiPart.delimiter

  • type

    String

• dojox.editor.plugins._SpellCheckScriptMultiPart.label

  • type

    String

• dojox.editor.plugins._SpellCheckScriptMultiPart._timeout

  • type

    Number

• dojox.editor.plugins._SpellCheckScriptMultiPart.SEC

  • type

    Number

• dojox.editor.plugins._SpellCheckScriptMultiPart.constructor

  • constructor - constructor
  • type

    Function

• dojox.editor.plugins._SpellCheckScriptMultiPart.send

  • parameters:
    • content: (typeof String)

      The text to be sent

    • action: (typeof String)

      The action the service should take. Current support actions are
      ACTION_QUERY and ACTION_UPDATE

  • summary

    Send the content to the service port with the specified action

  • tags: public
  • type

    Function

• dojox.editor.plugins._SpellCheckScriptMultiPart.serviceEndPoint

  • type

    String

• dojox.editor.plugins._SpellCheckScriptMultiPart.exArgs

  • type

    Object

• dojox.editor.plugins._SpellCheckScriptMultiPart._result

  • type

    Array

• dojox.editor.plugins._SpellCheckScriptMultiPart._finalizeCollection

  • parameters:
    • action: (typeof The)

      action token

  • summary

    Assemble the responses into one result.

  • tags:
  • type

    Function

• dojox.editor.plugins._SpellCheckScriptMultiPart._counter

  • type

    Number

• dojox.editor.plugins._SpellCheckScriptMultiPart.onLoad

  • parameters:
    • data: (typeof String)
  • type

    Function

• dojox.editor.plugins._SpellCheckScriptMultiPart.setWaitingTime

  • parameters:
    • seconds: (typeof Number)
  • type

    Function

• dojox.editor.plugins._SpellCheckScriptMultiPart._queue

  • type

    Array

• dojox.editor.plugins._SpellCheckScriptMultiPart.isWorking

  • type

    bool

• dojox.editor.plugins.SpellCheck

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    This plugin provides a spelling check cabability for the editor.

• dojox.editor.plugins.SpellCheck.url

  • type

    String

• dojox.editor.plugins.SpellCheck.bufferLength

  • type

    Number

• dojox.editor.plugins.SpellCheck.interactive

  • type

    bool

• dojox.editor.plugins.SpellCheck.timeout

  • type

    Number

• dojox.editor.plugins.SpellCheck.button

  • type

    Object

• dojox.editor.plugins.SpellCheck._editor

  • type

    Object

• dojox.editor.plugins.SpellCheck.exArgs

  • type

    Object

• dojox.editor.plugins.SpellCheck._cursorSpan

  • type

    String

• dojox.editor.plugins.SpellCheck._cursorSelector

  • type

    String

• dojox.editor.plugins.SpellCheck._incorrectWordsSpan

  • type

    String

• dojox.editor.plugins.SpellCheck._ignoredIncorrectStyle

  • type

    Object

• dojox.editor.plugins.SpellCheck._ignoredIncorrectStyle.cursor

  • type

    String

• dojox.editor.plugins.SpellCheck._ignoredIncorrectStyle.borderBottom

  • type

    String

• dojox.editor.plugins.SpellCheck._ignoredIncorrectStyle.backgroundColor

  • type

    String

• dojox.editor.plugins.SpellCheck._normalIncorrectStyle

  • type

    Object

• dojox.editor.plugins.SpellCheck._normalIncorrectStyle.cursor

  • type

    String

• dojox.editor.plugins.SpellCheck._normalIncorrectStyle.borderBottom

  • type

    String

• dojox.editor.plugins.SpellCheck._normalIncorrectStyle.backgroundColor

  • type

    String

• dojox.editor.plugins.SpellCheck._highlightedIncorrectStyle

  • type

    Object

• dojox.editor.plugins.SpellCheck._highlightedIncorrectStyle.borderBottom

  • type

    String

• dojox.editor.plugins.SpellCheck._highlightedIncorrectStyle.backgroundColor

  • type

    String

• dojox.editor.plugins.SpellCheck._selector

  • type

    String

• dojox.editor.plugins.SpellCheck._maxItemNumber

  • type

    Number

• dojox.editor.plugins.SpellCheck.constructor

  • constructor - constructor
  • type

    Function

• dojox.editor.plugins.SpellCheck.setEditor

  • parameters:
    • editor: (typeof dijit.Editor)
  • type

    Function

• dojox.editor.plugins.SpellCheck._initButton

  • summary

    Initialize the button displayed on the editor's toolbar

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._strings

  • type

    Object

• dojox.editor.plugins.SpellCheck._dialog

  • type

    Object

• dojox.editor.plugins.SpellCheck._dialogContent

  • type

    Object

• dojox.editor.plugins.SpellCheck._setNetwork

  • summary

    Set up the underlying network service

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._service

  • type

    Object

• dojox.editor.plugins.SpellCheck._connectUp

  • summary

    Connect up all the events with their event handlers

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._disabled

  • parameters:
    • name: (typeof Command)

      name

    • disabled: (typeof Command)

      argument

  • summary

    When the plugin is disabled (the button is disabled), reset all to their initial status.
    If the interactive mode is on, check the content once it is enabled.

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._iterator

  • type

    Number

• dojox.editor.plugins.SpellCheck._spanList

  • type

    Array

• dojox.editor.plugins.SpellCheck._enabled

  • type

    Object

• dojox.editor.plugins.SpellCheck._keyPress

  • parameters:
    • evt
  • summary

    The handler of the onKeyPress event of the editor

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._loadData

  • parameters:
    • data: (typeof Array)

      The result of the query

  • summary

    Apply the query result to the content

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._cache

  • type

    Object

• dojox.editor.plugins.SpellCheck._dialogContent.closable

  • type

    Object

• dojox.editor.plugins.SpellCheck._openDialog

  • summary

    The handler of the onOpen event

  • type

    Function

• dojox.editor.plugins.SpellCheck._dialogContent.ignoreChange

  • type

    Object

• dojox.editor.plugins.SpellCheck._dialogContent.isOpen

  • type

    Object

• dojox.editor.plugins.SpellCheck._skip

  • parameters:
    • evt: (typeof Event)

      The event object

    • noUpdate: (typeof Boolean)

      Indicate whether to update the status of the span list or not

  • summary

    Ignore this word and move to the next unignored one.

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._spanList.length

• dojox.editor.plugins.SpellCheck._dialogContent.isChanged

  • type

    bool

• dojox.editor.plugins.SpellCheck._skipAll

  • summary

    Ignore all the same words

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._add

  • summary

    Add the unrecognized word into the dictionary

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._replace

  • summary

    Replace the incorrect word with the selected one,
    or the one the user types in the textbox

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._replaceAll

  • summary

    Replace all the words with the same text

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._cancel

  • summary

    Cancel this check action

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._enter

  • summary

    Handle the ENTER event

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._query

  • parameters:
    • html: (typeof String)

      The html value of the editor

  • summary

    Send the query text to the service. The query text is a string of words
    separated by space.

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._html2Text

  • parameters:
    • html: (typeof The)

      html code

  • summary

    Substitute the tag with white charactors so that the server
    can easily process the text. For example:
    "<a src="sample.html">Hello, world!</a>" ==>
    "                     Hello, world!    "

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._getBookmark

  • parameters:
    • eValue: (typeof String)

      The html value of the editor

  • summary

    Get the cursor position. It is the index of the characters
    where the cursor is.

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._moveToBookmark

  • summary

    Move to the position when the cursor was.

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._submitContent

  • parameters:
    • delay: (typeof Boolean)

      Indicate if the action is taken immediately or not

  • summary

    Functions to submit the content of the editor

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._delayHandler

  • type

    Object

• dojox.editor.plugins.SpellCheck._populateDialog

  • parameters:
    • index: (typeof The)

      idex of the span list

  • summary

    Populate the content of the dailog

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._markIncorrectWords

  • parameters:
    • html: (typeof String)

      The html value of the editor

    • cache: (typeof Object)

      The local word cache

  • summary

    Mark the incorrect words and set up menus if available

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck.parser

• dojox.editor.plugins.SpellCheck._editor._cursorToStart

  • type

    bool

• dojox.editor.plugins.SpellCheck._selectWord

  • parameters:
    • index: (typeof The)

      index of the span list

  • summary

    Select the incorrect word. Move to it and highlight it

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._editor.window

• dojox.editor.plugins.SpellCheck._replaceWord

  • parameters:
    • index: (typeof The)

      index of the span list

    • text: (typeof The)

      text to be replaced with

  • summary

    Replace the word at the given index with the text

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._skipWord

  • parameters:
    • index: (typeof The)

      index of the span list

  • summary

    Skip the word at the index

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._skipWordAll

  • parameters:
    • index: (typeof The)

      index of the span list

    • word: (typeof String)

      If this argument is given, skip all the words that have the same text
      as the word

  • summary

    Skip the all the word that have the same text as the word at the index
    or the given word

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._addWord

  • parameters:
    • index: (typeof The)

      index of the span list

    • word: (typeof String)

      If this argument is given, add the word to the dictionary and
      skip all the words like it

  • summary

    Add the word at the index to the dictionary

  • tags:
  • type

    Function

• dojox.editor.plugins.SpellCheck._findText

  • parameters:
    • txt: (typeof String)

      The text to locate in the document.

    • caseSensitive: (typeof Boolean)

      Whether or ot to search case-sensitively.

    • backwards: (typeof Boolean)

      Whether or not to search backwards in the document.

  • summary

    This function invokes a find with specific options

  • tags: private.
  • return_summary

    Boolean indicating if the content was found or not.

  • type

    Function

• dojox.editor.plugins.SpellCheck._editor.document

• dojox.editor.plugins.SpellCheck._spellCheckFilter

  • parameters:
    • value: (typeof String)

      The html value of the editor

  • summary

    Filter out the incorrect word style so that the value of the edtior
    won't include the spans that wrap around the incorrect words

  • tags:
  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object