dijit/Editor.js

• Provides:

  • dijit.Editor

• Requires:

  • dijit._editor.RichText in common
  • dijit.Toolbar in common
  • dijit.ToolbarSeparator in common
  • dijit._editor._Plugin in common
  • dijit._editor.plugins.EnterKeyHandling in common
  • dijit._editor.range in common
  • dijit._Container in common
  • dojo.i18n in common
  • dijit.layout._LayoutWidget in common

• dijit.Editor

  • type

    Function

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

    A rich text Editing widget

  • tags:
  • description

    This widget provides basic WYSIWYG editing features, based on the browser's
    underlying rich text editing capability, accompanied by a toolbar (`dijit.Toolbar`).
    A plugin model is available to extend the editor's capabilities as well as the
    the options available in the toolbar.  Content generation may vary across
    browsers, and clipboard operations may have different results, to name
    a few limitations.  Note: this widget should not be used with the HTML
    <TEXTAREA> tag -- see dijit._editor.RichText for details.

• dijit.Editor.plugins

  • tags: const
  • type

    Object[]

  • summary

    A list of plugin names (as strings) or instances (as objects)
    for this widget.
    
    When declared in markup, it might look like:
    	plugins="['bold',{name:'dijit._editor.plugins.FontChoice', command:'fontName', generic:true}]"

• dijit.Editor.extraPlugins

  • tags: const
  • type

    Object[]

  • summary

    A list of extra plugin names which will be appended to plugins array
    
    
    the following 3 functions are required to make the editor play nice under a layout widget, see #4070

• dijit.Editor.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Runs on widget initialization to setup arrays etc.

  • tags:

• dijit.Editor.postMixInProperties

  • summary

    Extension to make sure a deferred is in place before certain functions
    execute, like making sure all the plugins are properly inserted.

  • type

    Function

• dijit.Editor.setValueDeferred

  • type

    Object

• dijit.Editor.postCreate

  • type

    Function

• dijit.Editor._steps

  • type

    Array

• dijit.Editor._undoedSteps

  • type

    Array

• dijit.Editor.commands

  • type

    Object

• dijit.Editor.toolbar

  • type

    Object

• dijit.Editor.destroy

  • type

    Function

• dijit.Editor._plugins

  • type

    Array

• dijit.Editor.addPlugin

  • parameters:
    • plugin: (typeof String||Object)

      String, args object or plugin instance
      
      args:
      This object will be passed to the plugin constructor

    • index: (typeof Integer)

      Used when creating an instance from
      something already in this.plugins. Ensures that the new
      instance is assigned to this.plugins at that index.

  • summary

    takes a plugin name as a string or a plugin instance and
    adds it to the toolbar and associates it with this editor
    instance. The resulting plugin is added to the Editor's
    plugins array. If index is passed, it's placed in the plugins
    array at that index. No big magic, but a nice helper for
    passing in plugin names via markup.

  • type

    Function

• dijit.Editor.startup

  • summary

    Exists to make Editor work as a child of a layout widget.
    Developers don't need to call this method.

  • tags: console.log('startup',arguments);
  • type

    Function

• dijit.Editor.resize

  • parameters:
    • size
  • summary

    Resize the editor to the specified size, see <code>dijit.layout._LayoutWidget.resize</code>

  • type

    Function

• dijit.Editor.layout

  • summary

    Called from <code>dijit.layout._LayoutWidget.resize</code>.  This shouldn't be called directly

  • tags:
  • type

    Function

• dijit.Editor.editingArea.style.height

  • type

    String

• dijit.Editor.iframe.style.height

  • type

    String

• dijit.Editor._layoutMode

  • type

    Object

• dijit.Editor._onIEMouseDown

  • parameters:
    • e: (typeof Event)
  • summary

    IE only to prevent 2 clicks to focus

  • tags:
  • type

    Function

• dijit.Editor.document.body

• dijit.Editor.document.body.clientWidth

• dijit.Editor.document.body.clientHeight

• dijit.Editor.document.body.clientLeft

• dijit.Editor.document.body.offsetWidth

• dijit.Editor.document.body.offsetHeight

• dijit.Editor.document.body.offsetLeft

• dijit.Editor.onBeforeActivate

  • parameters:
    • e
  • type

    Function

• dijit.Editor.onBeforeDeactivate

  • parameters:
    • e
  • summary

    Called on IE right before focus is lost.   Saves the selected range.

  • tags:
  • type

    Function

