dijit/_editor/RichText.js

• Provides:

  • dijit._editor.RichText

• Requires:

  • dijit._Widget in common
  • dijit._CssStateMixin in common
  • dijit._editor.selection in common
  • dijit._editor.range in common
  • dijit._editor.html in common

• dijit._editor.RichText

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._CssStateMixin.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._CssStateMixin: (call)
  • parameters:
    • params
  • summary

    dijit._editor.RichText is the core of dijit.Editor, which provides basic
    WYSIWYG editing features.

  • description

    dijit._editor.RichText is the core of dijit.Editor, which provides basic
    WYSIWYG editing features. It also encapsulates the differences
    of different js engines for various browsers.  Do not use this widget
    with an HTML <TEXTAREA> tag, since the browser unescapes XML escape characters,
    like <.  This can have unexpected behavior and lead to security issues
    such as scripting attacks.

  • tags:

• dijit._editor.RichText.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • params
  • summary

    dijit._editor.RichText is the core of dijit.Editor, which provides basic
    WYSIWYG editing features.

  • description

    dijit._editor.RichText is the core of dijit.Editor, which provides basic
    WYSIWYG editing features. It also encapsulates the differences
    of different js engines for various browsers.  Do not use this widget
    with an HTML <TEXTAREA> tag, since the browser unescapes XML escape characters,
    like <.  This can have unexpected behavior and lead to security issues
    such as scripting attacks.

  • tags:

• dijit._editor.RichText.baseClass

  • type

    String

• dijit._editor.RichText.inheritWidth

  • type

    Boolean

  • summary

    whether to inherit the parent's width or simply use 100%

• dijit._editor.RichText.focusOnLoad

  • tags:
  • type

    Boolean

  • summary

    Focus into this widget when the page is loaded

• dijit._editor.RichText.name

  • optional
  • type

    String

  • summary

    Specifies the name of a (hidden) <textarea> node on the page that's used to save
    the editor content on page leave.   Used to restore editor contents after navigating
    to a new page and then hitting the back button.

• dijit._editor.RichText.styleSheets

  • tags: const
  • type

    String

  • summary

    semicolon (";") separated list of css files for the editing area

• dijit._editor.RichText.height

  • type

    String

  • summary

    Set height to fix the editor at a specific height, with scrolling.
    By default, this is 300px.  If you want to have the editor always
    resizes to accommodate the content, use AlwaysShowToolbar plugin
    and set height="".  If this editor is used within a layout widget,
    set height="100%".

• dijit._editor.RichText.minHeight

  • type

    String

  • summary

    The minimum height that the editor should have.

• dijit._editor.RichText.isClosed

  • tags:
  • type

    Boolean

• dijit._editor.RichText.isLoaded

  • tags:
  • type

    Boolean

• dijit._editor.RichText._SEPARATOR

  • tags:
  • type

    String

  • summary

    Used to concat contents from multiple editors into a single string,
    so they can be saved into a single <textarea> node.  See "name" attribute.

• dijit._editor.RichText._NAME_CONTENT_SEP

  • tags:
  • type

    String

  • summary

    USed to separate name from content.  Just a colon isn't safe.

• dijit._editor.RichText.onLoadDeferred

  • tags: readonly
  • type

    dojo.Deferred

  • summary

    Deferred which is fired when the editor finishes loading.
    Call myEditor.onLoadDeferred.then(callback) it to be informed
    when the rich-text area initialization is finalized.

• dijit._editor.RichText.isTabIndent

  • type

    Boolean

  • summary

    Make tab key and shift-tab indent and outdent rather than navigating.
    Caution: sing this makes web pages inaccessible to users unable to use a mouse.

• dijit._editor.RichText.disableSpellCheck

  • tags: const
  • type

    Boolean

  • summary

    When true, disables the browser's native spell checking, if supported.
    Works only in Firefox.

• dijit._editor.RichText.postCreate

  • type

    Function

