Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / output / Ext.html
index a87d158..1d6245c 100644 (file)
@@ -1,4 +1,4 @@
-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><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">Ext-more.js,&#13;Ext.js</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. 
+<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. 
 In older versions ...</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
@@ -32,7 +32,7 @@ The event name is specified with an <tt>&#64;</tt> suffix.
     :
                                         Object<div class="mdesc"><div class="short">Copies all the properties of config to obj if they don't already exist.</div><div class="long">Copies all the properties of config to obj if they don't already exist.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>obj</code> : Object<div class="sub-desc">The receiver of the properties</div></li><li><code>config</code> : Object<div class="sub-desc">The source of the properties</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">returns obj</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-clean"></a><b><a href="source/Ext-more.html#method-Ext-clean">clean</a></b>(&nbsp;<code>Array/NodeList&nbsp;arr</code>&nbsp;)
     :
-                                        Array<div class="mdesc"><div class="short">Creates a copy of the passed Array with falsy values removed.</div><div class="long">Creates a copy of the passed Array with falsy values removed.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>arr</code> : Array/NodeList<div class="sub-desc">The Array from which to remove falsy values.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The new, compressed Array.</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-copyTo"></a><b><a href="source/Ext-more.html#method-Ext-copyTo">copyTo</a></b>(&nbsp;<code>Object&nbsp;The</code>,&nbsp;<code>Object&nbsp;The</code>,&nbsp;<code>Array/String&nbsp;Either</code>&nbsp;)
+                                        Array<div class="mdesc"><div class="short">Creates a copy of the passed Array with falsy values removed.</div><div class="long">Creates a copy of the passed Array with falsy values removed.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>arr</code> : Array/NodeList<div class="sub-desc">The Array from which to remove falsy values.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The new, compressed Array.</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-copyTo"></a><b><a href="source/Ext-more.html#method-Ext-copyTo">copyTo</a></b>(&nbsp;<code>Object&nbsp;dest</code>,&nbsp;<code>Object&nbsp;source</code>,&nbsp;<code>Array/String&nbsp;names</code>&nbsp;)
     :
                                         Object<div class="mdesc"><div class="short">Copies a set of named properties fom the source object to the destination object.
 example:ImageComponent = Ext.extend...</div><div class="long">Copies a set of named properties fom the source object to the destination object.
@@ -42,7 +42,7 @@ example:ImageComponent = Ext.extend...</div><div class="long">Copies a set of na
         MyComponent.superclass.initComponent.apply(this, arguments);
         this.initialBox = Ext.copyTo({}, this.initialConfig, <em>'x,y,width,height'</em>);
     }
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>The</code> : Object<div class="sub-desc">destination object.</div></li><li><code>The</code> : Object<div class="sub-desc">source object.</div></li><li><code>Either</code> : Array/String<div class="sub-desc">an Array of property names, or a comma-delimited list
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dest</code> : Object<div class="sub-desc">The destination object.</div></li><li><code>source</code> : Object<div class="sub-desc">The source object.</div></li><li><code>names</code> : Array/String<div class="sub-desc">Either an Array of property names, or a comma-delimited list
 of property names to copy.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">The modified object.</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-create"></a><b><a href="source/ComponentMgr.html#method-Ext-create">create</a></b>(&nbsp;<code>Object&nbsp;config</code>,&nbsp;<code>Constructor&nbsp;defaultType</code>&nbsp;)
     :
                                         Ext.Component<div class="mdesc"><div class="short">Shorthand for Ext.ComponentMgr.create
@@ -178,7 +178,7 @@ when this method is called to be successful.<div class="mdetail-params"><strong>
 operating system settings...</div><div class="long">Utility method for getting the width of the browser scrollbar. This can differ depending on
 operating system settings, such as the theme or font size.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>force</code> : Boolean<div class="sub-desc">(optional) true to force a recalculation of the value.</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The width of the scrollbar.</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-id"></a><b><a href="source/Ext.html#method-Ext-id">id</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Mixed&nbsp;el</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;prefix</code>]</span>&nbsp;)
     :
-                                        String<div class="mdesc"><div class="short">Generates unique ids. If the element already has an id, it is unchanged</div><div class="long">Generates unique ids. If the element already has an id, it is unchanged<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc">(optional) The element to generate an id for</div></li><li><code>prefix</code> : String<div class="sub-desc">(optional) Id prefix (defaults "ext-gen")</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The generated Id.</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-invoke"></a><b><a href="source/Ext-more.html#method-Ext-invoke">invoke</a></b>(&nbsp;<code>Array|NodeList&nbsp;arr</code>,&nbsp;<code>String&nbsp;methodName</code>,&nbsp;<code>Anything&nbsp;...</code>&nbsp;)
+                                        String<div class="mdesc"><div class="short">Generates unique ids. If the element already has an id, it is unchanged</div><div class="long">Generates unique ids. If the element already has an id, it is unchanged<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc">(optional) The element to generate an id for</div></li><li><code>prefix</code> : String<div class="sub-desc">(optional) Id prefix (defaults "ext-gen")</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The generated Id.</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-invoke"></a><b><a href="source/Ext-more.html#method-Ext-invoke">invoke</a></b>(&nbsp;<code>Array|NodeList&nbsp;arr</code>,&nbsp;<code>String&nbsp;methodName</code>,&nbsp;<code>...*&nbsp;args</code>&nbsp;)
     :
                                         Array<div class="mdesc"><div class="short">Invokes a method on each item in an Array.
 // Example:
