Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / Element.traversal.html
index df8ae3a..d55893e 100644 (file)
-<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(function(){\r
-       var PARENTNODE = 'parentNode',\r
-               NEXTSIBLING = 'nextSibling',\r
-               PREVIOUSSIBLING = 'previousSibling',\r
-               DQ = Ext.DomQuery,\r
-               GET = Ext.get;\r
-       \r
-       return {\r
-               <div id="method-Ext.Element-findParent"></div>/**\r
-            * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)\r
-            * @param {String} selector The simple selector to test\r
-            * @param {Number/Mixed} maxDepth (optional) The max depth to search as a number or element (defaults to 50 || document.body)\r
-            * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node\r
-            * @return {HTMLElement} The matching DOM node (or null if no match was found)\r
-            */\r
-           findParent : function(simpleSelector, maxDepth, returnEl){\r
-               var p = this.dom,\r
-                       b = document.body, \r
-                       depth = 0,                      \r
-                       stopEl;         \r
-            if(Ext.isGecko && Object.prototype.toString.call(p) == '[object XULElement]') {\r
-                return null;\r
-            }\r
-               maxDepth = maxDepth || 50;\r
-               if (isNaN(maxDepth)) {\r
-                   stopEl = Ext.getDom(maxDepth);\r
-                   maxDepth = Number.MAX_VALUE;\r
-               }\r
-               while(p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl){\r
-                   if(DQ.is(p, simpleSelector)){\r
-                       return returnEl ? GET(p) : p;\r
-                   }\r
-                   depth++;\r
-                   p = p.parentNode;\r
-               }\r
-               return null;\r
-           },\r
-       \r
-           <div id="method-Ext.Element-findParentNode"></div>/**\r
-            * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)\r
-            * @param {String} selector The simple selector to test\r
-            * @param {Number/Mixed} maxDepth (optional) The max depth to\r
-                   search as a number or element (defaults to 10 || document.body)\r
-            * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node\r
-            * @return {HTMLElement} The matching DOM node (or null if no match was found)\r
-            */\r
-           findParentNode : function(simpleSelector, maxDepth, returnEl){\r
-               var p = Ext.fly(this.dom.parentNode, '_internal');\r
-               return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null;\r
-           },\r
-       \r
-           <div id="method-Ext.Element-up"></div>/**\r
-            * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\r
-            * This is a shortcut for findParentNode() that always returns an Ext.Element.\r
-            * @param {String} selector The simple selector to test\r
-            * @param {Number/Mixed} maxDepth (optional) The max depth to\r
-                   search as a number or element (defaults to 10 || document.body)\r
-            * @return {Ext.Element} The matching DOM node (or null if no match was found)\r
-            */\r
-           up : function(simpleSelector, maxDepth){\r
-               return this.findParentNode(simpleSelector, maxDepth, true);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-select"></div>/**\r
-            * Creates a {@link Ext.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).\r
-            * @param {String} selector The CSS selector\r
-            * @param {Boolean} unique (optional) True to create a unique Ext.Element for each child (defaults to false, which creates a single shared flyweight object)\r
-            * @return {CompositeElement/CompositeElementLite} The composite element\r
-            */\r
-           select : function(selector, unique){\r
-               return Ext.Element.select(selector, unique, this.dom);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-query"></div>/**\r
-            * Selects child nodes based on the passed CSS selector (the selector should not contain an id).\r
-            * @param {String} selector The CSS selector\r
-            * @return {Array} An array of the matched nodes\r
-            */\r
-           query : function(selector, unique){\r
-               return DQ.select(selector, this.dom);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-child"></div>/**\r
-            * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).\r
-            * @param {String} selector The CSS selector\r
-            * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.Element (defaults to false)\r
-            * @return {HTMLElement/Ext.Element} The child Ext.Element (or DOM node if returnDom = true)\r
-            */\r
-           child : function(selector, returnDom){\r
-               var n = DQ.selectNode(selector, this.dom);\r
-               return returnDom ? n : GET(n);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-down"></div>/**\r
-            * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).\r
-            * @param {String} selector The CSS selector\r
-            * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.Element (defaults to false)\r
-            * @return {HTMLElement/Ext.Element} The child Ext.Element (or DOM node if returnDom = true)\r
-            */\r
-           down : function(selector, returnDom){\r
-               var n = DQ.selectNode(" > " + selector, this.dom);\r
-               return returnDom ? n : GET(n);\r
-           },\r
-       \r
-                <div id="method-Ext.Element-parent"></div>/**\r
-            * Gets the parent node for this element, optionally chaining up trying to match a selector\r
-            * @param {String} selector (optional) Find a parent node that matches the passed simple selector\r
-            * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element\r
-            * @return {Ext.Element/HTMLElement} The parent node or null\r
-                */\r
-           parent : function(selector, returnDom){\r
-               return this.matchNode(PARENTNODE, PARENTNODE, selector, returnDom);\r
-           },\r
-       \r
-            <div id="method-Ext.Element-next"></div>/**\r
-            * Gets the next sibling, skipping text nodes\r
-            * @param {String} selector (optional) Find the next sibling that matches the passed simple selector\r
-            * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element\r
-            * @return {Ext.Element/HTMLElement} The next sibling or null\r
-                */\r
-           next : function(selector, returnDom){\r
-               return this.matchNode(NEXTSIBLING, NEXTSIBLING, selector, returnDom);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-prev"></div>/**\r
-            * Gets the previous sibling, skipping text nodes\r
-            * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector\r
-            * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element\r
-            * @return {Ext.Element/HTMLElement} The previous sibling or null\r
-                */\r
-           prev : function(selector, returnDom){\r
-               return this.matchNode(PREVIOUSSIBLING, PREVIOUSSIBLING, selector, returnDom);\r
-           },\r
-       \r
-       \r
-           <div id="method-Ext.Element-first"></div>/**\r
-            * Gets the first child, skipping text nodes\r
-            * @param {String} selector (optional) Find the next sibling that matches the passed simple selector\r
-            * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element\r
-            * @return {Ext.Element/HTMLElement} The first child or null\r
-                */\r
-           first : function(selector, returnDom){\r
-               return this.matchNode(NEXTSIBLING, 'firstChild', selector, returnDom);\r
-           },\r
-       \r
-           <div id="method-Ext.Element-last"></div>/**\r
-            * Gets the last child, skipping text nodes\r
-            * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector\r
-            * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element\r
-            * @return {Ext.Element/HTMLElement} The last child or null\r
-                */\r
-           last : function(selector, returnDom){\r
-               return this.matchNode(PREVIOUSSIBLING, 'lastChild', selector, returnDom);\r
-           },\r
-           \r
-           matchNode : function(dir, start, selector, returnDom){\r
-               var n = this.dom[start];\r
-               while(n){\r
-                   if(n.nodeType == 1 && (!selector || DQ.is(n, selector))){\r
-                       return !returnDom ? GET(n) : n;\r
-                   }\r
-                   n = n[dir];\r
-               }\r
-               return null;\r
-           }   \r
-    }\r
-}());</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-Element'>/**
+</span> * @class Ext.Element
+ */
+Ext.Element.addMethods({
+<span id='Ext-Element-method-findParent'>    /**
+</span>     * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
+     * @param {String} selector The simple selector to test
+     * @param {Number/String/HTMLElement/Ext.Element} maxDepth (optional)
+     * The max depth to search as a number or element (defaults to 50 || document.body)
+     * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node
+     * @return {HTMLElement} The matching DOM node (or null if no match was found)
+     */
+    findParent : function(simpleSelector, maxDepth, returnEl) {
+        var p = this.dom,
+            b = document.body,
+            depth = 0,
+            stopEl;
+
+        maxDepth = maxDepth || 50;
+        if (isNaN(maxDepth)) {
+            stopEl = Ext.getDom(maxDepth);
+            maxDepth = Number.MAX_VALUE;
+        }
+        while (p &amp;&amp; p.nodeType == 1 &amp;&amp; depth &lt; maxDepth &amp;&amp; p != b &amp;&amp; p != stopEl) {
+            if (Ext.DomQuery.is(p, simpleSelector)) {
+                return returnEl ? Ext.get(p) : p;
+            }
+            depth++;
+            p = p.parentNode;
+        }
+        return null;
+    },
+
+<span id='Ext-Element-method-findParentNode'>    /**
+</span>     * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
+     * @param {String} selector The simple selector to test
+     * @param {Number/String/HTMLElement/Ext.Element} maxDepth (optional)
+     * The max depth to search as a number or element (defaults to 10 || document.body)
+     * @param {Boolean} returnEl (optional) True to return a Ext.Element object instead of DOM node
+     * @return {HTMLElement} The matching DOM node (or null if no match was found)
+     */
+    findParentNode : function(simpleSelector, maxDepth, returnEl) {
+        var p = Ext.fly(this.dom.parentNode, '_internal');
+        return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null;
+    },
+
+<span id='Ext-Element-method-up'>    /**
+</span>     * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
+     * This is a shortcut for findParentNode() that always returns an Ext.Element.
+     * @param {String} selector The simple selector to test
+     * @param {Number/String/HTMLElement/Ext.Element} maxDepth (optional)
+     * The max depth to search as a number or element (defaults to 10 || document.body)
+     * @return {Ext.Element} The matching DOM node (or null if no match was found)
+     */
+    up : function(simpleSelector, maxDepth) {
+        return this.findParentNode(simpleSelector, maxDepth, true);
+    },
+
+<span id='Ext-Element-method-select'>    /**
+</span>     * Creates a {@link Ext.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).
+     * @param {String} selector The CSS selector
+     * @return {Ext.CompositeElement/Ext.CompositeElement} The composite element
+     */
+    select : function(selector) {
+        return Ext.Element.select(selector, false,  this.dom);
+    },
+
+<span id='Ext-Element-method-query'>    /**
+</span>     * Selects child nodes based on the passed CSS selector (the selector should not contain an id).
+     * @param {String} selector The CSS selector
+     * @return {HTMLElement[]} An array of the matched nodes
+     */
+    query : function(selector) {
+        return Ext.DomQuery.select(selector, this.dom);
+    },
+
+<span id='Ext-Element-method-down'>    /**
+</span>     * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).
+     * @param {String} selector The CSS selector
+     * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.Element (defaults to false)
+     * @return {HTMLElement/Ext.Element} The child Ext.Element (or DOM node if returnDom = true)
+     */
+    down : function(selector, returnDom) {
+        var n = Ext.DomQuery.selectNode(selector, this.dom);
+        return returnDom ? n : Ext.get(n);
+    },
+
+<span id='Ext-Element-method-child'>    /**
+</span>     * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).
+     * @param {String} selector The CSS selector
+     * @param {Boolean} returnDom (optional) True to return the DOM node instead of Ext.Element (defaults to false)
+     * @return {HTMLElement/Ext.Element} The child Ext.Element (or DOM node if returnDom = true)
+     */
+    child : function(selector, returnDom) {
+        var node,
+            me = this,
+            id;
+        id = Ext.get(me).id;
+        // Escape . or :
+        id = id.replace(/[\.:]/g, &quot;\\$0&quot;);
+        node = Ext.DomQuery.selectNode('#' + id + &quot; &gt; &quot; + selector, me.dom);
+        return returnDom ? node : Ext.get(node);
+    },
+
+<span id='Ext-Element-method-parent'>     /**
+</span>     * Gets the parent node for this element, optionally chaining up trying to match a selector
+     * @param {String} selector (optional) Find a parent node that matches the passed simple selector
+     * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element
+     * @return {Ext.Element/HTMLElement} The parent node or null
+     */
+    parent : function(selector, returnDom) {
+        return this.matchNode('parentNode', 'parentNode', selector, returnDom);
+    },
+
+<span id='Ext-Element-method-next'>     /**
+</span>     * Gets the next sibling, skipping text nodes
+     * @param {String} selector (optional) Find the next sibling that matches the passed simple selector
+     * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element
+     * @return {Ext.Element/HTMLElement} The next sibling or null
+     */
+    next : function(selector, returnDom) {
+        return this.matchNode('nextSibling', 'nextSibling', selector, returnDom);
+    },
+
+<span id='Ext-Element-method-prev'>    /**
+</span>     * Gets the previous sibling, skipping text nodes
+     * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector
+     * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element
+     * @return {Ext.Element/HTMLElement} The previous sibling or null
+     */
+    prev : function(selector, returnDom) {
+        return this.matchNode('previousSibling', 'previousSibling', selector, returnDom);
+    },
+
+
+<span id='Ext-Element-method-first'>    /**
+</span>     * Gets the first child, skipping text nodes
+     * @param {String} selector (optional) Find the next sibling that matches the passed simple selector
+     * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element
+     * @return {Ext.Element/HTMLElement} The first child or null
+     */
+    first : function(selector, returnDom) {
+        return this.matchNode('nextSibling', 'firstChild', selector, returnDom);
+    },
+
+<span id='Ext-Element-method-last'>    /**
+</span>     * Gets the last child, skipping text nodes
+     * @param {String} selector (optional) Find the previous sibling that matches the passed simple selector
+     * @param {Boolean} returnDom (optional) True to return a raw dom node instead of an Ext.Element
+     * @return {Ext.Element/HTMLElement} The last child or null
+     */
+    last : function(selector, returnDom) {
+        return this.matchNode('previousSibling', 'lastChild', selector, returnDom);
+    },
+
+    matchNode : function(dir, start, selector, returnDom) {
+        if (!this.dom) {
+            return null;
+        }
+
+        var n = this.dom[start];
+        while (n) {
+            if (n.nodeType == 1 &amp;&amp; (!selector || Ext.DomQuery.is(n, selector))) {
+                return !returnDom ? Ext.get(n) : n;
+            }
+            n = n[dir];
+        }
+        return null;
+    }
+});
+</pre>
+</body>
+</html>