• dijit._editor.RichText.contentPreFilters

  • type

    Function(String)[]

  • summary

    Pre content filter function register array.
    these filters will be executed before the actual
    editing area gets the html content.

• dijit._editor.RichText.contentPostFilters

  • type

    Array

• dijit._editor.RichText.setupDefaultShortcuts

  • summary

    Add some default key handlers

  • description

    Overwrite this to setup your own handlers. The default
    implementation does not use Editor commands, but directly
    executes the builtin commands within the underlying browser
    support.

  • tags:
  • type

    Function

• dijit._editor.RichText.events

  • tags:
  • type

    String[]

  • summary

    events which should be connected to the underlying editing area
    
    
    onClick handled specially

• dijit._editor.RichText.captureEvents

  • tags:
  • type

    String[]

  • summary

    Events which should be connected to the underlying editing
    area, events in this array will be addListener with
    capture=true.
    TODO: looking at the code I don't see any distinction between events and captureEvents,
    so get rid of this for 2.0 if not sooner

• dijit._editor.RichText._editorCommandsLocalized

  • type

    bool

• dijit._editor.RichText._localizeEditorCommands

  • summary

    When IE is running in a non-English locale, the API actually changes,
    so that we have to say (for example) danraku instead of p (for paragraph).
    Handle that here.

  • tags:
  • type

    Function

• dijit._editor.RichText._local2NativeFormatNames

  • type

    Object

• dijit._editor.RichText._native2LocalFormatNames

  • type

    Object

• dijit._editor.RichText.open

  • parameters:
    • element: (typeof DomNode)
  • summary

    Transforms the node referenced in this.domNode into a rich text editing
    node.

  • description

    Sets up the editing area asynchronously. This will result in
    the creation and replacement with an iframe.

  • tags:
  • type

    Function

• dijit._editor.RichText.domNode

  • type

    Object

• dijit._editor.RichText.textarea

• dijit._editor.RichText.reset

  • type

    Function

• dijit._editor.RichText._oldHeight

• dijit._editor.RichText._oldWidth

• dijit._editor.RichText.value

• dijit._editor.RichText.header

  • type

    Object

• dijit._editor.RichText.editingArea

  • type

    Object

• dijit._editor.RichText.footer

  • type

    Object

• dijit._editor.RichText.editorObject

  • type

    Object

• dijit._editor.RichText.iframe

  • type

    Object

• dijit._editor.RichText._iframeSrc

  • type

    Object

• dijit._editor.RichText._getIframeDocTxt

  • summary

    Generates the boilerplate text of the document inside the iframe (ie, <html><head>...</head><body/></html>).
    Editor content (if not blank) should be added afterwards.

  • tags:
  • type

    Function

• dijit._editor.RichText._cursorToStart

  • type

    Object

• dijit._editor.RichText._applyEditingAreaStyleSheets

  • summary

    apply the specified css files in styleSheets

  • tags:
  • type

    Function

• dijit._editor.RichText.editingAreaStyleSheets

  • type

    Array

• dijit._editor.RichText.addStyleSheet

  • parameters:
    • uri: (typeof dojo._Url)

      A dojo.uri.Uri pointing to the url of the external css file

  • summary

    add an external stylesheet for the editing area

  • type

    Function

• dijit._editor.RichText.removeStyleSheet

  • parameters:
    • uri: (typeof dojo._Url)
  • summary

    remove an external stylesheet for the editing area

  • type

    Function

• dijit._editor.RichText.disabled

  • type

    Boolean

  • summary

    The editor is disabled; the text cannot be changed.

• dijit._editor.RichText._mozSettingProps

  • type

    Object

• dijit._editor.RichText._mozSettingProps.styleWithCSS

  • type

    bool

• dijit._editor.RichText._setDisabledAttr

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

    this method requires init to be complete|! _disabledOK

  • type

    Function

• dijit._editor.RichText.editNode.unselectable

  • type

    String

• dijit._editor.RichText.editNode.contentEditable

  • type

    bool

