X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/src/core/src/dom/Element.traversal.js diff --git a/src/core/src/dom/Element.traversal.js b/src/core/src/dom/Element.traversal.js index 312a3bb9..7585f425 100644 --- a/src/core/src/dom/Element.traversal.js +++ b/src/core/src/dom/Element.traversal.js @@ -13,14 +13,15 @@ If you are unsure which license is appropriate for your use, please contact the */ /** - * @class Ext.core.Element + * @class Ext.Element */ -Ext.core.Element.addMethods({ +Ext.Element.addMethods({ /** * 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/Mixed} 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.core.Element object instead of DOM node + * @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) { @@ -43,13 +44,13 @@ Ext.core.Element.addMethods({ } return null; }, - + /** * 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/Mixed} 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.core.Element object instead of DOM node + * @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) { @@ -59,11 +60,11 @@ Ext.core.Element.addMethods({ /** * 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.core.Element. + * This is a shortcut for findParentNode() that always returns an Ext.Element. * @param {String} selector The simple selector to test - * @param {Number/Mixed} maxDepth (optional) The max depth to - search as a number or element (defaults to 10 || document.body) - * @return {Ext.core.Element} The matching DOM node (or null if no match was found) + * @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); @@ -72,16 +73,16 @@ Ext.core.Element.addMethods({ /** * 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 {CompositeElement/CompositeElement} The composite element + * @return {Ext.CompositeElement/Ext.CompositeElement} The composite element */ select : function(selector) { - return Ext.core.Element.select(selector, false, this.dom); + return Ext.Element.select(selector, false, this.dom); }, /** * Selects child nodes based on the passed CSS selector (the selector should not contain an id). * @param {String} selector The CSS selector - * @return {Array} An array of the matched nodes + * @return {HTMLElement[]} An array of the matched nodes */ query : function(selector) { return Ext.DomQuery.select(selector, this.dom); @@ -90,8 +91,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element (defaults to false) - * @return {HTMLElement/Ext.core.Element} The child Ext.core.Element (or DOM node if returnDom = true) + * @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); @@ -101,8 +102,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element (defaults to false) - * @return {HTMLElement/Ext.core.Element} The child Ext.core.Element (or DOM node if returnDom = true) + * @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, @@ -118,8 +119,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element - * @return {Ext.core.Element/HTMLElement} The parent node or null + * @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); @@ -128,8 +129,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element - * @return {Ext.core.Element/HTMLElement} The next sibling or null + * @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); @@ -138,8 +139,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element - * @return {Ext.core.Element/HTMLElement} The previous sibling or null + * @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); @@ -149,8 +150,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element - * @return {Ext.core.Element/HTMLElement} The first child or null + * @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); @@ -159,8 +160,8 @@ Ext.core.Element.addMethods({ /** * 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.core.Element - * @return {Ext.core.Element/HTMLElement} The last child or null + * @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); @@ -170,7 +171,7 @@ Ext.core.Element.addMethods({ if (!this.dom) { return null; } - + var n = this.dom[start]; while (n) { if (n.nodeType == 1 && (!selector || Ext.DomQuery.is(n, selector))) {