Changeset 13181

Timestamp:

03/24/08 03:19:13 (8 months ago)

Author:

alex

Message:

update docs and default behavior for dijit.Form and dojo.attr to make it crystal clear that unified Dojo event handling is in play when using event handlers specified by dojo.attr() and that browser-specific hacks may no longer work as expected. Fixes #6280. !strict

Files:

• dijit/trunk/form/Form.js (modified) (2 diffs)
• dijit/trunk/tests/form/test_Form_onsubmit.html (added)
• dojo/trunk/_base/html.js (modified) (2 diffs)

dijit/trunk/form/Form.js

@@ -346 +346 @@
                 },
                 
-                onSubmit: function(){ 
+                onSubmit: function(/*Event?*/e){ 
                         //      summary:
                         //              Callback when user submits the form. This method is
@@ -354 +354 @@
                         //              `onSubmit` is used to compute whether or not submission
                         //              should proceed
-                        return this.isValid(); // Boolean
+
+                        if(!this.isValid()){
+                                if(e){ dojo.stopEvent(e); }
+                                return false; // Boolean
+                        }
+                        return true; // Boolean
                 },
 

dojo/trunk/_base/html.js

@@ -1043 +1043 @@
                 //              If a third argument is passed, or if the second argumnt is a
                 //              map of attributes, acts as a setter.
+                //
+                //              When passing functions as values, note that they will not be
+                //              directly assigned to slots on the node, but rather the default
+                //              behavior will be removed and the new behavior will be added
+                //              using `dojo.connect()`, meaning that event handler properties
+                //              will be normalized and that some caveats with regards to
+                //              non-standard behaviors for onsubmit apply. Namely that you
+                //              should cancel form submission using `dojo.stopEvent()` on the
+                //              passed event object instead of returning a boolean value from
+                //              the handler itself.
                 //      node:
                 //              id or reference to the element to get or set the attribute on
@@ -1071 +1081 @@
                 //      |               "method": "POST",
                 //      |               "onsubmit": function(e){
+                //      |                       // stop submitting the form. Note that the IE behavior
+                //      |                       // of returning true or false will have no effect here
+                //      |                       // since our handler is connect()ed to the built-in
+                //      |                       // onsubmit behavior and so we need to use
+                //      |                       // dojo.stopEvent() to ensure that the submission
+                //      |                       // doesn't proceed.
                 //      |                       dojo.stopEvent(e);
+                //      |
                 //      |                       // submit the form with Ajax
                 //      |                       dojo.xhrPost({ form: "formId" });