• dijit._editor.RichText.document.designMode

• dijit._editor.RichText._disabledOK

  • type

    Object

• dijit._editor.RichText.onLoad

  • parameters:
    • html: (typeof String)

      Editor contents should be set to this value

  • summary

    Handler after the iframe finishes loading.

  • tags:
  • type

    Function

• dijit._editor.RichText.window.__registeredWindow

  • type

    Object

• dijit._editor.RichText._iframeRegHandle

  • type

    Object

• dijit._editor.RichText.editNode

  • type

    Object

• dijit._editor.RichText.tabStop

  • type

    Object

• dijit._editor.RichText.iframe.onfocus

  • type

    Object

• dijit._editor.RichText.focusNode

• dijit._editor.RichText.editNode.style.zoom

  • type

    Number

• dijit._editor.RichText._webkitListener

  • type

    Object

• dijit._editor.RichText.onKeyDown

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

    Handler for onkeydown event

  • tags:
  • type

    Function

• dijit._editor.RichText.onKeyUp

  • parameters:
    • e
  • summary

    Handler for onkeyup event

  • tags: callback
  • type

    Function

• dijit._editor.RichText.setDisabled

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

    Deprecated, use set('disabled', ...) instead.

  • tags:
  • type

    Function

• dijit._editor.RichText._setValueAttr

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

    Registers that attr("value", foo) should call setValue(foo)

  • type

    Function

• dijit._editor.RichText._setDisableSpellCheckAttr

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

    Function

• dijit._editor.RichText.onKeyPress

  • parameters:
    • e
  • summary

    Handle the various key events

  • tags:
  • type

    Function

• dijit._editor.RichText._onKeyHitch

  • type

    Object

• dijit._editor.RichText.addKeyHandler

  • parameters:
    • key: (typeof String)
    • ctrl: (typeof Boolean)
    • shift: (typeof Boolean)
    • handler: (typeof Function)
  • summary

    Add a handler for a keyboard shortcut

  • description

    The key argument should be in lowercase if it is a letter character

  • tags:
  • type

    Function

• dijit._editor.RichText.onKeyPressed

  • summary

    Handler for after the user has pressed a key, and the display has been updated.
    (Runs on a timer so that it runs after the display is updated)

  • tags:
  • type

    Function

• dijit._editor.RichText.onClick

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

    Handler for when the user clicks.

  • tags:
  • type

    Function

• dijit._editor.RichText._onIEMouseDown

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

    IE only to prevent 2 clicks to focus

  • tags:
  • type

    Function

• dijit._editor.RichText._onBlur

  • parameters:
    • e
  • summary

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

  • tags:
  • type

    Function

• dijit._editor.RichText._onFocus

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

    Called from focus manager when focus has moved into this editor

  • tags:
  • type

    Function

• dijit._editor.RichText.blur

  • summary

    Remove focus from this instance.

  • tags:
  • type

    Function

• dijit._editor.RichText.focus

  • summary

    Move focus to this editor

  • type

    Function

• dijit._editor.RichText.updateInterval

  • type

    Number

• dijit._editor.RichText._updateTimer

  • type

    Object

• dijit._editor.RichText.onDisplayChanged

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

    This event will be fired everytime the display context
    changes and the result needs to be reflected in the UI.

  • description

    If you don't want to have update too often,
    onNormalizedDisplayChanged should be used instead

  • tags:
  • type

    Function

• dijit._editor.RichText._updateHandler

  • type

    Object

• dijit._editor.RichText.onNormalizedDisplayChanged

  • summary

    This event is fired every updateInterval ms or more

  • description

    If something needs to happen immediately after a
    user change, please use onDisplayChanged instead.

  • tags:
  • type

    Function

• dijit._editor.RichText.onChange

  • parameters:
    • newContent
  • summary

    This is fired if and only if the editor loses focus and
    the content is changed.

  • type

    Function

• dijit._editor.RichText._normalizeCommand

  • parameters:
    • cmd: (typeof String)
    • argument: (typeof Anything)
  • summary

    Used as the advice function by dojo.connect to map our
    normalized set of commands to those supported by the target
    browser.

  • tags:
  • type

    Function

• dijit._editor.RichText._qcaCache

  • type

    Object

• dijit._editor.RichText.queryCommandAvailable

  • parameters:
    • command: (typeof String)

      The command to test for

  • summary

    Tests whether a command is supported by the host. Clients
    SHOULD check whether a command is supported before attempting
    to use it, behaviour for unsupported commands is undefined.

  • tags:
  • type

    Function

• dijit._editor.RichText._queryCommandAvailable

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

    See queryCommandAvailable().

  • tags:
  • type

    Function

• dijit._editor.RichText.execCommand

  • parameters:
    • command: (typeof String)

      The command to execute

    • argument: (typeof An)

      optional argument to the command

  • summary

    Executes a command in the Rich Text area

  • tags:
  • type

    Function

• dijit._editor.RichText.queryCommandEnabled

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

    Check whether a command is enabled or not.

  • tags:
  • type

    Function

• dijit._editor.RichText.queryCommandState

  • parameters:
    • command
  • summary

    Check the state of a given command and returns true or false.

  • tags:
  • type

    Function

• dijit._editor.RichText.queryCommandValue

  • parameters:
    • command
  • summary

    Check the value of a given command. This matters most for
    custom selections and complex values like font value setting.

  • tags:
  • type

    Function

• dijit._editor.RichText._sCall

  • parameters:
    • name
    • args
  • summary

    Run the named method of dijit._editor.selection over the
    current editor instance's window, with the passed args.

  • tags:
  • type

    Function

• dijit._editor.RichText.placeCursorAtStart

  • summary

    Place the cursor at the start of the editing area.

  • tags:
  • type

    Function

• dijit._editor.RichText.placeCursorAtEnd

  • summary

    Place the cursor at the end of the editing area.

  • tags:
  • type

    Function

• dijit._editor.RichText.getValue

  • parameters:
    • nonDestructive: (typeof Boolean)

      defaults to false. Should the post-filtering be run over a copy
      of the live DOM? Most users should pass "true" here unless they
      *really* know that none of the installed filters are going to
      mess up the editing session.

  • summary

    Return the current content of the editing area (post filters
    are applied).  Users should call get('value') instead.

  • tags:
  • type

    Function

• dijit._editor.RichText._getValueAttr

  • summary

    Hook to make attr("value") work

  • type

    Function

• dijit._editor.RichText.setValue

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

    This function sets the content. No undo history is preserved.
    Users should use set('value', ...) instead.

  • tags:
  • type

    Function

• dijit._editor.RichText.textarea.value

• dijit._editor.RichText.replaceValue

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

    This function set the content while trying to maintain the undo stack
    (now only works fine with Moz, this is identical to setValue in all
    other browsers)

  • tags:
  • type

    Function

• dijit._editor.RichText._preFilterContent

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

    Filter the input before setting the content of the editing
    area. DOM pre-filtering may happen after this
    string-based filtering takes place but as of 1.2, this is not
    guaranteed for operations such as the inserthtml command.

  • tags:
  • type

    Function

• dijit._editor.RichText._preDomFilterContent

  • parameters:
    • dom: (typeof DomNode)
  • summary

    filter the input's live DOM. All filter operations should be
    considered to be "live" and operating on the DOM that the user
    will be interacting with in their editing session.

  • tags:
  • type

    Function

