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.
|
|
|
_applyAttributes(
) :
void
Step during widget creation to copy all widget attributes to the
DOM as per attributeMap and _setXXXAttr functions.
Skips over blank/false attribute values, unless they were explicitly specified
as parameters to the widget, since those are the default anyway,
and setting tabIndex="" is different than not setting tabIndex at all.
It processes the attributes in the attribute map first, and then
it goes through and processes the attributes for the _setXXXAttr
functions that have been specified
|
|
|
|
_applyEditingAreaStyleSheets(
) :
void
apply the specified css files in styleSheets
|
|
|
|
_attrToDom(
attr
: String
value
: String
) :
void
Reflect a widget attribute (title, tabIndex, duration etc.) to
the widget DOM, as specified in attributeMap.
Also sets this["attr"] to the new value.
Note some attributes like "type"
cannot be processed this way as they are not mutable.
Parameter |
Type |
Usage |
Description |
attr |
String |
required |
|
value |
String |
required |
|
|
|
|
|
_backcolorImpl(
argument
: arguments
) :
void
This function implements the backcolor command
Parameter |
Type |
Usage |
Description |
argument |
arguments |
required |
to the exec command, if any. |
|
|
|
|
_forecolorImpl(
argument
: arguments
) :
void
This function implements the forecolor command
Parameter |
Type |
Usage |
Description |
argument |
arguments |
required |
to the exec command, if any. |
|
|
|
|
_getAttrNames(
name
) :
void
Helper function for Widget.attr().
Caches attribute name values so we don't do the string ops every time.
Parameter |
Type |
Usage |
Description |
name |
|
required |
|
|
|
|
|
_getIframeDocTxt(
) :
void
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.
|
|
|
|
_getValueAttr(
) :
void
Hook to make attr("value") work
|
|
|
|
_hilitecolorImpl(
argument
: arguments
) :
void
This function implements the hilitecolor command
Parameter |
Type |
Usage |
Description |
argument |
arguments |
required |
to the exec command, if any. |
|
|
|
|
_inserthorizontalruleImpl(
argument
: arguments
) :
void
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
Parameter |
Type |
Usage |
Description |
argument |
arguments |
required |
to the exec command, if any. |
|
|
|
|
_inserthtmlImpl(
argument
: The
) :
void
This function implements the insertion of HTML content into
a point on the page.
Parameter |
Type |
Usage |
Description |
argument |
The |
required |
content to insert, if any. |
|
|
|
|
_localizeEditorCommands(
) :
void
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.
|
|
|
|
_normalizeCommand(
cmd
: String
argument
: Anything
) :
void
Used as the advice function by dojo.connect to map our
normalized set of commands to those supported by the target
browser.
Parameter |
Type |
Usage |
Description |
cmd |
String |
required |
|
argument |
Anything |
optional |
|
|
|
|
|
_normalizeFontStyle(
html
: String
) :
void
Convert <strong> and <em> to <b> and <i>.
Moz can not handle strong/em tags correctly, so to help
mozilla and also to normalize output, convert them to and .
Note the IE generates and rather than and
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
_onBlur(
e
) :
void
Called from focus manager when focus has moved away from this editor
Parameter |
Type |
Usage |
Description |
e |
|
required |
|
|
|
|
|
_onConnect(
event
: String
) :
void
Called when someone connects to one of my handlers.
"Turn on" that handler if it isn't active yet.
This is also called for every single initialization parameter
so need to do nothing for parameters like "id".
Parameter |
Type |
Usage |
Description |
event |
String |
required |
|
|
|
|
|
_onFocus(
e
: Event
) :
void
Called from focus manager when focus has moved into this editor
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
_onIEMouseDown(
e
: Event
) :
void
IE only to prevent 2 clicks to focus
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
_onShow(
) :
void
Internal method called when this widget is made visible.
See onShow for details.
|
|
|
|
_postFilterContent(
dom
: DomNode|DomNode[]|String
nonDestructive
: Boolean
) :
void
filter the output after getting the content of the editing area
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.
Parameter |
Type |
Usage |
Description |
dom |
DomNode|DomNode[]|String |
optional |
a node, set of nodes, which to filter using each of the current
members of the contentDomPostFilters and contentPostFilters arrays. |
nonDestructive |
Boolean |
optional |
defaults to "false". If true, ensures that filtering happens on
a clone of the passed-in content and not the actual node
itself. |
|
|
|
|
_preDomFilterContent(
dom
: DomNode
) :
void
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.
Parameter |
Type |
Usage |
Description |
dom |
DomNode |
required |
|
|
|
|
|
_preFilterContent(
html
: String
) :
void
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.
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
_preFixUrlAttributes(
html
: String
) :
void
Pre-filter to do fixing to href attributes on <a> and <img> tags
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
_queryCommandAvailable(
command
: String
) :
void
See queryCommandAvailable().
Parameter |
Type |
Usage |
Description |
command |
String |
required |
|
|
|
|
|
_removeMozBogus(
html
: String
) :
void
Post filter to remove unwanted HTML attributes generated by mozilla
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
_removeWebkitBogus(
html
: String
) :
void
Post filter to remove unwanted HTML attributes generated by webkit
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
_saveContent(
e
: Event
) :
void
Saves the content in an onunload event if the editor has not been closed
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
_sCall(
name
args
) :
void
Run the named method of dijit._editor.selection over the
current editor instance's window, with the passed args.
Parameter |
Type |
Usage |
Description |
name |
|
required |
|
args |
|
required |
|
|
|
|
|
_setClassAttr(
value
: String
) :
void
Custom setter for the CSS "class" attribute
Parameter |
Type |
Usage |
Description |
value |
String |
required |
|
|
|
|
|
_setDisabledAttr(
value
: Boolean
) :
void
Parameter |
Type |
Usage |
Description |
value |
Boolean |
required |
|
|
|
|
|
_setDisableSpellCheckAttr(
disabled
: Boolean
) :
void
Parameter |
Type |
Usage |
Description |
disabled |
Boolean |
required |
|
|
|
|
|
_setStyleAttr(
value
: String||Object
) :
void
Sets the style attribut of the widget according to value,
Determines which node to set the style on based on style setting
in attributeMap.
Parameter |
Type |
Usage |
Description |
value |
String||Object |
required |
|
|
|
|
|
_setValueAttr(
value
: String
) :
void
Registers that attr("value", foo) should call setValue(foo)
Parameter |
Type |
Usage |
Description |
value |
String |
required |
|
|
|
|
|
_unlinkImpl(
argument
: arguments
) :
void
This function implements the unlink of an <a> tag.
Parameter |
Type |
Usage |
Description |
argument |
arguments |
required |
to the exec command, if any. |
|
|
|
|
addKeyHandler(
key
: String
ctrl
: Boolean
shift
: Boolean
handler
: Function
) :
void
Add a handler for a keyboard shortcut
The key argument should be in lowercase if it is a letter character
Parameter |
Type |
Usage |
Description |
key |
String |
required |
|
ctrl |
Boolean |
required |
|
shift |
Boolean |
required |
|
handler |
Function |
required |
|
|
|
|
|
addStyleSheet(
uri
: dojo._Url
) :
void
add an external stylesheet for the editing area
Parameter |
Type |
Usage |
Description |
uri |
dojo._Url |
required |
A dojo.uri.Uri pointing to the url of the external css file |
|
|
|
|
attr(
name
: String|Object
value
: Object
) :
void
Set or get properties on a widget instance.
Get or set named properties on a widget. If no value is
provided, the current value of the attribute is returned,
potentially via a getter method. If a value is provided, then
the method acts as a setter, assigning the value to the name,
potentially calling any explicitly provided setters to handle
the operation. For instance, if the widget has properties "foo"
Parameter |
Type |
Usage |
Description |
name |
String|Object |
required |
The property to get or set. If an object is passed here and not
a string, its keys are used as names of attributes to be set
and the value of the object as values to set in the widget. |
value |
Object |
optional |
Optional. If provided, attr() operates as a setter. If omitted,
the current value of the named property is returned. |
|
|
|
|
blur(
) :
void
Remove focus from this instance.
|
|
|
|
buildRendering(
) :
void
Construct the UI for this widget, setting this.domNode
Most widgets will mixin `dijit._Templated`, which implements this
method.
|
|
|
|
close(
save
: Boolean
) :
void
Kills the editor and optionally writes back the modified contents to the
element from which it originated.
Parameter |
Type |
Usage |
Description |
save |
Boolean |
required |
Whether or not to save the changes. If false, the changes are discarded. |
|
|
|
|
connect(
obj
: Object|null
event
: String|Function
method
: String|Function
) :
void
Connects specified obj/event to specified method of this object
and registers for disconnect() on widget destroy.
Provide widget-specific analog to dojo.connect, except with the
implicit use of this widget as the target object.
This version of connect also provides a special "ondijitclick"
event which triggers on a click or space or enter keyup
Parameter |
Type |
Usage |
Description |
obj |
Object|null |
required |
|
event |
String|Function |
required |
|
method |
String|Function |
required |
|
Examples
|
|
|
|
constructor(
params
) :
void
dijit._editor.RichText is the core of dijit.Editor, which provides basic
WYSIWYG editing features.
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.
Parameter |
Type |
Usage |
Description |
params |
|
required |
|
|
|
|
|
create(
params
: Object
srcNodeRef
: DomNode|String
) :
void
Kick off the life-cycle of a widget
Create calls a number of widget methods (postMixInProperties, buildRendering, postCreate,
Parameter |
Type |
Usage |
Description |
params |
Object |
optional |
Hash of initialization parameters for widget, including
scalar values (like title, duration etc.) and functions,
typically callbacks like onClick. |
srcNodeRef |
DomNode|String |
optional |
|
|
|
|
|
destroy(
) :
void
Destroy this widget, but not its descendants.
This method will, however, destroy internal widgets such as those used within a template.
|
|
|
|
destroyDescendants(
preserveDom
: Boolean
) :
void
Recursively destroy the children of this widget and their
descendants.
Parameter |
Type |
Usage |
Description |
preserveDom |
Boolean |
optional |
If true, the preserveDom attribute is passed to all descendant
widget's .destroy() method. Not for use with _Templated
widgets. |
|
|
|
|
destroyRecursive(
preserveDom
: Boolean
) :
void
Destroy this widget and its 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 is removed from the manager object.
Parameter |
Type |
Usage |
Description |
preserveDom |
Boolean |
optional |
If true, this method will leave the original DOM structure |
|
|
|
|
destroyRendering(
preserveDom
: Boolean
) :
void
Destroys the DOM nodes associated with this widget
Parameter |
Type |
Usage |
Description |
preserveDom |
Boolean |
optional |
If true, this method will leave the original DOM structure alone |
|
|
|
|
disconnect(
handles
: _Widget.Handle
) :
void
Disconnects handle created by connect .
Also removes handle from this widget's list of connects.
Parameter |
Type |
Usage |
Description |
handles |
_Widget.Handle |
required |
|
|
|
|
|
escapeXml(
str
: String
noSingleQuotes
: Boolean
) :
void
Parameter |
Type |
Usage |
Description |
str |
String |
required |
|
noSingleQuotes |
Boolean |
required |
|
|
|
|
|
execCommand(
command
: String
argument
: An
) :
void
Executes a command in the Rich Text area
Parameter |
Type |
Usage |
Description |
command |
String |
required |
The command to execute |
argument |
An |
required |
optional argument to the command |
|
|
|
|
focus(
) :
void
Move focus to this editor
|
|
|
|
getChildren(
) :
void
Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.
Does not return nested widgets, nor widgets that are part of this widget's template.
|
|
|
|
getDescendants(
) :
void
Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.
This method should generally be avoided as it returns widgets declared in templates, which are
supposed to be internal/hidden, but it's left here for back-compat reasons.
|
|
|
|
getNodeChildrenHtml(
dom
: DomNode
) :
void
Deprecated. Use dijit._editor.getChildrenHtml() instead.
Parameter |
Type |
Usage |
Description |
dom |
DomNode |
required |
|
|
|
|
|
getNodeHtml(
node
: DomNode
) :
void
Deprecated. Use dijit._editor._getNodeHtml() instead.
Parameter |
Type |
Usage |
Description |
node |
DomNode |
required |
|
|
|
|
|
getValue(
nonDestructive
: Boolean
) :
void
Return the current content of the editing area (post filters
are applied). Users should call attr('value') instead.
Parameter |
Type |
Usage |
Description |
nonDestructive |
Boolean |
optional |
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. |
|
|
|
|
isFocusable(
) :
void
Return true if this widget can currently be focused
and false if not
|
|
|
|
isLeftToRight(
) :
void
Checks the page for text direction
|
|
|
|
onBlur(
) :
void
Called when the widget stops being "active" because
focus moved to something outside of it, or the user
clicked somewhere outside of it, or the widget was
hidden.
|
|
|
|
onChange(
newContent
) :
void
This is fired if and only if the editor loses focus and
the content is changed.
Parameter |
Type |
Usage |
Description |
newContent |
|
required |
|
|
|
|
|
onClick(
e
: Event
) :
void
Handler for when the user clicks.
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
onClose(
) :
void
Parameter for children of dijit.layout.StackContainer or subclasses.
Callback if a user tries to close the child. Child will be closed if this function returns true.
|
|
|
|
onDblClick(
event
: mouse
) :
void
Connect to this function to receive notifications of mouse double click events.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onDisplayChanged(
e
: Event
) :
void
This event will be fired everytime the display context
changes and the result needs to be reflected in the UI.
If you don't want to have update too often,
onNormalizedDisplayChanged should be used instead
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
onFocus(
) :
void
Called when the widget becomes "active" because
it or a widget inside of it either has focus, or has recently
been clicked.
|
|
|
|
onHide(
) :
void
Called when another widget becomes the selected pane in a
dijit.layout.TabContainer , dijit.layout.StackContainer ,
dijit.layout.AccordionContainer , etc.
Also called to indicate hide of a dijit.Dialog , dijit.TooltipDialog , or dijit.TitlePane .
|
|
|
|
onKeyDown(
e
: Event
) :
void
Handler for onkeydown event
Parameter |
Type |
Usage |
Description |
e |
Event |
required |
|
|
|
|
|
onKeyPress(
e
) :
void
Handle the various key events
Parameter |
Type |
Usage |
Description |
e |
|
required |
|
|
|
|
|
onKeyPressed(
) :
void
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)
|
|
|
|
onKeyUp(
e
) :
void
Handler for onkeyup event
Parameter |
Type |
Usage |
Description |
e |
|
required |
|
|
|
|
|
onLoad(
html
: String
) :
void
Handler after the iframe finishes loading.
Parameter |
Type |
Usage |
Description |
html |
String |
required |
Editor contents should be set to this value |
|
|
|
|
onMouseDown(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse button is pressed down.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseEnter(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse moves onto this widget.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseLeave(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse moves off of this widget.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseMove(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseOut(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseOver(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onMouseUp(
event
: mouse
) :
void
Connect to this function to receive notifications of when the mouse button is released.
Parameter |
Type |
Usage |
Description |
event |
mouse |
required |
Event |
|
|
|
|
onNormalizedDisplayChanged(
) :
void
This event is fired every updateInterval ms or more
If something needs to happen immediately after a
user change, please use onDisplayChanged instead.
|
|
|
|
onShow(
) :
void
Called when this widget becomes the selected pane in a
dijit.layout.TabContainer , dijit.layout.StackContainer ,
dijit.layout.AccordionContainer , etc.
Also called to indicate display of a dijit.Dialog , dijit.TooltipDialog , or dijit.TitlePane .
|
|
|
|
open(
element
: DomNode
) :
void
Transforms the node referenced in this.domNode into a rich text editing
node.
Sets up the editing area asynchronously. This will result in
the creation and replacement with an
Parameter |
Type |
Usage |
Description |
element |
DomNode |
optional |
|
|
|
|
|
placeAt(
reference
: String|DomNode|_Widget
position
: String|Int
) :
void
Place this widget's domNode reference somewhere in the DOM based
on standard dojo.place conventions, or passing a Widget reference that
contains and addChild member.
A convenience function provided in all _Widgets, providing a simple
shorthand mechanism to put an existing (or newly created) Widget
somewhere in the dom, and allow chaining.
Parameter |
Type |
Usage |
Description |
reference |
String|DomNode|_Widget |
required |
The String id of a domNode, a domNode reference, or a reference to a Widget posessing
an addChild method. |
position |
String|Int |
optional |
If passed a string or domNode reference, the position argument |
Examples
|
|
|
|
placeCursorAtEnd(
) :
void
Place the cursor at the end of the editing area.
|
|
|
|
placeCursorAtStart(
) :
void
Place the cursor at the start of the editing area.
|
|
|
|
postCreate(
) :
void
Processing after the DOM fragment is created
Called after the DOM fragment has been created, but not necessarily
added to the document. Do not include any operations which rely on
node dimensions or placement.
|
|
|
|
postMixInProperties(
) :
void
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.
|
|
|
|
postscript(
params
: Object
srcNodeRef
: DomNode|String
) :
void
Kicks off widget instantiation. See create() for details.
Parameter |
Type |
Usage |
Description |
params |
Object |
optional |
|
srcNodeRef |
DomNode|String |
required |
|
|
|
|
|
queryCommandAvailable(
command
: String
) :
void
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.
Parameter |
Type |
Usage |
Description |
command |
String |
required |
The command to test for |
|
|
|
|
queryCommandEnabled(
command
: String
) :
void
Check whether a command is enabled or not.
Parameter |
Type |
Usage |
Description |
command |
String |
required |
|
|
|
|
|
queryCommandState(
command
) :
void
Check the state of a given command and returns true or false.
Parameter |
Type |
Usage |
Description |
command |
|
required |
|
|
|
|
|
queryCommandValue(
command
) :
void
Check the value of a given command. This matters most for
custom selections and complex values like font value setting.
Parameter |
Type |
Usage |
Description |
command |
|
required |
|
|
|
|
|
removeStyleSheet(
uri
: dojo._Url
) :
void
remove an external stylesheet for the editing area
Parameter |
Type |
Usage |
Description |
uri |
dojo._Url |
required |
|
|
|
|
|
replaceValue(
html
: String
) :
void
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)
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
setAttribute(
attr
: String
value
: anything
) :
void
Deprecated. Use attr() instead.
Parameter |
Type |
Usage |
Description |
attr |
String |
required |
|
value |
anything |
required |
|
|
|
|
|
setDisabled(
disabled
: Boolean
) :
void
Deprecated, use attr('disabled', ...) instead.
Parameter |
Type |
Usage |
Description |
disabled |
Boolean |
required |
|
|
|
|
|
setupDefaultShortcuts(
) :
void
Add some default key handlers
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.
|
|
|
|
setValue(
html
: String
) :
void
This function sets the content. No undo history is preserved.
Users should use attr('value', ...) instead.
Parameter |
Type |
Usage |
Description |
html |
String |
required |
|
|
|
|
|
startup(
) :
void
Processing after the DOM fragment is added to the document
Called after a widget and its children have been created and added to the page,
and all related widgets have finished their create() cycle, up through postCreate().
This is useful for composite widgets that need to control or layout sub-widgets.
Many layout widgets can use this as a wiring phase.
|
|
|
|
subscribe(
topic
: String
method
: String|Function
) :
void
Subscribes to the specified topic and calls the specified method
of this object and registers for unsubscribe() on widget destroy.
Provide widget-specific analog to dojo.subscribe, except with the
implicit use of this widget as the target object.
Parameter |
Type |
Usage |
Description |
topic |
String |
required |
|
method |
String|Function |
required |
|
Examples
|
|
|
|
toString(
) :
void
Returns a string that represents the widget
When a widget is cast to a string, this method will be used to generate the
output. Currently, it does not implement any sort of reversible
serialization.
|
|
|
|
uninitialize(
) :
void
Stub function. Override to implement custom widget tear-down
behavior.
|
|
|
|
unsubscribe(
handle
: Object
) :
void
Unsubscribes handle created by this.subscribe.
Also removes handle from this widget's list of subscriptions
Parameter |
Type |
Usage |
Description |
handle |
Object |
required |
|
|
|
|
|
__overflow : Object
|
|
|
|
_attrPairNames : shared
Initial value{}
Detailsbetween all widgets
|
|
|
|
_beingDestroyed : Object
|
|
|
|
_blankGif : String
DetailsPath to a blank 1x1 image.
Used by <img> nodes in templates that really get their image via CSS background-image.
|
|
|
|
_connects : Array
|
|
|
|
_content : String
Detailstemporary content storage
|
|
|
|
_created : Object
|
|
|
|
_cursorToStart : Object
|
|
|
|
_deferredConnects : Object
Initial value{onClick : "", onDblClick : "", onKeyDown : "", onKeyPress : "", onKeyUp : "", onMouseMove : "", onMouseDown : "", onMouseOut : "", onMouseOver : "", onMouseLeave : "", onMouseEnter : "", onMouseUp : "", }
DetailsattributeMap addendum for event handlers that should be connected only on first use
|
|
|
|
_destroyed : Object
|
|
|
|
_disabledOK : Object
|
|
|
|
_editorCommandsLocalized : Object
|
|
|
|
_iframeRegHandle : Object
|
|
|
|
_iframeSrc : Object
|
|
|
|
_local2NativeFormatNames : Object
|
|
|
|
_mozSettingProps : Object
Initial value{styleWithCSS : ""}
|
|
|
|
_native2LocalFormatNames : Object
|
|
|
|
_oldHeight :
|
|
|
|
_oldWidth :
|
|
|
|
_onKeyHitch : Object
|
|
|
|
_qcaCache : Object
|
|
|
|
_SEPARATOR : String
Initial value@@**%%__RICHTEXTBOUNDRY__%%**@@
DetailsUsed to concat contents from multiple editors into a single string,
so they can be saved into a single <textarea> node. See "name" attribute.
|
|
|
|
_started : Boolean
Detailsstartup() has completed.
|
|
|
|
_subscribes : Array
|
|
|
|
_updateHandler : Object
|
|
|
|
_updateTimer : Object
|
|
|
|
_webkitListener : Object
|
|
|
|
attributeMap : Object
Initial value{id : "", dir : "", lang : "", class : "", style : "", title : "", }
DetailsattributeMap sets up a "binding" between attributes (aka properties)
of the widget and the widget's DOM.
Changes to widget attributes listed in attributeMap will be
reflected into the DOM.
For example, calling attr('title', 'hello')
on a TitlePane will automatically cause the TitlePane's DOM to update
with the new title.
attributeMap is a hash where the key is an attribute of the widget,
|
|
|
|
captureEvents : String[]
Initial value[]
DetailsEvents which should be connected to the underlying editing
area, events in this array will be addListener with
capture=true.
|
|
|
|
class : String
DetailsHTML class attribute
|
|
|
|
closable : Boolean
DetailsParameter for children of dijit.layout.StackContainer or subclasses.
True if user can close (destroy) this child, such as (for example) clicking the X on the tab.
|
|
|
|
containerNode : DomNode
Initial valuenull
DetailsDesignates where children of the source DOM node will be placed.
"Children" in this case refers to both DOM nodes and widgets.
|
|
|
|
contentPreFilters : Function(String)[]
DetailsPre content filter function register array.
these filters will be executed before the actual
editing area gets the html content.
|
|
|
|
dir : String
DetailsUnsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the
entire document.
|
|
|
|
disabled : Boolean
DetailsThe editor is disabled; the text cannot be changed.
|
|
|
|
disableSpellCheck : Boolean
DetailsWhen true, disables the browser's native spell checking, if supported.
Works only in Firefox.
|
|
|
|
dojoAttachEvent : String
|
|
|
|
dojoAttachPoint : String
|
|
|
|
domNode : Object
DetailsThis is our visible representation of the widget! Other DOM
Nodes may by assigned to other properties, usually through the
template system's dojoAttachPoint syntax, but the domNode
property is the canonical "top level" node in widget UI.
|
|
|
|
editingArea : Object
|
|
|
|
editingAreaStyleSheets : Array
|
|
|
|
editorObject : Object
|
|
|
|
events : String[]
Initial value["onKeyPress", "onKeyDown", "onKeyUp", "onClick"]
Detailsevents which should be connected to the underlying editing area
|
|
|
|
focusNode :
|
|
|
|
focusOnLoad : Boolean
DetailsFocus into this widget when the page is loaded
|
|
|
|
height : String
Initial value300px
DetailsSet 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%".
|
|
|
|
iconClass : String
DetailsParameter for children of dijit.layout.StackContainer or subclasses.
CSS Class specifying icon to use in label associated with this pane.
|
|
|
|
id : String
DetailsA 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.
|
|
|
|
iframe : Object
|
|
|
|
inheritWidth : Boolean
Detailswhether to inherit the parent's width or simply use 100%
|
|
|
|
isClosed : Boolean
|
|
|
|
isLoaded : Boolean
|
|
|
|
isTabIndent : Boolean
DetailsMake tab key and shift-tab indent and outdent rather than navigating.
|
|
|
|
lang : String
DetailsRarely used. Overrides the default Dojo locale used to render this widget,
|
|
|
|
layoutAlign : String
Details"none", "left", "right", "bottom", "top", and "client".
See the LayoutContainer description for details on this parameter.
|
|
|
|
maxSize : Number
DetailsParameter for children of dijit.layout.BorderContainer .
Specifies a maximum size (in pixels) for this widget when resized by a splitter.
|
|
|
|
minHeight : String
Initial value1em
DetailsThe minimum height that the editor should have.
|
|
|
|
minSize : Number
DetailsParameter for children of dijit.layout.BorderContainer .
Specifies a minimum size (in pixels) for this widget when resized by a splitter.
|
|
|
|
name : String
DetailsSpecifies 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.
|
|
|
|
nodesWithKeyClick : String[]
Initial value["input", "button"]
DetailsList of nodes that correctly handle click events via native browser support,
and don't need dijit's help
|
|
|
|
onLoadDeferred : dojo.Deferred
Initial valuenull
DetailsDeferred which is fired when the editor finishes loading
|
|
|
|
params :
|
|
|
|
region : String
DetailsParameter for children of dijit.layout.BorderContainer .
|
|
|
|
savedContent :
|
|
|
|
selected : Boolean
DetailsParameter for children of dijit.layout.StackContainer or subclasses.
Specifies that this widget should be the initially displayed pane.
|
|
|
|
showTitle : Boolean
DetailsParameter for children of dijit.layout.StackContainer or subclasses.
When true, display title of this widget as tab label etc., rather than just using
icon specified in iconClass
|
|
|
|
sizeMin : Integer
DetailsDeprecated. Parameter for children of dijit.layout.SplitContainer .
Minimum size (width or height) of a child of a SplitContainer.
The value is relative to other children's sizeShare properties.
|
|
|
|
sizeShare : Integer
DetailsDeprecated. Parameter for children of dijit.layout.SplitContainer .
Size (width or height) of a child of a SplitContainer.
The value is relative to other children's sizeShare properties.
For example, if there are two children and each has sizeShare=10, then
each takes up 50% of the available space.
|
|
|
|
splitter : Boolean
DetailsParameter for child of dijit.layout.BorderContainer where region != "center".
If true, enables user to resize the widget by putting a draggable splitter between
this widget and the region=center widget.
|
|
|
|
srcNodeRef : DomNode
Initial valuenull
Detailspointer to original DOM node
|
|
|
|
style : String||Object
DetailsHTML style attributes as cssText string or name/value hash
|
|
|
|
styleSheets : String
Detailssemicolon (";") separated list of css files for the editing area
|
|
|
|
tabStop : Object
|
|
|
|
textarea :
|
|
|
|
title : String
DetailsHTML title attribute.
For form widgets this specifies a tooltip to display when hovering over
the widget (just like the native HTML title attribute).
For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer,
etc., it's used to specify the tab label, accordion pane title, etc.
|
|
|
|
tooltip : String
DetailsWhen this widget's title attribute is used to for a tab label, accordion pane title, etc.,
this specifies the tooltip to appear when the mouse is hovered over that text.
|
|
|
|
updateInterval : Number
|
|
|
|
waiRole : String
|
|
|
|
waiState : String
|