Upgrade to ExtJS 3.2.2 - Released 06/02/2010
[extjs.git] / docs / output / Ext.html
index fd9d365..eb46dd2 100644 (file)
@@ -1,4 +1,4 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Ext.html#cls-Ext">Ext</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Global</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Ext.html#cls-Ext">Ext.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Ext.html#cls-Ext">Ext</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Ext core utilities and functions.<br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-"></a><b><a href="source/Ext.html#prop-Ext-"></a></b> : Object<div class="mdesc">Removes a DOM node from the document.</div></td><td class="msource">Ext</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-BLANK_IMAGE_URL"></a><b><a href="source/Ext-more.html#prop-Ext-BLANK_IMAGE_URL">BLANK_IMAGE_URL</a></b> : String<div class="mdesc"><div class="short">URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images.
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Ext-more.html#cls-Ext">Ext</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Global</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Ext-more.html#cls-Ext">Ext-more.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Ext-more.html#cls-Ext">Ext</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Ext core utilities and functions.<br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-"></a><b><a href="source/Ext.html#prop-Ext-"></a></b> : Object<div class="mdesc">Removes a DOM node from the document.</div></td><td class="msource">Ext</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-BLANK_IMAGE_URL"></a><b><a href="source/Ext-more.html#prop-Ext-BLANK_IMAGE_URL">BLANK_IMAGE_URL</a></b> : String<div class="mdesc"><div class="short">URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images.
 In older versions o...</div><div class="long">URL to a 1x1 transparent gif image used by Ext to create inline icons with CSS background images.
 In older versions of IE, this defaults to "http://extjs.com/s.gif" and you should change this to a URL on your server.
 For other browsers it uses an inline data URL.</div></div></td><td class="msource">Ext</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-SSL_SECURE_URL"></a><b><a href="source/Ext.html#prop-Ext-SSL_SECURE_URL">SSL_SECURE_URL</a></b> : String<div class="mdesc"><div class="short">URL to a blank file used by Ext when in secure mode for iframe src and onReady src to prevent
@@ -172,7 +172,9 @@ Here are some examples:
     <i>// <b>do</b> something <b>with</b> the dom node</i>
 }</code></pre>
 <b>Note</b>: the dom node to be found actually needs to exist (be rendered, etc)
-when this method is called to be successful.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>HTMLElement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-getScrollBarWidth"></a><b><a href="source/Ext-more.html#method-Ext-getScrollBarWidth">getScrollBarWidth</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;force</code>]</span>&nbsp;)
+when this method is called to be successful.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>HTMLElement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-getHead"></a><b><a href="source/Ext.html#method-Ext-getHead">getHead</a></b>()
+    :
+                                        Ext.Element<div class="mdesc"><div class="short">Returns the current document body as an Ext.Element.</div><div class="long">Returns the current document body as an <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The document body</div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-getScrollBarWidth"></a><b><a href="source/Ext-more.html#method-Ext-getScrollBarWidth">getScrollBarWidth</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;force</code>]</span>&nbsp;)
     :
                                         Number<div class="mdesc"><div class="short">Utility method for getting the width of the browser scrollbar. This can differ depending on
 operating system settings...</div><div class="long">Utility method for getting the width of the browser scrollbar. This can differ depending on
@@ -316,12 +318,12 @@ may be looked up.</div></li><li><code>cls</code> : Constructor<div class="sub-de
 All DOM eve...</div><div class="long"><p>Removes this element from the document, removes all DOM event listeners, and deletes the cache reference.
 All DOM event listeners are removed from this element. If <a href="output/Ext.html#Ext-enableNestedListenerRemoval" ext:member="enableNestedListenerRemoval" ext:cls="Ext">Ext.enableNestedListenerRemoval</a> is
 <code>true</code>, then DOM event listeners are also removed from all child nodes. The body node
-will be ignored if passed in.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>node</code> : HTMLElement<div class="sub-desc">The node to remove</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-select"></a><b><a href="source/CompositeElement.html#method-Ext-select">select</a></b>(&nbsp;<code>String/Array&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;unique</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>HTMLElement/String&nbsp;root</code>]</span>&nbsp;)
+will be ignored if passed in.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>node</code> : HTMLElement<div class="sub-desc">The node to remove</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-select"></a><b><a href="source/CompositeElementLite.html#method-Ext-select">select</a></b>(&nbsp;<code>String/Array&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>HTMLElement/String&nbsp;root</code>]</span>&nbsp;)
     :
                                         CompositeElementLite/CompositeElement<div class="mdesc"><div class="short">Selects elements based on the passed CSS selector to enable Element methods
 to be applied to many related elements in...</div><div class="long">Selects elements based on the passed CSS selector to enable <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a> methods
 to be applied to many related elements in one statement through the returned <a href="output/Ext.CompositeElement.html" ext:cls="Ext.CompositeElement">CompositeElement</a> or
-<a href="output/Ext.CompositeElementLite.html" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a> object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String/Array<div class="sub-desc">The CSS selector or an array of elements</div></li><li><code>unique</code> : Boolean<div class="sub-desc">(optional) true to create a unique Ext.Element for each element (defaults to a shared flyweight object)</div></li><li><code>root</code> : HTMLElement/String<div class="sub-desc">(optional) The root element of the query or id of the root</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElementLite/CompositeElement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-sum"></a><b><a href="source/Ext-more.html#method-Ext-sum">sum</a></b>(&nbsp;<code>Array&nbsp;arr</code>&nbsp;)
+<a href="output/Ext.CompositeElementLite.html" ext:cls="Ext.CompositeElementLite">CompositeElementLite</a> object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String/Array<div class="sub-desc">The CSS selector or an array of elements</div></li><li><code>root</code> : HTMLElement/String<div class="sub-desc">(optional) The root element of the query or id of the root</div></li></ul><strong>Returns:</strong><ul><li><code>CompositeElementLite/CompositeElement</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-sum"></a><b><a href="source/Ext-more.html#method-Ext-sum">sum</a></b>(&nbsp;<code>Array&nbsp;arr</code>&nbsp;)
     :
                                         Number<div class="mdesc"><div class="short">Calculates the sum of the Array</div><div class="long">Calculates the sum of the Array<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>arr</code> : Array<div class="sub-desc">The Array to calculate the sum value of.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The sum.</div></li></ul></div></div></div></td><td class="msource">Ext</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext-toArray"></a><b><a href="source/Ext.html#method-Ext-toArray">toArray</a></b>(&nbsp;<code>Iterable&nbsp;the</code>&nbsp;)
     :