- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.Ajax-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.Ajax-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.Ajax-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.Ajax-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.Ajax"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.Connection" ext:member="" href="output/Ext.data.Connection.html">Connection</a>
- <img src="resources/elbow-end.gif"/>Ajax</pre></div>
- <h1>Class Ext.Ajax</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Connection.js" target="_blank">Connection.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Ajax</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.Connection" ext:member="" href="output/Ext.data.Connection.html">Connection</a></td></tr>
- </table>
- <div class="description">
- Global Ajax request class. Provides a simple way to make Ajax requests with maximum flexibility. Example usage:
-<pre><code><i>// Basic request</i>
-Ext.Ajax.request({
- url: <em>'foo.php'</em>,
- success: someFn,
- failure: otherFn,
- headers: {
- <em>'my-header'</em>: <em>'foo'</em>
- },
- params: { foo: <em>'bar'</em> }
-});
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.Ajax-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.Ajax-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.Ajax-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.Ajax-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.Ajax"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.data.Connection.html" ext:member="" ext:cls="Ext.data.Connection">Connection</a> <img src="resources/elbow-end.gif">Ajax</pre></div><h1>Class <a href="source/Connection.html#cls-Ext.Ajax">Ext.Ajax</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Connection.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Connection.html#cls-Ext.Ajax">Ajax</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection" ext:member="">Connection</a></td></tr></table><div class="description"><p>The global Ajax request class that provides a simple way to make Ajax requests\r
+with maximum flexibility.</p>\r
+<p>Since Ext.Ajax is a singleton, you can set common properties/events for it once\r
+and override them at the request function level only if necessary.</p>\r
+<p>Common <b>Properties</b> you may want to set are:<div class="mdetail-params"><ul>\r
+<li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-method" ext:member="method" ext:cls="Ext.Ajax">method</a></tt></b><p class="sub-desc"></p></li>\r
+<li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-extraParams" ext:member="extraParams" ext:cls="Ext.Ajax">extraParams</a></tt></b><p class="sub-desc"></p></li>\r
+<li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-url" ext:member="url" ext:cls="Ext.Ajax">url</a></tt></b><p class="sub-desc"></p></li>\r
+</ul></div>\r
+<pre><code><i>// Default headers to pass <b>in</b> every request\r</i>
+Ext.Ajax.defaultHeaders = {\r
+ <em>'Powered-By'</em>: <em>'Ext'</em>\r
+};</code></pre> \r
+</p>\r
+<p>Common <b>Events</b> you may want to set are:<div class="mdetail-params"><ul>\r
+<li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-beforerequest" ext:member="beforerequest" ext:cls="Ext.data.Connection">beforerequest</a></tt></b><p class="sub-desc"></p></li>\r
+<li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-requestcomplete" ext:member="requestcomplete" ext:cls="Ext.data.Connection">requestcomplete</a></tt></b><p class="sub-desc"></p></li>\r
+<li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-requestexception" ext:member="requestexception" ext:cls="Ext.data.Connection">requestexception</a></tt></b><p class="sub-desc"></p></li>\r
+</ul></div>\r
+<pre><code><i>// Example: show a spinner during all Ajax requests\r</i>
+Ext.Ajax.on(<em>'beforerequest'</em>, this.showSpinner, this);\r
+Ext.Ajax.on(<em>'requestcomplete'</em>, this.hideSpinner, this);\r
+Ext.Ajax.on(<em>'requestexception'</em>, this.hideSpinner, this);</code></pre> \r
+</p>\r
+<p>An example request:</p>\r
+<pre><code><i>// Basic request\r</i>
+Ext.Ajax.<a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a>({\r
+ url: <em>'foo.php'</em>,\r
+ success: someFn,\r
+ failure: otherFn,\r
+ headers: {\r
+ <em>'my-header'</em>: <em>'foo'</em>\r
+ },\r
+ params: { foo: <em>'bar'</em> }\r
+});\r
+\r
+<i>// Simple ajax form submission\r</i>
+Ext.Ajax.<a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a>({\r
+ form: <em>'some-form'</em>,\r
+ params: <em>'foo=bar'</em>\r
+});</code></pre> \r
+</p><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.Ajax-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-disableCachingParam"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCachingParam">disableCachingParam</a></b> : String<div class="mdesc">Change the parameter which is sent went disabling caching\r
+through a cache buster. Defaults to '_dc'</div></td><td class="msource"><a href="output/Ext.data.Connection.html#disableCachingParam" ext:member="#disableCachingParam" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
+object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
+object during initialization. This should be a valid listeners config object as specified in the
+<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
+<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
+<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
+<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
+has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
+<i>// The Component is appended to the argument list of all handler functions.</i>
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: <b>function</b>(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ <i>// Component passes itself into plugin's init method</i>
+ init: <b>function</b>(c) {
+ <b>var</b> p, l = this.listeners;
+ <b>for</b> (p <b>in</b> l) {
+ <b>if</b> (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } <b>else</b> {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
-<i>// Simple ajax form submission</i>
-Ext.Ajax.request({
- form: <em>'some-form'</em>,
- params: <em>'foo=bar'</em>
+ <i>// Add the listeners to the Element immediately following the render call</i>
+ c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
+ <b>var</b> e = c.getEl();
+ <b>if</b> (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: <b>function</b>(fn, c) {
+ <b>return</b> <b>function</b>(e) {
+ fn.call(this, e, c);
+ };
+ }
});
-<i>// Default headers to pass <b>in</b> every request</i>
-Ext.Ajax.defaultHeaders = {
- <em>'Powered-By'</em>: <em>'Ext'</em>
-};
+<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
-<i>// Global Ajax events can be handled on every request!</i>
-Ext.Ajax.on(<em>'beforerequest'</em>, <b>this</b>.showSpinner, <b>this</b>);</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i> </div>
-
- <div class="hr"></div>
- <a id="Ext.Ajax-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-disableCachingParam"></a>\r
- <b>disableCachingParam</b> : String <div class="mdesc">\r
- (Optional) Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc' </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#disableCachingParam" href="output/Ext.data.Connection.html#disableCachingParam">Connection</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.Ajax-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-autoAbort"></a>\r
- <b>autoAbort</b> : Boolean <div class="mdesc">\r
-
-Whether a new request should abort any pending requests. (defaults to false) </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-defaultHeaders"></a>\r
- <b>defaultHeaders</b> : Object <div class="mdesc">\r
-
-An object containing request headers which are added to each request made by this object. (defaults to undefined) </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-disableCaching"></a>\r
- <b>disableCaching</b> : Boolean <div class="mdesc">\r
-
-True to add a unique cache-buster param to GET requests. (defaults to true) </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-extraParams"></a>\r
- <b>extraParams</b> : Object <div class="mdesc">\r
- <div class="short">
-An object containing properties which are used as
-extra parameters to each request made by this object. (defaults to...</div>\r
- <div class="long">\r
-
-An object containing properties which are used as
-extra parameters to each request made by this object. (defaults to undefined) </div>\r
- </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-method"></a>\r
- <b>method</b> : String <div class="mdesc">\r
- <div class="short">
-The default HTTP method to be used for requests. Note that this is case-sensitive and should be all caps (defaults
-t...</div>\r
- <div class="long">\r
-
-The default HTTP method to be used for requests. Note that this is case-sensitive and should be all caps (defaults
-to undefined; if not set but parms are present will use "POST," otherwise "GET.") </div>\r
- </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-timeout"></a>\r
- <b>timeout</b> : Number <div class="mdesc">\r
-
-The timeout in milliseconds to be used for requests. (defaults to 30000) </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-url"></a>\r
- <b>url</b> : String <div class="mdesc">\r
-
-The default URL to be used for requests to the server. (defaults to undefined) </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- </table>
- <a id="Ext.Ajax-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-abort"></a>\r
- <b>abort</b>( <span class="optional" title="Optional">[<code>Number transactionId</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Aborts any outstanding request.</div>\r
- <div class="long">\r
- Aborts any outstanding request. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#abort" href="output/Ext.data.Connection.html#abort">Connection</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-addListener"></a>\r
- <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</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 in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
+ <i>// Collapse combo when its element is clicked on</i>
+ plugins: [ <b>new</b> Ext.DomObserver({
+ click: <b>function</b>(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: <em>'local'</em>,
+ triggerAction: <em>'all'</em>
+});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.Ajax-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"> </a></td><td class="sig"><a id="Ext.Ajax-autoAbort"></a><b><a href="source/Connection.html#prop-Ext.Ajax-autoAbort">autoAbort</a></b> : Boolean<div class="mdesc">Whether a new request should abort any pending requests. (defaults to false)</div></td><td class="msource">Ajax</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-defaultHeaders"></a><b><a href="source/Connection.html#prop-Ext.Ajax-defaultHeaders">defaultHeaders</a></b> : Object<div class="mdesc">An object containing request headers which are added to each request made by this object\r
+(defaults to undefined).</div></td><td class="msource">Ajax</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-disableCaching"></a><b><a href="source/Connection.html#prop-Ext.Ajax-disableCaching">disableCaching</a></b> : Boolean<div class="mdesc">True to add a unique cache-buster param to GET requests. (defaults to true)</div></td><td class="msource">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-extraParams"></a><b><a href="source/Connection.html#prop-Ext.Ajax-extraParams">extraParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are used as extra parameters to each request made
+by this object (defaults to ...</div><div class="long">An object containing properties which are used as extra parameters to each request made\r
+by this object (defaults to undefined). Session information and other data that you need\r
+to pass with each request are commonly put here.</div></div></td><td class="msource">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-method"></a><b><a href="source/Connection.html#prop-Ext.Ajax-method">method</a></b> : String<div class="mdesc"><div class="short">The default HTTP method to be used for requests. Note that this is case-sensitive and
+should be all caps (defaults t...</div><div class="long">The default HTTP method to be used for requests. Note that this is case-sensitive and\r
+should be all caps (defaults to undefined; if not set but params are present will use\r
+<tt>"POST"</tt>, otherwise will use <tt>"GET"</tt>.)</div></div></td><td class="msource">Ajax</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-timeout"></a><b><a href="source/Connection.html#prop-Ext.Ajax-timeout">timeout</a></b> : Number<div class="mdesc">The timeout in milliseconds to be used for requests. (defaults to 30000)</div></td><td class="msource">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-url"></a><b><a href="source/Connection.html#prop-Ext.Ajax-url">url</a></b> : String<div class="mdesc"><div class="short">The default URL to be used for requests to the server. (defaults to undefined)
+If the server receives all requests t...</div><div class="long">The default URL to be used for requests to the server. (defaults to undefined)\r
+If the server receives all requests through one URL, setting this once is easier than\r
+entering it on every request.</div></div></td><td class="msource">Ajax</td></tr></tbody></table><a id="Ext.Ajax-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-abort"></a><b><a href="source/Connection.html#method-Ext.data.Connection-abort">abort</a></b>( <span title="Optional" class="optional">[<code>Number transactionId</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Aborts any outstanding request.</div><div class="long">Aborts any outstanding request.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#abort" ext:member="#abort" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object object</code> )
+ :
+ void<div class="mdesc"><div class="short">Used to define events on this Observable</div><div class="long">Used to define events on this Observable<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</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><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
properties. This may contain any of the following properties:<ul>
-<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
-<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
-<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
-<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
+<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li>
+<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
+<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
+<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
+handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
+<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
+if the event was bubbled up from a child Observable.</div></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
+A delayed, one-time listener.
+<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
single: true,
- delay: 100,
- forumId: 4
+ delay: 100
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
-<pre><code>foo.on({
+<pre><code>myGridPanel.on({
<em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
+ fn: this.onClick,
+ scope: this,
delay: 100
},
<em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
+ fn: this.onMouseOver,
+ scope: this
},
<em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
+ fn: this.onMouseOut,
+ scope: this
}
});</code></pre>
<p>
Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-isLoading"></a>\r
- <b>isLoading</b>( <span class="optional" title="Optional">[<code>Number transactionId</code>]</span> ) : Boolean <div class="mdesc">\r
- <div class="short">Determine whether this object has a request outstanding.</div>\r
- <div class="long">\r
- Determine whether this object has a request outstanding. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if there is an outstanding request.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#isLoading" href="output/Ext.data.Connection.html#isLoading">Connection</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</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 in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-request"></a>\r
- <b>request</b>( <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Sends an HTTP request to a remote server.
-Important: Ajax server requests are asynchronous, and this call will
-return...</div>\r
- <div class="long">\r
- <p>Sends an HTTP request to a remote server.</p>
-<p><b>Important:</b> Ajax server requests are asynchronous, and this call will
-return before the response has been received. Process any returned data
-in a callback function.</p>
-<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>
-<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to
-which to send the request, or a function to call which returns a URL string. The scope of the
-function is specified by the <tt>scope</tt> option. Defaults to configured URL.</div></li>
-<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">
-An object containing properties which are used as parameters to the
-request, a url encoded string or a function to call to get either. The scope of the function
-is specified by the <tt>scope</tt> option.</div></li>
-<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use
-for the request. Defaults to the configured method, or if no method was configured,
-"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that
-the method name is case-sensitive and should be all caps.</div></li>
-<li><b>callback</b> : Function (Optional)<div class="sub-desc">The
-function to be called upon receipt of the HTTP response. The callback is
-called regardless of success or failure and is passed the following
-parameters:<ul>
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
-<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about
-accessing elements of the response.</div></li>
-</ul></div></li>
-<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function
-to be called upon success of the request. The callback is passed the following
-parameters:<ul>
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
-</ul></div></li>
-<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function
-to be called upon failure of the request. The callback is passed the
-following parameters:<ul>
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
-</ul></div></li>
-<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in
-which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were
-specified as functions from which to draw values, then this also serves as the scope for those function calls.
-Defaults to the browser window.</div></li>
-<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>
-Element or the id of the <tt><form></tt> to pull parameters from.</div></li>
-<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used
-with the <tt>form</tt> option.</b>
-<p>True if the form object is a file upload (will be set automatically if the form was
-configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>
-<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
-performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
-DOM <tt><form></tt> element temporarily modified to have its
-<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
-to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
-but removed after the return data has been gathered.</p>
-<p>The server response is parsed by the browser to create the document for the IFRAME. If the
-server is using JSON to send the return object, then the
-<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
-<p>The response text is retrieved from the document, and a fake XMLHttpRequest object
-is created containing a <tt>responseText</tt> property in order to conform to the
-requirements of event handlers and callbacks.</p>
-<p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
-and some server technologies (notably JEE) may require some custom processing in order to
-retrieve parameter names and parameter values from the packet content.</p>
-</div></li>
-<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request
-headers to set for the request.</div></li>
-<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document
-to use for the post. Note: This will be used instead of params for the post
-data. Any params will be appended to the URL.</div></li>
-<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON
-data to use as the post. Note: This will be used instead of params for the post
-data. Any params will be appended to the URL.</div></li>
-<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True
-to add a unique cache-buster param to GET requests.</div></li>
-</ul></p>
-<p>The options object may also contain any other property which might be needed to perform
-postprocessing in a callback because it is passed to callback functions.</p></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used to cancel the request.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#request" href="output/Ext.data.Connection.html#request">Connection</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
- <div class="long">\r
- Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-serializeForm"></a>\r
- <b>serializeForm</b>( <code>String/HTMLElement form</code> ) : String <div class="mdesc">\r
- <div class="short">Serialize the passed form into a url encoded string</div>\r
- <div class="long">\r
- Serialize the passed form into a url encoded string <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>form</code> : String/HTMLElement<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Ajax</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
- <div class="long">\r
- Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.Ajax-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-beforerequest"></a>\r
- <b>beforerequest</b> : ( <code>Connection conn</code>, <code>Object options</code> ) <div class="mdesc">\r
- <div class="short">Fires before a network request is made to retrieve a data object.</div>\r
- <div class="long">\r
- Fires before a network request is made to retrieve a data object. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a ext:cls="Ext.data.Connection" ext:member="request" href="output/Ext.data.Connection.html#request">request</a> method.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#event-beforerequest" href="output/Ext.data.Connection.html#event-beforerequest">Connection</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-requestcomplete"></a>\r
- <b>requestcomplete</b> : ( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> ) <div class="mdesc">\r
- <div class="short">Fires if the request was successfully completed.</div>\r
- <div class="long">\r
- Fires if the request was successfully completed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
-for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a ext:cls="Ext.data.Connection" ext:member="request" href="output/Ext.data.Connection.html#request">request</a> method.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#event-requestcomplete" href="output/Ext.data.Connection.html#event-requestcomplete">Connection</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.Ajax-requestexception"></a>\r
- <b>requestexception</b> : ( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> ) <div class="mdesc">\r
- <div class="short">Fires if an error HTTP status was returned from the server.
-See HTTP Status Code Definitions
-for details of HTTP stat...</div>\r
- <div class="long">\r
- Fires if an error HTTP status was returned from the server.
-See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>
-for details of HTTP status codes. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
-for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a ext:cls="Ext.data.Connection" ext:member="request" href="output/Ext.data.Connection.html#request">request</a> method.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.data.Connection" ext:member="#event-requestexception" href="output/Ext.data.Connection.html#event-requestexception">Connection</a></td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file
+<pre><code>myGridPanel.on({
+ <em>'click'</em> : this.onClick,
+ <em>'mouseover'</em> : this.onMouseOver,
+ <em>'mouseout'</em> : this.onMouseOut,
+ scope: this
+});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>Object events</code> )
+ :
+ void<div class="mdesc"><div class="short">Used to enable bubbling of events</div><div class="long">Used to enable bubbling of events<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
+ :
+ Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
+<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
+by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )
+ :
+ Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-isLoading"></a><b><a href="source/Connection.html#method-Ext.data.Connection-isLoading">isLoading</a></b>( <span title="Optional" class="optional">[<code>Number transactionId</code>]</span> )
+ :
+ Boolean<div class="mdesc"><div class="short">Determine whether this object has a request outstanding.</div><div class="long">Determine whether this object has a request outstanding.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if there is an outstanding request.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#isLoading" ext:member="#isLoading" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</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><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )
+ :
+ void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-request"></a><b><a href="source/Connection.html#method-Ext.data.Connection-request">request</a></b>( <code>Object options</code> )
+ :
+ Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.
+Important: Ajax server requests are asynchronous, and this call will
+retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>\r
+<p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
+return before the response has been received. Process any returned data\r
+in a callback function.</p>\r
+<pre><code>Ext.Ajax.request({\r
+ url: <em>'ajax_demo/sample.json'</em>,\r
+ success: <b>function</b>(response, opts) {\r
+ <b>var</b> obj = Ext.decode(response.responseText);\r
+ console.dir(obj);\r
+ },\r
+ failure: <b>function</b>(response, opts) {\r
+ console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);\r
+ }\r
+});</code></pre>\r
+<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>\r
+<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
+which to send the request, or a function to call which returns a URL string. The scope of the\r
+function is specified by the <tt>scope</tt> option. Defaults to the configured\r
+<tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>\r
+<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
+An object containing properties which are used as parameters to the\r
+request, a url encoded string or a function to call to get either. The scope of the function\r
+is specified by the <tt>scope</tt> option.</div></li>\r
+<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
+for the request. Defaults to the configured method, or if no method was configured,\r
+"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that\r
+the method name is case-sensitive and should be all caps.</div></li>\r
+<li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
+function to be called upon receipt of the HTTP response. The callback is\r
+called regardless of success or failure and is passed the following\r
+parameters:<ul>\r
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
+<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data. \r
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about \r
+accessing elements of the response.</div></li>\r
+</ul></div></li>\r
+<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
+to be called upon success of the request. The callback is passed the following\r
+parameters:<ul>\r
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
+</ul></div></li>\r
+<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
+to be called upon failure of the request. The callback is passed the\r
+following parameters:<ul>\r
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
+</ul></div></li>\r
+<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
+which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
+specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
+Defaults to the browser window.</div></li>\r
+<li><b>timeout</b> : Number (Optional)<div class="sub-desc">The timeout in milliseconds to be used for this request. Defaults to 30 seconds.</div></li>\r
+<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>\r
+Element or the id of the <tt><form></tt> to pull parameters from.</div></li>\r
+<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used \r
+with the <tt>form</tt> option</b>.\r
+<p>True if the form object is a file upload (will be set automatically if the form was\r
+configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
+<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
+performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
+DOM <tt><form></tt> element temporarily modified to have its\r
+<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
+to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document\r
+but removed after the return data has been gathered.</p>\r
+<p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
+server is using JSON to send the return object, then the\r
+<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
+must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
+<p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
+is created containing a <tt>responseText</tt> property in order to conform to the\r
+requirements of event handlers and callbacks.</p>\r
+<p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
+and some server technologies (notably JEE) may require some custom processing in order to\r
+retrieve parameter names and parameter values from the packet content.</p>\r
+</div></li>\r
+<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
+headers to set for the request.</div></li>\r
+<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
+to use for the post. Note: This will be used instead of params for the post\r
+data. Any params will be appended to the URL.</div></li>\r
+<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
+data to use as the post. Note: This will be used instead of params for the post\r
+data. Any params will be appended to the URL.</div></li>\r
+<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
+to add a unique cache-buster param to GET requests.</div></li>\r
+</ul></p>\r
+<p>The options object may also contain any other property which might be needed to perform\r
+postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used
+to cancel the request.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#request" ext:member="#request" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
+If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
+events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Ajax-serializeForm"></a><b><a href="source/Connection.html#method-Ext.Ajax-serializeForm">serializeForm</a></b>( <code>String/HTMLElement form</code> )
+ :
+ String<div class="mdesc"><div class="short">Serialize the passed form into a url encoded string</div><div class="long">Serialize the passed form into a url encoded string<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>form</code> : String/HTMLElement<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ajax</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )
+ :
+ void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
+after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.Ajax-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-beforerequest"></a><b><a href="source/Connection.html#event-Ext.data.Connection-beforerequest">beforerequest</a></b> :
+ ( <code>Connection conn</code>, <code>Object options</code> )
+ <div class="mdesc"><div class="short">Fires before a network request is made to retrieve a data object.</div><div class="long">Fires before a network request is made to retrieve a data object.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#beforerequest" ext:member="#beforerequest" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-requestcomplete"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestcomplete">requestcomplete</a></b> :
+ ( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> )
+ <div class="mdesc"><div class="short">Fires if the request was successfully completed.</div><div class="long">Fires if the request was successfully completed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
+for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#requestcomplete" ext:member="#requestcomplete" ext:cls="Ext.data.Connection">Connection</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-requestexception"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestexception">requestexception</a></b> :
+ ( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> )
+ <div class="mdesc"><div class="short">Fires if an error HTTP status was returned from the server.
+See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616...</div><div class="long">Fires if an error HTTP status was returned from the server.\r
+See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
+for details of HTTP status codes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
+for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#requestexception" ext:member="#requestexception" ext:cls="Ext.data.Connection">Connection</a></td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff