dijit._editor.RichText
dojo.require("dijit._editor.RichText");
defined in dijit/_editor/RichText.js
dijit._editor.RichText is the core of the WYSIWYG editor in dojo, which provides the basic editing features. It also encapsulates the differences of different js engines for various browsers
Usage
function () (view source)

ConstructorsBack to top

handler after the content of the document finishes loading

FunctionsBack to top
add a handler for a keyboard shortcut
add an external stylesheet for the editing area

remove focus from this instance
Defined by dijit._Widget
Construct the UI for this widget, setting this.domNode. Most widgets will mixin TemplatedWidget, which overrides this method.
Kills the editor and optionally writes back the modified contents to the element from which it originated.
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Defined by dijit._Widget
Kick off the life-cycle of a widget
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Executes a command in the Rich Text area

move focus to this instance
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
return the current content of the editing area (post filters are applied)
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support

Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.

this is fired if and only if the editor loses focus and the content is changed


Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
This event will be fired everytime the display context changes and the result needs to be reflected in the UI.

Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.

Fired on keydown

Fired on keypress


Fired on keyup
This event is fired every updateInterval ms or more
Transforms the node referenced in this.domNode into a rich text editing node. This will result in the creation and replacement with an <iframe> if designMode(FF)/contentEditable(IE) is used.
place the cursor at the end of the editing area
place the cursor at the start of the editing area
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Defined by dijit._Widget
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.
check whether a command is enabled or not

check the state of a given command

check the value of a given command
remove an external stylesheet for the editing area
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)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
add some default key handlers

Defined by dijit._Widget
Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.

Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
apply the specified css files in styleSheets
Draws an iFrame using the existing one if one exists. Used by Mozilla, Safari, and Opera
Moz can not handle strong/em tags correctly, convert them to b/i
Used as the advice function by dojo.connect to map our normalized set of commands to those supported by the target browser

Overrides dijit._Widget

filter the output after getting the content of the editing area
filter the input
filter the input before setting the content of the editing area

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

PropertiesBack to top
Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
Defined by dijit._Widget
pre content filter function register array. these filters will be executed before the actual editing area get the html content
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
Defined by dijit._Widget
Defined by dijit._Widget
Overrides dijit._Widget
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
should be connected to the underlying editing area, events in this array will be addListener with capture=true
whether focusing into this instance of richtext when page onload
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=""
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
whether to inherit the parent's width or simply use 100%
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Defined by dijit._Widget
Defined by dijit._Widget
The minimum height that the editor should have
Defined by dijit._Widget
If a save name is specified the content is saved and restored when the user leave this page can come back, or if the editor is not properly closed after editing has started.
Defined by dijit._Widget
deferred which is fired when the editor finishes loading
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
semicolon (";") separated list of css files for the editing area
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Widget
temporary content storage
Defined by dijit._Widget
used to concat contents from multiple textareas into a single string
Defined by dijit._Widget