Changeset 13682 for dojo/trunk

Timestamp:

05/10/08 17:29:47 (2 months ago)

Author:

jburke

Message:

Fixes #6727. Support a djConfig.addOnLoad option. Also updated API docs for djConfig.

Location:

dojo/trunk

Files:

• tests/_base/_loader/afterOnLoad.html (modified) (3 diffs)
• _base/_loader/bootstrap.js (modified) (1 diff)
• _base/_loader/loader.js (modified) (1 diff)

dojo/trunk/tests/_base/_loader/afterOnLoad.html

@@ -10 +10 @@
 
                 <script type="text/javascript">
-                        window.onload = function(){
+                        function init(){
                                 //Create global djConfig object first. We cannot use the djConfig attribute
                                 //on the script tag since it may not be visible in some browsers at the time
@@ -20 +20 @@
                                         parseOnLoad: true,
                                         afterOnLoad:true,
+                                        addOnLoad: function(){
+                                                //This function is registered with
+                                                //dojo.addOnLoad as Dojo is defined after
+                                                //being added to the DOM.
+                                                console.log("djConfig.addOnLoad callback fired OK: dojo.parser.parse is a "
+                                                        + (typeof dojo.parser.parse));
+                                        },
                                         require: [
                                                 'dojo.parser',
@@ -37 +44 @@
                                 console.debug("onChange for id = " + id + ", value: " + newValue);
                         }
+                        
+                        //Register onload init function that will add Dojo to the page.
+                        if(window.addEventListener){
+                                window.addEventListener("load", init, false);
+                        }else{
+                                window.attachEvent("onload", init);
+                        }
+
                 </script>
         </head>

dojo/trunk/_base/_loader/bootstrap.js

@@ -70 +70 @@
         //              modules may be configured via `djConfig.modulePaths`.
         modulePaths: {},
+        // afterOnLoad: Boolean 
+        //              Indicates Dojo was added to the page after the page load. In this case
+        //              Dojo will not wait for the page DOMContentLoad/load events and fire
+        //              its dojo.addOnLoad callbacks after making sure all outstanding
+        //              dojo.required modules have loaded.
+        afterOnLoad: false,
+        // addOnLoad: Function or Array
+        //              Adds a callback via dojo.addOnLoad. Useful when Dojo is added after
+        //              the page loads and djConfig.afterOnLoad is true. Supports the same
+        //              arguments as dojo.addOnLoad. When using a function reference, use
+        //              `djConfig.addOnLoad = function(){};`. For object with function name use
+        //              `djConfig.addOnLoad = [myObject, "functionName"];` and for object with
+        //              function reference use
+        //              `djConfig.addOnLoad = [myObject, function(){}];`
+        addOnLoad: null,
 }
 =====*/

dojo/trunk/_base/_loader/loader.js

@@ -203 +203 @@
                         d._callLoaded();
                 }
+        }
+
+        //Support calling dojo.addOnLoad via djConfig.addOnLoad. Support all the
+        //call permutations of dojo.addOnLoad. Mainly useful when dojo is added
+        //to the page after the page has loaded.
+        var dca = d.config.addOnLoad;
+        if(dca){
+                d.addOnLoad[(dca instanceof Array ? "apply" : "call")](d, dca);
         }