Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / Element-more.html
diff --git a/docs/source/Element-more.html b/docs/source/Element-more.html
new file mode 100644 (file)
index 0000000..8ece256
--- /dev/null
@@ -0,0 +1,195 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js">/**\r
+ * @class Ext.Element\r
+ */\r
+Ext.Element.addMethods({    \r
+    <div id="method-Ext.Element-swallowEvent"></div>/**\r
+     * Stops the specified event(s) from bubbling and optionally prevents the default action\r
+     * @param {String/Array} eventName an event / array of events to stop from bubbling\r
+     * @param {Boolean} preventDefault (optional) true to prevent the default action too\r
+     * @return {Ext.Element} this\r
+     */\r
+    swallowEvent : function(eventName, preventDefault){\r
+           var me = this;\r
+        function fn(e){\r
+            e.stopPropagation();\r
+            if(preventDefault){\r
+                e.preventDefault();\r
+            }\r
+        }\r
+        if(Ext.isArray(eventName)){            \r
+               Ext.each(eventName, function(e) {\r
+                 me.on(e, fn);\r
+            });\r
+            return me;\r
+        }\r
+        me.on(eventName, fn);\r
+        return me;\r
+    },\r
+    \r
+    <div id="method-Ext.Element-relayEvent"></div>/**\r
+     * Create an event handler on this element such that when the event fires and is handled by this element,\r
+     * it will be relayed to another object (i.e., fired again as if it originated from that object instead).\r
+     * @param {String} eventName The type of event to relay\r
+     * @param {Object} object Any object that extends {@link Ext.util.Observable} that will provide the context\r
+     * for firing the relayed event\r
+     */\r
+    relayEvent : function(eventName, observable){\r
+        this.on(eventName, function(e){\r
+            observable.fireEvent(eventName, e);\r
+        });\r
+    },\r
+    \r
+       <div id="method-Ext.Element-clean"></div>/**\r
+     * Removes worthless text nodes\r
+     * @param {Boolean} forceReclean (optional) By default the element\r
+     * keeps track if it has been cleaned already so\r
+     * you can call this over and over. However, if you update the element and\r
+     * need to force a reclean, you can pass true.\r
+     */\r
+    clean : function(forceReclean){\r
+        var me = this, \r
+            dom = me.dom,\r
+               n = dom.firstChild, \r
+               ni = -1;\r
+               \r
+           if(Ext.Element.data(dom, 'isCleaned') && forceReclean !== true){\r
+            return me;\r
+        }      \r
+               \r
+           while(n){\r
+               var nx = n.nextSibling;\r
+            if(n.nodeType == 3 && !/\S/.test(n.nodeValue)){\r
+                dom.removeChild(n);\r
+            }else{\r
+                n.nodeIndex = ++ni;\r
+            }\r
+               n = nx;\r
+           }\r
+        Ext.Element.data(dom, 'isCleaned', true);\r
+           return me;\r
+       },\r
+    \r
+    <div id="method-Ext.Element-load"></div>/**\r
+     * Direct access to the Updater {@link Ext.Updater#update} method. The method takes the same object\r
+     * parameter as {@link Ext.Updater#update}\r
+     * @return {Ext.Element} this\r
+     */\r
+    load : function(){\r
+        var um = this.getUpdater();\r
+        um.update.apply(um, arguments);\r
+        return this;\r
+    },\r
+\r
+    <div id="method-Ext.Element-getUpdater"></div>/**\r
+    * Gets this element's {@link Ext.Updater Updater}\r
+    * @return {Ext.Updater} The Updater\r
+    */\r
+    getUpdater : function(){\r
+        return this.updateManager || (this.updateManager = new Ext.Updater(this));\r
+    },\r
+    \r
+       <div id="method-Ext.Element-update"></div>/**\r
+    * Update the innerHTML of this element, optionally searching for and processing scripts\r
+    * @param {String} html The new HTML\r
+    * @param {Boolean} loadScripts (optional) True to look for and process scripts (defaults to false)\r
+    * @param {Function} callback (optional) For async script loading you can be notified when the update completes\r
+    * @return {Ext.Element} this\r
+     */\r
+    update : function(html, loadScripts, callback){\r
+        html = html || "";\r
+           \r
+        if(loadScripts !== true){\r
+            this.dom.innerHTML = html;\r
+            if(Ext.isFunction(callback)){\r
+                callback();\r
+            }\r
+            return this;\r
+        }\r
+        \r
+        var id = Ext.id(),\r
+               dom = this.dom;\r
+\r
+        html += '<span id="' + id + '"></span>';\r
+\r
+        Ext.lib.Event.onAvailable(id, function(){\r
+            var DOC = document,\r
+                hd = DOC.getElementsByTagName("head")[0],\r
+               re = /(?:<script([^>]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig,\r
+               srcRe = /\ssrc=([\'\"])(.*?)\1/i,\r
+               typeRe = /\stype=([\'\"])(.*?)\1/i,\r
+               match,\r
+               attrs,\r
+               srcMatch,\r
+               typeMatch,\r
+               el,\r
+               s;\r
+\r
+            while((match = re.exec(html))){\r
+                attrs = match[1];\r
+                srcMatch = attrs ? attrs.match(srcRe) : false;\r
+                if(srcMatch && srcMatch[2]){\r
+                   s = DOC.createElement("script");\r
+                   s.src = srcMatch[2];\r
+                   typeMatch = attrs.match(typeRe);\r
+                   if(typeMatch && typeMatch[2]){\r
+                       s.type = typeMatch[2];\r
+                   }\r
+                   hd.appendChild(s);\r
+                }else if(match[2] && match[2].length > 0){\r
+                    if(window.execScript) {\r
+                       window.execScript(match[2]);\r
+                    } else {\r
+                       window.eval(match[2]);\r
+                    }\r
+                }\r
+            }\r
+            el = DOC.getElementById(id);\r
+            if(el){Ext.removeNode(el);}\r
+            if(Ext.isFunction(callback)){\r
+                callback();\r
+            }\r
+        });\r
+        dom.innerHTML = html.replace(/(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig, "");\r
+        return this;\r
+    },\r
+    \r
+    <div id="method-Ext.Element-createProxy"></div>/**\r
+     * Creates a proxy element of this element\r
+     * @param {String/Object} config The class name of the proxy element or a DomHelper config object\r
+     * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body)\r
+     * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false)\r
+     * @return {Ext.Element} The new proxy element\r
+     */\r
+    createProxy : function(config, renderTo, matchBox){\r
+        config = Ext.isObject(config) ? config : {tag : "div", cls: config};\r
+\r
+        var me = this,\r
+               proxy = renderTo ? Ext.DomHelper.append(renderTo, config, true) :\r
+                                                  Ext.DomHelper.insertBefore(me.dom, config, true);        \r
+        \r
+        if(matchBox && me.setBox && me.getBox){ // check to make sure Element.position.js is loaded\r
+           proxy.setBox(me.getBox());\r
+        }\r
+        return proxy;\r
+    }\r
+});\r
+\r
+Ext.Element.prototype.getUpdateManager = Ext.Element.prototype.getUpdater;\r
+\r
+// private\r
+Ext.Element.uncache = function(el){\r
+    for(var i = 0, a = arguments, len = a.length; i < len; i++) {\r
+        if(a[i]){\r
+            delete Ext.Element.cache[a[i].id || a[i]];\r
+        }\r
+    }\r
+};</pre>    \r
+</body>\r
+</html>
\ No newline at end of file