docs/output/Ext.Direct.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.Direct-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.Direct-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.Direct-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.Direct-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.Direct"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</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>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">Direct</pre></div><h1>Class <a href="source/Direct.html#cls-Ext.Direct">Ext.Direct</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">Direct.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Direct.html#cls-Ext.Direct">Direct</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p><b><u>Overview</u></b></p>\r
   2 <p>Ext.Direct aims to streamline communication between the client and server\r
   3 by providing a single interface that reduces the amount of common code\r
   4 typically required to validate data and handle returned data packets\r
   5 (reading data, error conditions, etc).</p>\r
   6 <p>The Ext.direct namespace includes several classes for a closer integration\r
   7 with the server-side. The Ext.data namespace also includes classes for working\r
   8 with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>\r
   9 <p><b><u>Specification</u></b></p>\r
  10 <p>For additional information consult the \r
  11 <a href="http://extjs.com/products/extjs/direct.php">Ext.Direct Specification</a>.</p>\r
  12 <p><b><u>Providers</u></b></p>\r
  13 <p>Ext.Direct uses a provider architecture, where one or more providers are\r
  14 used to transport data to and from the server. There are several providers\r
  15 that exist in the core at the moment:</p><div class="mdetail-params"><ul>\r
  16 <li><a href="output/Ext.direct.JsonProvider.html" ext:cls="Ext.direct.JsonProvider">JsonProvider</a> for simple JSON operations</li>\r
  17 <li><a href="output/Ext.direct.PollingProvider.html" ext:cls="Ext.direct.PollingProvider">PollingProvider</a> for repeated requests</li>\r
  18 <li><a href="output/Ext.direct.RemotingProvider.html" ext:cls="Ext.direct.RemotingProvider">RemotingProvider</a> exposes server side\r
  19 on the client.</li>\r
  20 </ul></div>\r
  21 <p>A provider does not need to be invoked directly, providers are added via\r
  22 <a href="output/Ext.Direct.html" ext:cls="Ext.Direct">Ext.Direct</a>.<a href="output/Ext.Direct.html#Ext.Direct-add" ext:member="add" ext:cls="Ext.Direct">add</a>.</p>\r
  23 <p><b><u>Router</u></b></p>\r
  24 <p>Ext.Direct utilizes a "router" on the server to direct requests from the client\r
  25 to the appropriate server-side method. Because the Ext.Direct API is completely\r
  26 platform-agnostic, you could completely swap out a Java based server solution\r
  27 and replace it with one that uses C# without changing the client side JavaScript\r
  28 at all.</p>\r
  29 <p><b><u>Server side events</u></b></p>\r
  30 <p>Custom events from the server may be handled by the client by adding\r
  31 listeners, for example:</p>\r
  32 <pre><code>{<em>"type"</em>:<em>"event"</em>,<em>"name"</em>:<em>"message"</em>,<em>"data"</em>:<em>"Successfully polled at: 11:19:30 am"</em>}\r
  33 \r
  34 <i>// add a handler <b>for</b> a <em>'message'</em> event sent by the server \r</i>
  35 Ext.Direct.on(<em>'message'</em>, <b>function</b>(e){\r
  36     out.append(String.format(<em>'&lt;p>&lt;i>{0}&lt;/i>&lt;/p>'</em>, e.data));\r
  37             out.el.scrollTo(<em>'t'</em>, 100000, true);\r
  38 });</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.Direct-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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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
  39 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
  40 object during initialization.  This should be a valid listeners config object as specified in the
  41 <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>
  42 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
  43 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  44 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
  45 <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
  46 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
  47 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
  48 <i>// The Component is appended to the argument list of all handler functions.</i>
  49 Ext.DomObserver = Ext.extend(Object, {
  50     constructor: <b>function</b>(config) {
  51         this.listeners = config.listeners ? config.listeners : config;
  52     },
  53
  54     <i>// Component passes itself into plugin&#39;s init method</i>
  55     init: <b>function</b>(c) {
  56         <b>var</b> p, l = this.listeners;
  57         <b>for</b> (p <b>in</b> l) {
  58             <b>if</b> (Ext.isFunction(l[p])) {
  59                 l[p] = this.createHandler(l[p], c);
  60             } <b>else</b> {
  61                 l[p].fn = this.createHandler(l[p].fn, c);
  62             }
  63         }
  64
  65         <i>// Add the listeners to the Element immediately following the render call</i>
  66         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
  67             <b>var</b> e = c.getEl();
  68             <b>if</b> (e) {
  69                 e.on(l);
  70             }
  71         });
  72     },
  73
  74     createHandler: <b>function</b>(fn, c) {
  75         <b>return</b> <b>function</b>(e) {
  76             fn.call(this, e, c);
  77         };
  78     }
  79 });
  80
  81 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
  82
  83     <i>// Collapse combo when its element is clicked on</i>
  84     plugins: [ <b>new</b> Ext.DomObserver({
  85         click: <b>function</b>(evt, comp) {
  86             comp.collapse();
  87         }
  88     })],
  89     store: myStore,
  90     typeAhead: true,
  91     mode: <em>'local'</em>,
  92     triggerAction: <em>'all'</em>
  93 });</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.Direct-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 expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-eventTypes"></a><b><a href="source/Direct.html#prop-Ext.Direct-eventTypes">eventTypes</a></b> : Object<div class="mdesc"><div class="short">Each event type implements a getData() method. The default event types are:&#13;
  94 &lt;div class="mdetail-params"&gt;&#13;
  95 event : Ex...</div><div class="long">Each event type implements a getData() method. The default event types are:\r
  96 <div class="mdetail-params"><ul>\r
  97 <li><b><tt>event</tt></b> : Ext.Direct.Event</li>\r
  98 <li><b><tt>exception</tt></b> : Ext.Direct.ExceptionEvent</li>\r
  99 <li><b><tt>rpc</tt></b> : Ext.Direct.RemotingEvent</li>\r
 100 </ul></div></div></div></td><td class="msource">Direct</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-exceptions"></a><b><a href="source/Direct.html#prop-Ext.Direct-exceptions">exceptions</a></b> : Object<div class="mdesc"><div class="short">Four types of possible exceptions which can occur:&#13;
 101 &lt;div class="mdetail-params"&gt;&#13;
 102 Ext.Direct.exceptions.TRANSPORT : '...</div><div class="long">Four types of possible exceptions which can occur:\r
 103 <div class="mdetail-params"><ul>\r
 104 <li><b><tt>Ext.Direct.exceptions.TRANSPORT</tt></b> : 'xhr'</li>\r
 105 <li><b><tt>Ext.Direct.exceptions.PARSE</tt></b> : 'parse'</li>\r
 106 <li><b><tt>Ext.Direct.exceptions.LOGIN</tt></b> : 'login'</li>\r
 107 <li><b><tt>Ext.Direct.exceptions.SERVER</tt></b> : 'exception'</li>\r
 108 </ul></div></div></div></td><td class="msource">Direct</td></tr></tbody></table><a id="Ext.Direct-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">&nbsp;</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>(&nbsp;<code>Object&nbsp;object</code>&nbsp;)
 109     :
 110                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 111     :
 112                                         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.
 113 <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.
 114 properties. This may contain any of the following properties:<ul>
 115 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 116 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 117 <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>
 118 <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>
 119 <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
 120 by the specified number of milliseconds. If the event fires again within that time, the original
 121 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 122 <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>
 123 if the event was bubbled up from a child Observable.</div></li>
 124 </ul><br>
 125 <p>
 126 <b>Combining Options</b><br>
 127 Using the options argument, it is possible to combine different types of listeners:<br>
 128 <br>
 129 A delayed, one-time listener.
 130 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
 131     single: true,
 132     delay: 100
 133 });</code></pre>
 134 <p>
 135 <b>Attaching multiple handlers in 1 call</b><br>
 136 The method also allows for a single argument to be passed which is a config object containing properties
 137 which specify multiple handlers.
 138 <p>
 139 <pre><code>myGridPanel.on({
 140     <em>'click'</em> : {
 141         fn: this.onClick,
 142         scope: this,
 143         delay: 100
 144     },
 145     <em>'mouseover'</em> : {
 146         fn: this.onMouseOver,
 147         scope: this
 148     },
 149     <em>'mouseout'</em> : {
 150         fn: this.onMouseOut,
 151         scope: this
 152     }
 153 });</code></pre>
 154 <p>
 155 Or a shorthand syntax:<br>
 156 <pre><code>myGridPanel.on({
 157     <em>'click'</em> : this.onClick,
 158     <em>'mouseover'</em> : this.onMouseOver,
 159     <em>'mouseout'</em> : this.onMouseOut,
 160      scope: this
 161 });</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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-addProvider"></a><b><a href="source/Direct.html#method-Ext.Direct-addProvider">addProvider</a></b>(&nbsp;<code>Object/Array&nbsp;provider</code>&nbsp;)
 162     :
 163                                         void<div class="mdesc"><div class="short">Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.&#13;
 164 If the provider is...</div><div class="long">Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.\r
 165 If the provider is not already connected, it will auto-connect.\r
 166 <pre><code><b>var</b> pollProv = <b>new</b> Ext.direct.PollingProvider({\r
 167     url: <em>'php/poll2.php'</em>\r
 168 }); \r
 169 \r
 170 Ext.Direct.addProvider(\r
 171     {\r
 172         <em>"type"</em>:<em>"remoting"</em>,       <i>// create a <a href="output/Ext.direct.RemotingProvider.html" ext:cls="Ext.direct.RemotingProvider">Ext.direct.RemotingProvider</a> \r</i>
 173         <em>"url"</em>:<em>"php\/router.php"</em>, <i>// url to connect to the Ext.Direct server-side router.\r</i>
 174         <em>"actions"</em>:{              <i>// each property within the actions object represents a Class \r</i>
 175             <em>"TestAction"</em>:[       <i>// array of methods within each server side Class   \r</i>
 176             {\r
 177                 <em>"name"</em>:<em>"doEcho"</em>, <i>// name of method\r</i>
 178                 <em>"len"</em>:1\r
 179             },{\r
 180                 <em>"name"</em>:<em>"multiply"</em>,\r
 181                 <em>"len"</em>:1\r
 182             },{\r
 183                 <em>"name"</em>:<em>"doForm"</em>,\r
 184                 <em>"formHandler"</em>:true, <i>// handle form on server <b>with</b> Ext.Direct.Transaction \r</i>
 185                 <em>"len"</em>:1\r
 186             }]\r
 187         },\r
 188         <em>"namespace"</em>:<em>"myApplication"</em>,<i>// namespace to create the Remoting Provider <b>in</b>\r</i>
 189     },{\r
 190         type: <em>'polling'</em>, <i>// create a <a href="output/Ext.direct.PollingProvider.html" ext:cls="Ext.direct.PollingProvider">Ext.direct.PollingProvider</a> \r</i>
 191         url:  <em>'php/poll.php'</em>\r
 192     },\r
 193     pollProv <i>// reference to previously created instance\r</i>
 194 );</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>provider</code> : Object/Array<div class="sub-desc">Accepts either an Array of Provider descriptions (an instance\r
 195 or config object for a Provider) or any number of Provider descriptions as arguments.  Each\r
 196 Provider description instructs Ext.Direct how to create client-side stub methods.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Direct</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)
 197     :
 198                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)
 199     :
 200                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 201 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>
 202 <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>)
 203 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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-getProvider"></a><b><a href="source/Direct.html#method-Ext.Direct-getProvider">getProvider</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)
 204     :
 205                                         void<div class="mdesc"><div class="short">Retrieve a provider by the&#13;
 206 id specified when the provider is&#13;
 207 added.</div><div class="long">Retrieve a <a href="output/Ext.direct.Provider.html" ext:cls="Ext.direct.Provider">provider</a> by the\r
 208 <b><tt><a href="output/Ext.direct.Provider.html#Ext.direct.Provider-id" ext:member="id" ext:cls="Ext.direct.Provider">id</a></tt></b> specified when the provider is\r
 209 <a href="output/Ext.Direct.html#Ext.Direct-addProvider" ext:member="addProvider" ext:cls="Ext.Direct">added</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">Unique identifier assigned to the provider when calling <a href="output/Ext.Direct.html#Ext.Direct-addProvider" ext:member="addProvider" ext:cls="Ext.Direct">addProvider</a></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Direct</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)
 210     :
 211                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 212     :
 213                                         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.
 214 <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">&nbsp;</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>()
 215     :
 216                                         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">&nbsp;</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>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)
 217     :
 218                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 219     :
 220                                         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">&nbsp;</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>()
 221     :
 222                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
 223 If events were suspended using the queueSuspended parameter, then all
 224 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>)
 225 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 226 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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
 227     :
 228                                         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
 229 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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 230     :
 231                                         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.Direct-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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-event"></a><b><a href="source/Direct.html#event-Ext.Direct-event">event</a></b> :
 232                                       (&nbsp;<code>event&nbsp;e</code>,&nbsp;<code>Ext.direct.Provider&nbsp;provider</code>&nbsp;)
 233     <div class="mdesc"><div class="short">Fires after an event.</div><div class="long">Fires after an event.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>e</code> : event<div class="sub-desc">The <a href="output/Ext.Direct.html#Ext.Direct-eventTypes" ext:member="eventTypes" ext:cls="Ext.Direct">Ext.Direct.Event type</a> that occurred.</div></li><li><code>provider</code> : Ext.direct.Provider<div class="sub-desc">The <a href="output/Ext.direct.Provider.html" ext:cls="Ext.direct.Provider">Provider</a>.</div></li></ul></div></div></div></td><td class="msource">Direct</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Direct-exception"></a><b><a href="source/Direct.html#event-Ext.Direct-exception">exception</a></b> :
 234                                       (&nbsp;<code>event&nbsp;e</code>&nbsp;)
 235     <div class="mdesc"><div class="short">Fires after an event exception.</div><div class="long">Fires after an event exception.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>e</code> : event<div class="sub-desc">The <a href="output/Ext.Direct.html#Ext.Direct-eventTypes" ext:member="eventTypes" ext:cls="Ext.Direct">Ext.Direct.Event type</a> that occurred.</div></li></ul></div></div></div></td><td class="msource">Direct</td></tr></tbody></table></div>