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"><a href="source/Direct.html#cls-Ext.Direct">Direct.js</a></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>
   2 <p>Ext.Direct aims to streamline communication between the client and server
   3 by providing a single interface that reduces the amount of common code
   4 typically required to validate data and handle returned data packets
   5 (reading data, error conditions, etc).</p>
   6 <p>The Ext.direct namespace includes several classes for a closer integration
   7 with the server-side. The Ext.data namespace also includes classes for working
   8 with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>
   9 <p><b><u>Specification</u></b></p>
  10 <p>For additional information consult the
  11 <a href="http://extjs.com/products/extjs/direct.php">Ext.Direct Specification</a>.</p>
  12 <p><b><u>Providers</u></b></p>
  13 <p>Ext.Direct uses a provider architecture, where one or more providers are
  14 used to transport data to and from the server. There are several providers
  15 that exist in the core at the moment:</p><div class="mdetail-params"><ul>
  16 <li><a href="output/Ext.direct.JsonProvider.html" ext:cls="Ext.direct.JsonProvider">JsonProvider</a> for simple JSON operations</li>
  17 <li><a href="output/Ext.direct.PollingProvider.html" ext:cls="Ext.direct.PollingProvider">PollingProvider</a> for repeated requests</li>
  18 <li><a href="output/Ext.direct.RemotingProvider.html" ext:cls="Ext.direct.RemotingProvider">RemotingProvider</a> exposes server side
  19 on the client.</li>
  20 </ul></div>
  21 <p>A provider does not need to be invoked directly, providers are added via
  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>
  23 <p><b><u>Router</u></b></p>
  24 <p>Ext.Direct utilizes a "router" on the server to direct requests from the client
  25 to the appropriate server-side method. Because the Ext.Direct API is completely
  26 platform-agnostic, you could completely swap out a Java based server solution
  27 and replace it with one that uses C# without changing the client side JavaScript
  28 at all.</p>
  29 <p><b><u>Server side events</u></b></p>
  30 <p>Custom events from the server may be handled by the client by adding
  31 listeners, for example:</p>
  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>}
  33
  34 <i>// add a handler <b>for</b> a <em>'message'</em> event sent by the server</i>
  35 Ext.Direct.on(<em>'message'</em>, <b>function</b>(e){
  36     out.append(String.format(<em>'&lt;p>&lt;i>{0}&lt;/i>&lt;/p>'</em>, e.data));
  37             out.el.scrollTo(<em>'t'</em>, 100000, true);
  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:
  94 &lt;div class="mdetail-params"&gt;
  95 event : Ext....</div><div class="long">Each event type implements a getData() method. The default event types are:
  96 <div class="mdetail-params"><ul>
  97 <li><b><tt>event</tt></b> : Ext.Direct.Event</li>
  98 <li><b><tt>exception</tt></b> : Ext.Direct.ExceptionEvent</li>
  99 <li><b><tt>rpc</tt></b> : Ext.Direct.RemotingEvent</li>
 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:
 101 &lt;div class="mdetail-params"&gt;
 102 Ext.Direct.exceptions.TRANSPORT : 'xh...</div><div class="long">Four types of possible exceptions which can occur:
 103 <div class="mdetail-params"><ul>
 104 <li><b><tt>Ext.Direct.exceptions.TRANSPORT</tt></b> : 'xhr'</li>
 105 <li><b><tt>Ext.Direct.exceptions.PARSE</tt></b> : 'parse'</li>
 106 <li><b><tt>Ext.Direct.exceptions.LOGIN</tt></b> : 'login'</li>
 107 <li><b><tt>Ext.Direct.exceptions.SERVER</tt></b> : 'exception'</li>
 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|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)
 109     :
 110                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
 111 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
 112 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</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#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;)
 113     :
 114                                         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.
 115 <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.
 116 properties. This may contain any of the following properties:<ul>
 117 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 118 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 119 <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>
 120 <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>
 121 <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
 122 by the specified number of milliseconds. If the event fires again within that time, the original
 123 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 124 <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>
 125 if the event was bubbled up from a child Observable.</div></li>
 126 </ul><br>
 127 <p>
 128 <b>Combining Options</b><br>
 129 Using the options argument, it is possible to combine different types of listeners:<br>
 130 <br>
 131 A delayed, one-time listener.
 132 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
 133 single: true,
 134 delay: 100
 135 });</code></pre>
 136 <p>
 137 <b>Attaching multiple handlers in 1 call</b><br>
 138 The method also allows for a single argument to be passed which is a config object containing properties
 139 which specify multiple handlers.
 140 <p>
 141 <pre><code>myGridPanel.on({
 142 <em>'click'</em> : {
 143     fn: this.onClick,
 144     scope: this,
 145     delay: 100
 146 },
 147 <em>'mouseover'</em> : {
 148     fn: this.onMouseOver,
 149     scope: this
 150 },
 151 <em>'mouseout'</em> : {
 152     fn: this.onMouseOut,
 153     scope: this
 154 }
 155 });</code></pre>
 156 <p>
 157 Or a shorthand syntax:<br>
 158 <pre><code>myGridPanel.on({
 159 <em>'click'</em> : this.onClick,
 160 <em>'mouseover'</em> : this.onMouseOver,
 161 <em>'mouseout'</em> : this.onMouseOut,
 162  scope: this
 163 });</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;)
 164     :
 165                                         void<div class="mdesc"><div class="short">Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
 166 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.
 167 If the provider is not already connected, it will auto-connect.
 168 <pre><code><b>var</b> pollProv = <b>new</b> Ext.direct.PollingProvider({
 169     url: <em>'php/poll2.php'</em>
 170 });
 171
 172 Ext.Direct.addProvider(
 173     {
 174         <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></i>
 175         <em>"url"</em>:<em>"php\/router.php"</em>, <i>// url to connect to the Ext.Direct server-side router.</i>
 176         <em>"actions"</em>:{              <i>// each property within the actions object represents a Class</i>
 177             <em>"TestAction"</em>:[       <i>// array of methods within each server side Class</i>
 178             {
 179                 <em>"name"</em>:<em>"doEcho"</em>, <i>// name of method</i>
 180                 <em>"len"</em>:1
 181             },{
 182                 <em>"name"</em>:<em>"multiply"</em>,
 183                 <em>"len"</em>:1
 184             },{
 185                 <em>"name"</em>:<em>"doForm"</em>,
 186                 <em>"formHandler"</em>:true, <i>// handle form on server <b>with</b> Ext.Direct.Transaction</i>
 187                 <em>"len"</em>:1
 188             }]
 189         },
 190         <em>"namespace"</em>:<em>"myApplication"</em>,<i>// namespace to create the Remoting Provider <b>in</b></i>
 191     },{
 192         type: <em>'polling'</em>, <i>// create a <a href="output/Ext.direct.PollingProvider.html" ext:cls="Ext.direct.PollingProvider">Ext.direct.PollingProvider</a></i>
 193         url:  <em>'php/poll.php'</em>
 194     },
 195     pollProv <i>// reference to previously created instance</i>
 196 );</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
 197 or config object for a Provider) or any number of Provider descriptions as arguments.  Each
 198 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>String/Array&nbsp;events</code>&nbsp;)
 199     :
 200                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
 201 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
 202 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
 203 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
 204 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
 205 access the required target more quickly.</p>
 206 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
 207     <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble</i>
 208     initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
 209         this.enableBubble(<em>'change'</em>);
 210     }),
 211
 212     <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.</i>
 213     getBubbleTarget : <b>function</b>() {
 214         <b>if</b> (!this.formPanel) {
 215             this.formPanel = this.findParentByType(<em>'form'</em>);
 216         }
 217         <b>return</b> this.formPanel;
 218     }
 219 });
 220
 221 <b>var</b> myForm = <b>new</b> Ext.formPanel({
 222     title: <em>'User Details'</em>,
 223     items: [{
 224         ...
 225     }],
 226     listeners: {
 227         change: <b>function</b>() {
 228             <i>// Title goes red <b>if</b> form has been modified.</i>
 229             myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
 230         }
 231     }
 232 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</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;)
 233     :
 234                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 235 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>
 236 <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>)
 237 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;)
 238     :
 239                                         void<div class="mdesc"><div class="short">Retrieve a provider by the
 240 id specified when the provider is
 241 added.</div><div class="long">Retrieve a <a href="output/Ext.direct.Provider.html" ext:cls="Ext.direct.Provider">provider</a> by the
 242 <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
 243 <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;)
 244     :
 245                                         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;)
 246     :
 247                                         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.
 248 <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>()
 249     :
 250                                         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;)
 251     :
 252                                         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;)
 253     :
 254                                         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>()
 255     :
 256                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
 257 If events were suspended using the queueSuspended parameter, then all
 258 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>)
 259 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 260 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;)
 261     :
 262                                         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
 263 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;)
 264     :
 265                                         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> :
 266                                       (&nbsp;<code>event&nbsp;e</code>,&nbsp;<code>Ext.direct.Provider&nbsp;provider</code>&nbsp;)
 267     <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> :
 268                                       (&nbsp;<code>event&nbsp;e</code>&nbsp;)
 269     <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>