@@ -186,7 +186,7 @@ Ext.invoke(Ext.query("p"), "getAttribute", "id");
 // [el1.getA...</div><div class="long">Invokes a method on each item in an Array.
 <pre><code><i>// Example:</i>
 Ext.invoke(Ext.query(<em>"p"</em>), <em>"getAttribute"</em>, <em>"id"</em>);
-<i>// [el1.getAttribute(<em>"id"</em>), el2.getAttribute(<em>"id"</em>), ..., elN.getAttribute(<em>"id"</em>)]</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>arr</code> : Array|NodeList<div class="sub-desc">The Array of items to invoke the method on.</div></li><li><code>methodName</code> : String<div class="sub-desc">The method name to invoke.</div></li><li><code>...</code> : Anything<div class="sub-desc">Arguments to send into the method invocation.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The results of invoking the method on each item in the array.</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-isArray"></a><b><a href="source/Ext.html#method-Ext-isArray">isArray</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)
+<i>// [el1.getAttribute(<em>"id"</em>), el2.getAttribute(<em>"id"</em>), ..., elN.getAttribute(<em>"id"</em>)]</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>arr</code> : Array|NodeList<div class="sub-desc">The Array of items to invoke the method on.</div></li><li><code>methodName</code> : String<div class="sub-desc">The method name to invoke.</div></li><li><code>args</code> : ...*<div class="sub-desc">Arguments to send into the method invocation.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The results of invoking the method on each item in the array.</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-isArray"></a><b><a href="source/Ext.html#method-Ext-isArray">isArray</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)
     :
                                         Boolean<div class="mdesc"><div class="short">Returns true if the passed value is a JavaScript array, otherwise false.</div><div class="long">Returns true if the passed value is a JavaScript array, otherwise false.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">The value to test</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</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-isBoolean"></a><b><a href="source/Ext.html#method-Ext-isBoolean">isBoolean</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)
     :
@@ -262,7 +262,7 @@ Company.data.CustomStore = <b>function</b>(config) { ... }</code></pre><div clas
     :
                                         Number<div class="mdesc"><div class="short">Utility method for validating that a value is numeric, returning the specified default value if it is not.</div><div class="long">Utility method for validating that a value is numeric, returning the specified default value if it is not.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">Should be a number, but any type will be handled appropriately</div></li><li><code>defaultValue</code> : Number<div class="sub-desc">The value to return if the original value is non-numeric</div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">Value, if numeric, else defaultValue</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-onReady"></a><b><a href="source/EventManager.html#method-Ext-onReady">onReady</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>boolean&nbsp;options</code>]</span>&nbsp;)
     :
-                                        void<div class="mdesc"><div class="short">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of ...</div><div class="long">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of <a href="output/Ext.EventManager.html#Ext.EventManager-onDocumentReady" ext:member="onDocumentReady" ext:cls="Ext.EventManager">Ext.EventManager.onDocumentReady</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.</div></li><li><code>options</code> : boolean<div class="sub-desc">(optional) Options object as passed to <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a>. It is recommended that the options\r
+                                        void<div class="mdesc"><div class="short">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of ...</div><div class="long">Adds a listener to be notified when the document is ready (before onload and before images are loaded). Shorthand of <a href="output/Ext.EventManager.html#Ext.EventManager-onDocumentReady" ext:member="onDocumentReady" ext:cls="Ext.EventManager">Ext.EventManager.onDocumentReady</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the handler function executes. Defaults to the browser window.</div></li><li><code>options</code> : boolean<div class="sub-desc">(optional) Options object as passed to <a href="output/Ext.Element.html#Ext.Element-addListener" ext:member="addListener" ext:cls="Ext.Element">Ext.Element.addListener</a>. It is recommended that the options
 <code>{single: true}</code> be used so that the handler is removed on first invocation.</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-override"></a><b><a href="source/Ext.html#method-Ext-override">override</a></b>(&nbsp;<code>Object&nbsp;origclass</code>,&nbsp;<code>Object&nbsp;overrides</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.
@@ -318,9 +318,9 @@ All DOM event listeners are removed from this element. If <a href="output/Ext.ht
 <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/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&#13;
-to be applied to many related elements i...</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\r
-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\r
+                                        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>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;)