• dijit.Editor.customUndo

  • type

    Boolean

  • summary

    Whether we shall use custom undo/redo support instead of the native
    browser support. By default, we now use custom undo.  It works better
    than native browser support and provides a consistent behavior across
    browsers with a minimal performance hit.  We already had the hit on
    the slowest browser, IE, anyway.

• dijit.Editor.editActionInterval

  • type

    Integer

  • summary

    When using customUndo, not every keystroke will be saved as a step.
    Instead typing (including delete) will be grouped together: after
    a user stops typing for editActionInterval seconds, a step will be
    saved; if a user resume typing within editActionInterval seconds,
    the timeout will be restarted. By default, editActionInterval is 3
    seconds.

• dijit.Editor.beginEditing

  • parameters:
    • cmd
  • summary

    Called to note that the user has started typing alphanumeric characters, if it's not already noted.
    Deals with saving undo; see editActionInterval parameter.

  • tags:
  • type

    Function

• dijit.Editor._inEditing

  • type

    bool

• dijit.Editor._editTimer

  • type

    Object

• dijit.Editor.execCommand

  • parameters:
    • cmd
  • summary

    Main handler for executing any commands to the editor, like paste, bold, etc.
    Called by plugins, but not meant to be called by end users.

  • tags:
  • type

    Function

• dijit.Editor.queryCommandEnabled

  • parameters:
    • cmd
  • summary

    Returns true if specified editor command is enabled.
    Used by the plugins to know when to highlight/not highlight buttons.

  • tags:
  • type

    Function

• dijit.Editor._moveToBookmark

  • parameters:
    • b
  • summary

    Selects the text specified in bookmark b

  • tags:
  • type

    Function

• dijit.Editor._changeToStep

  • parameters:
    • from
    • to
  • summary

    Reverts editor to "to" setting, from the undo stack.

  • tags:
  • type

    Function

• dijit.Editor.undo

  • summary

    Handler for editor undo (ex: ctrl-z) operation

  • tags: console.log('undo');
  • type

    Function

• dijit.Editor._undoRedoActive

  • type

    Object

• dijit.Editor.redo

  • summary

    Handler for editor redo (ex: ctrl-y) operation

  • tags: console.log('redo');
  • type

    Function

• dijit.Editor.endEditing

  • parameters:
    • ignore_caret
  • summary

    Called to note that the user has stopped typing alphanumeric characters, if it's not already noted.
    Deals with saving undo; see editActionInterval parameter.

  • tags:
  • type

    Function

• dijit.Editor._getBookmark

  • summary

    Get the currently selected text

  • tags:
  • type

    Function

• dijit.Editor._beginEditing

  • parameters:
    • cmd
  • summary

    Called when the user starts typing alphanumeric characters.
    Deals with saving undo; see editActionInterval parameter.

  • tags:
  • type

    Function

• dijit.Editor._endEditing

  • parameters:
    • ignore_caret
  • summary

    Called when the user stops typing alphanumeric characters.
    Deals with saving undo; see editActionInterval parameter.

  • tags: Avoid filtering to make sure selections restore.
  • type

    Function

• dijit.Editor.onKeyDown

  • parameters:
    • e
  • summary

    Handler for onkeydown event.

  • tags:
  • type

    Function

• dijit.Editor._onBlur

  • summary

    Called from focus manager when focus has moved away from this editor

  • tags:
  • type

    Function

• dijit.Editor._saveSelection

  • summary

    Save the currently selected text in _savedSelection attribute

  • tags:
  • type

    Function

• dijit.Editor._savedSelection

  • type

    Object

• dijit.Editor._restoreSelection

  • summary

    Re-select the text specified in _savedSelection attribute;
    see _saveSelection().

  • tags:
  • type

    Function

• dijit.Editor.onClick

  • summary

    Handler for when editor is clicked

  • tags:
  • type

    Function

• dijit.Editor.replaceValue

  • parameters:
    • html: (typeof String)
  • summary

    over-ride of replaceValue to support custom undo and stack maintainence.

  • tags:
  • type

    Function

• dijit.Editor._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)
  • type

    Function

• dijit.Editor._setStateClass

  • type

    Function

• dijit.Editor._editInterval

  • type

    Number

• dijit._editor._Plugin

  • alias - dijit._editor._Plugin

• dijit

  • type

    Object