• dijit._editor.RichText._postFilterContent

  • parameters:
    • dom: (typeof DomNode|DomNode[]|String)

      a node, set of nodes, which to filter using each of the current
      members of the contentDomPostFilters and contentPostFilters arrays.

    • nonDestructive: (typeof Boolean)

      defaults to "false". If true, ensures that filtering happens on
      a clone of the passed-in content and not the actual node
      itself.

  • summary

    filter the output after getting the content of the editing area

  • description

    post-filtering allows plug-ins and users to specify any number
    of transforms over the editor's content, enabling many common
    use-cases such as transforming absolute to relative URLs (and
    vice-versa), ensuring conformance with a particular DTD, etc.
    The filters are registered in the contentDomPostFilters and
    contentPostFilters arrays. Each item in the
    contentDomPostFilters array is a function which takes a DOM
    Node or array of nodes as its only argument and returns the
    same. It is then passed down the chain for further filtering.
    The contentPostFilters array behaves the same way, except each
    member operates on strings. Together, the DOM and string-based
    filtering allow the full range of post-processing that should
    be necessaray to enable even the most agressive of post-editing
    conversions to take place.
    
    If nonDestructive is set to "true", the nodes are cloned before
    filtering proceeds to avoid potentially destructive transforms
    to the content which may still needed to be edited further.
    Once DOM filtering has taken place, the serialized version of
    the DOM which is passed is run through each of the
    contentPostFilters functions.

  • tags:
  • type

    Function

• dijit._editor.RichText._saveContent

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

    Saves the content in an onunload event if the editor has not been closed

  • tags:
  • type

    Function

• dijit._editor.RichText.escapeXml

  • parameters:
    • str: (typeof String)
    • noSingleQuotes: (typeof Boolean)
  • returns

    string

  • summary

    Adds escape sequences for special characters in XML.
    Optionally skips escapes for single quotes

  • tags:
  • type

    Function

• dijit._editor.RichText.getNodeHtml

  • parameters:
    • node: (typeof DomNode)
  • returns

    String

  • summary

    Deprecated.   Use dijit._editor._getNodeHtml() instead.

  • tags:
  • type

    Function

• dijit._editor.RichText.getNodeChildrenHtml

  • parameters:
    • dom: (typeof DomNode)
  • summary

    Deprecated.   Use dijit._editor.getChildrenHtml() instead.

  • tags:
  • type

    Function

• dijit._editor.RichText.close

  • parameters:
    • save: (typeof Boolean)

      Whether or not to save the changes. If false, the changes are discarded.

  • summary

    Kills the editor and optionally writes back the modified contents to the
    element from which it originated.

  • tags:
  • type

    Function

• dijit._editor.RichText.iframe._loadFunc

  • type

    Object

• dijit._editor.RichText.textarea.style

• dijit._editor.RichText.textarea.style.position

  • type

    String

• dijit._editor.RichText.textarea.style.left

  • type

    String

• dijit._editor.RichText.textarea.style.top

  • type

    String

• dijit._editor.RichText.textarea.style.overflow

• dijit._editor.RichText.__overflow

  • type

    Object

• dijit._editor.RichText.domNode.innerHTML

• dijit._editor.RichText.window._frameElement

  • type

    Object

• dijit._editor.RichText.window

  • type

    Object

• dijit._editor.RichText.document

  • type

    Object

• dijit._editor.RichText.destroy

  • type

    Function

• dijit._editor.RichText._removeMozBogus

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

    String

  • summary

    Post filter to remove unwanted HTML attributes generated by mozilla

  • tags:
  • type

    Function

• dijit._editor.RichText._removeWebkitBogus

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

    String

  • summary

    Post filter to remove unwanted HTML attributes generated by webkit

  • tags:
  • type

    Function

• dijit._editor.RichText._normalizeFontStyle

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

    Convert 'strong' and 'em' to 'b' and 'i'.

  • description

    Moz can not handle strong/em tags correctly, so to help
    mozilla and also to normalize output, convert them to 'b' and 'i'.
    
    Note the IE generates 'strong' and 'em' rather than 'b' and 'i'

  • tags:
  • type

    Function

• dijit._editor.RichText._preFixUrlAttributes

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

    Pre-filter to do fixing to href attributes on <a> and <img> tags

  • tags:
  • type

    Function

• dijit._editor.RichText._inserthorizontalruleImpl

  • parameters:
    • argument: (typeof arguments)

      to the exec command, if any.

  • summary

    This function implements the insertion of HTML 'HR' tags.
    into a point on the page.  IE doesn't to it right, so
    we have to use an alternate form

  • tags:
  • type

    Function

• dijit._editor.RichText._unlinkImpl

  • parameters:
    • argument: (typeof arguments)

      to the exec command, if any.

  • summary

    This function implements the unlink of an 'a' tag.

  • tags:
  • type

    Function

• dijit._editor.RichText._hilitecolorImpl

  • parameters:
    • argument: (typeof arguments)

      to the exec command, if any.

  • summary

    This function implements the hilitecolor command

  • tags:
  • type

    Function

• dijit._editor.RichText._backcolorImpl

  • parameters:
    • argument: (typeof arguments)

      to the exec command, if any.

  • summary

    This function implements the backcolor command

  • tags:
  • type

    Function

• dijit._editor.RichText._forecolorImpl

  • parameters:
    • argument: (typeof arguments)

      to the exec command, if any.

  • summary

    This function implements the forecolor command

  • tags:
  • type

    Function

• dijit._editor.RichText._inserthtmlImpl

  • parameters:
    • argument: (typeof The)

      content to insert, if any.

  • summary

    This function implements the insertion of HTML content into
    a point on the page.

  • tags:
  • type

    Function

• dijit._editor.RichText._boldImpl

  • parameters:
    • argument: (typeof Not)

      used, operates by selection.

  • summary

    This function implements an over-ride of the bold command.

  • tags:
  • type

    Function

• dijit._editor.RichText._italicImpl

  • parameters:
    • argument: (typeof Not)

      used, operates by selection.

  • summary

    This function implements an over-ride of the italic command.

  • tags:
  • type

    Function

• dijit._editor.RichText._underlineImpl

  • parameters:
    • argument: (typeof Not)

      used, operates by selection.

  • summary

    This function implements an over-ride of the underline command.

  • tags:
  • type

    Function

• dijit._editor.RichText._strikethroughImpl

  • parameters:
    • argument: (typeof Not)

      used, operates by selection.

  • summary

    This function implements an over-ride of the strikethrough command.

  • tags:
  • type

    Function

• dijit._editor.RichText.getHeaderHeight

  • returns

    Number

  • summary

    A function for obtaining the height of the header node

  • type

    Function

• dijit._editor.RichText.getFooterHeight

  • returns

    Number

  • summary

    A function for obtaining the height of the footer node

  • type

    Function

• dijit._editor.RichText._getNodeChildrenHeight

  • parameters:
    • node: (typeof The)

      node to process the children of;

  • returns

    Number

  • summary

    An internal function for computing the cumulative height of all child nodes of 'node'

  • type

    Function

• dijit._editor.RichText._isNodeEmpty

  • parameters:
    • node: (typeof The)

      node to check.

    • startOffset
  • summary

    Function to test if a node is devoid of real content.

  • tags: private.
  • type

    Function

• dijit._editor.RichText._removeStartingRangeFromRange

  • parameters:
    • node: (typeof The)

      node to remove from the starting range.

    • range: (typeof The)

      range to adapt.

  • summary

    Function to adjust selection range by removing the current
    start node.

  • tags:
  • type

    Function

• dijit._editor.RichText._adaptIESelection

  • summary

    Function to adapt the IE range by removing leading 'newlines'
    Needed to fix issue with bold/italics/underline not working if
    range included leading 'newlines'.
    In IE, if a user starts a selection at the very end of a line,
    then the native browser commands will fail to execute correctly.
    To work around the issue,  we can remove all empty nodes from
    the start of the range selection.

  • type

    Function

• dijit._editor.RichText.contentDomPreFilters

  • type

    Array

• dijit._editor.RichText.contentDomPostFilters

  • type

    Array

• dijit._editor.RichText._keyHandlers

  • type

    Object

• dijit._editor

  • type

    Object

• dijit

  • type

    Object