Changeset 13699

Timestamp:

05/12/08 09:16:21 (6 months ago)

Author:

peller

Message:

Deprecate RichText? + TEXTAREA. Refs #2140 !strict Provide console warning and update docs and tests. Note: textarea is still mentioned in the code as a savearea.

Location:

dijit/trunk

Files:

• Editor.js (modified) (2 diffs)
• tests/test_Editor.html (modified) (6 diffs)
• _editor/RichText.js (modified) (4 diffs)

dijit/trunk/Editor.js

@@ -12 +12 @@
         dijit._editor.RichText,
         {
-        // summary: A rich-text Editing widget
+                // summary:
+                //      A rich text Editing widget
+                //
+                // 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.
 
                 // plugins: Array
@@ -85 +95 @@
                         //              array at that index. No big magic, but a nice helper for
                         //              passing in plugin names via markup.
-                        //      plugin: String, args object or plugin instance. Required.
-                        //      args: This object will be passed to the plugin constructor.
-                        //      index:  
-                        //              Integer, optional. Used when creating an instance from
+                        //
+                        //      plugin: String, args object or plugin instance
+                        //
+                        //      args: This object will be passed to the plugin constructor
+                        //
+                        //      index: 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.

dijit/trunk/tests/test_Editor.html

@@ -81 +81 @@
         <button onclick="console.log(dijit.byId('editor1').getValue().length)">getValue</button>
         <hr/>
-        
-        <h2>Created from textarea,auto-expanding</h2>
+
+        <h2>Created from div, auto-expanding</h2>
         <div style="border: 1px dotted black;">
-                <h3><label for="thud">thud - from textarea</label></h3>
-                <textarea dojoType="dijit.Editor" height=""
+                <h3><label for="thud">thud - from div</label></h3>
+                <div dojoType="dijit.Editor" height=""
                         onChange="console.log('thud onChange handler: ' + arguments[0])"
                         extraPlugins="['dijit._editor.plugins.AlwaysShowToolbar']"
                         styleSheets="../../dojo/resources/dojo.css" id="thud">
                         <p>
-                                This editor is created from a textarea with AlwaysShowToolbar plugin (do not forget to set height="").
+                                This editor is created from a div with AlwaysShowToolbar plugin (do not forget to set height="").
                         </p>
                         <p>
@@ -101 +101 @@
                         </p>
                         The following HTML should appear as source: &lt;INPUT TYPE="IMAGE" SRC="javascript:alert('no scripting attacks')"&gt;
-                </textarea>
+                </div>
                 <h3>..after</h3>
         </div>
@@ -109 +109 @@
         <div style="border: 1px dotted black;">
                 <h3><label for="blah">blah entry</label></h3>
-                <textarea dojoType="dijit.Editor"
+                <div dojoType="dijit.Editor"
                         plugins="['bold','italic','|','createLink','foreColor','hiliteColor',{name:'dijit._editor.plugins.FontChoice', command:'fontName', generic:true},'fontSize','formatBlock','insertImage']"
                         styleSheets="../../dojo/resources/dojo.css" id="blah">
@@ -126 +126 @@
                         <span style="font-family: fantasy">This is fantasy.</span>
                         <br>
-                </textarea>
+                </div>
                 <h3>..after</h3>
                 <button onclick="alert(dijit.byId('blah').getValue());">getValue</button>
@@ -135 +135 @@
         <div style="border: 1px dotted black;">
                 <h3><label for="blah2">Another blah entry</label></h3>
-                <textarea dojoType="dijit.Editor"
+                <div dojoType="dijit.Editor"
                         plugins="['bold','italic','|',{name:'dijit._editor.plugins.EnterKeyHandling'},{name:'dijit._editor.plugins.FontChoice', command:'fontName', custom:['Verdana','Myriad','Garamond','Apple Chancery','Hiragino Mincho Pro']}, {name:'dijit._editor.plugins.FontChoice', command:'fontSize', custom:[3,4,5]}]"
                         styleSheets="../../dojo/resources/dojo.css" id="blah2">
@@ -143 +143 @@
                                 <li>specify options for a plugin (see the last item in the plugins array)</li>
                         </ol>
-                </textarea>
+                </div>
                 <h3>..after</h3>
         </div>

dijit/trunk/_editor/RichText.js

@@ -231 +231 @@
                                         }
                                         if(!this.document.body){
-                                                throw 'Error';
+                                                throw 'Error'; //FIXME.  A bit more info, if this code stays.
                                         }
                                 }catch(e){
@@ -358 +358 @@
 
 dojo.declare("dijit._editor.RichText", dijit._Widget, {
-        constructor: function(paras){
-                // summary:
-                //              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
+        constructor: function(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.
                 //
                 // contentPreFilters: Array
@@ -406 +413 @@
                 this.onLoadDeferred = new dojo.Deferred();
 
-                //in this constructor, mixin properties are not yet merged, so we have to check for paras here
-                this.useIframe = (dojo.isFF && (dojo.isFF < 3)) || paras['useIframe'] || paras['styleSheets'];
+                //in this constructor, mixin properties are not yet merged, so we have to check for params here
+                this.useIframe = (dojo.isFF && (dojo.isFF < 3)) || params['useIframe'] || params['styleSheets'];
 
                 if(this.useIframe){
@@ -464 +471 @@
 
         postCreate: function(){
-                // summary: init
+                if("textarea" == this.domNode.tagName.toLowerCase()){
+                        console.warn("RichText should not be used with the TEXTAREA tag.  See dijit._editor.RichText docs.");
+                }
                 dojo.publish(dijit._scopeName + "._editor.RichText::init", [this]);
                 this.open();