Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.direct.Provider.html
1 <!DOCTYPE html><html><head><title>Ext.direct.Provider | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.direct.Provider',
13         docClass: 'Ext.direct.Provider',
14         docReq: 'Ext.direct.Provider',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Provider.html#Ext-direct.Provider';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","hasListener","isConnected","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","un"],"cfgs":["id","listeners"],"properties":["connect","disconnect"],"events":["connect","data","disconnect","exception"],"subclasses":["Ext.direct.JsonProvider"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Provider.html#Ext-direct.Provider" target="_blank">Ext.direct.Provider</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>Ext.direct.Provider is an abstract class meant to be extended.</p>
38
39
40
41
42 <p>For example ExtJs implements the following subclasses:</p>
43
44
45 <pre class="prettyprint"><code>Provider
46 |
47 +---<a href="Ext.direct.JsonProvider.html" rel="Ext.direct.JsonProvider" class="docClass">JsonProvider</a> 
48     |
49     +---<a href="Ext.direct.PollingProvider.html" rel="Ext.direct.PollingProvider" class="docClass">PollingProvider</a>   
50     |
51     +---<a href="Ext.direct.RemotingProvider.html" rel="Ext.direct.RemotingProvider" class="docClass">RemotingProvider</a>   
52 </code></pre>
53
54 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-id" class="member f ni"><a href="Ext.direct.Provider.html#config-id" rel="config-id" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-cfg-id" class="viewSource">view source</a></div><a name="id"></a><a name="config-id"></a><a href="Ext.direct.Provider.html#" rel="config-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short">The unique id of the provider (defaults to an auto-assigned id).
55 You should assign an id if you need to be able to ac...</div><div class="long"><p>The unique id of the provider (defaults to an <a href="Ext.html#id" rel="Ext#id" class="docClass">auto-assigned id</a>).
56 You should assign an id if you need to be able to access the provider later and you do
57 not have an object reference available, for example:</p>
58
59 <pre><code>Ext.direct.Manager.addProvider({
60     type: 'polling',
61     url:  'php/poll.php',
62     id:   'poll-provider'
63 });     
64 var p = <a href="Ext.direct.Manager.html" rel="Ext.direct.Manager" class="docClass">Ext.direct.Manager</a>.<a href="Ext.direct.Manager.html#getProvider" rel="Ext.direct.Manager#getProvider" class="docClass">getProvider</a>('poll-provider');
65 p.disconnect();
66 </code></pre>
67
68 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.direct.Provider.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.direct.Provider.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
69 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
70 object during initialization.  This should be a valid listeners config object as specified in the
71 <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
72
73 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
74
75
76 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
77
78
79 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
80 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
81 events directly from a child element of a Component, we need to specify the <code>element</code> option to
82 identify the Component property to add a DOM listener to:</p>
83
84 <pre><code>new Ext.panel.Panel({
85     width: 400,
86     height: 200,
87     dockedItems: [{
88         xtype: 'toolbar'
89     }],
90     listeners: {
91         click: {
92             element: 'el', //bind to the underlying el property on the panel
93             fn: function(){ console.log('click el'); }
94         },
95         dblclick: {
96             element: 'body', //bind to the underlying body property on the panel
97             fn: function(){ console.log('dblclick body'); }
98         }
99     }
100 });
101 </code></pre>
102
103
104 <p></p></p>
105 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-connect" class="member f ni"><a href="Ext.direct.Provider.html#property-connect" rel="property-connect" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-property-connect" class="viewSource">view source</a></div><a name="connect"></a><a name="property-connect"></a><a href="Ext.direct.Provider.html#" rel="property-connect" class="cls expand">connect</a><span> : Object</span></div><div class="description"><div class="short"><p>Abstract methods for subclasses to implement.</p>
106 </div><div class="long"><p>Abstract methods for subclasses to implement.</p>
107 </div></div></div><div id="property-disconnect" class="member ni"><a href="Ext.direct.Provider.html#property-disconnect" rel="property-disconnect" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-property-disconnect" class="viewSource">view source</a></div><a name="disconnect"></a><a name="property-disconnect"></a><a href="Ext.direct.Provider.html#" rel="property-disconnect" class="cls expand">disconnect</a><span> : Object</span></div><div class="description"><div class="short"><p>Abstract methods for subclasses to implement.</p>
108 </div><div class="long"><p>Abstract methods for subclasses to implement.</p>
109 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.direct.Provider.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.direct.Provider.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
110 <span class="pre">Object/String o, String </span>)
111  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
112 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
113 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
114 or the first event name string if multiple event names are being passed as separate parameters.</p>
115 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
116 Usage:</p>
117
118 <pre><code>this.addEvents('storeloaded', 'storecleared');
119 </code></pre>
120
121 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
122 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.direct.Provider.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.direct.Provider.html#" rel="method-addListener" class="cls expand">addListener</a>(
123 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
124  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
125 </div><div class="long"><p>Appends an event handler to this object.</p>
126 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
127 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
128 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
129 <b>If omitted, defaults to the object which fired the event.</b></p>
130 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
131 properties. This may contain any of the following properties:<ul>
132 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
133 <b>If omitted, defaults to the object which fired the event.</b></div></li>
134 <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>
135 <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>
136 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
137 by the specified number of milliseconds. If the event fires again within that time, the original
138 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
139 <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>
140 if the event was bubbled up from a child Observable.</div></li>
141 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
142 The name of a Component property which references an element to add a listener to.</p>
143
144 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
145 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
146 <pre><code>new Ext.panel.Panel({
147     title: 'The title',
148     listeners: {
149         click: this.handlePanelClick,
150         element: 'body'
151     }
152 });
153 </code></pre></p>
154
155
156 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
157
158
159 <p></div></li>
160 </ul><br></p>
161
162 <p>
163 <b>Combining Options</b><br>
164 Using the options argument, it is possible to combine different types of listeners:<br>
165 <br>
166 A delayed, one-time listener.
167 <pre><code>myPanel.on('hide', this.handleClick, this, {
168 single: true,
169 delay: 100
170 });</code></pre>
171 <p>
172 <b>Attaching multiple handlers in 1 call</b><br>
173 The method also allows for a single argument to be passed which is a config object containing properties
174 which specify multiple events. For example:
175 <pre><code>myGridPanel.on({
176     cellClick: this.onCellClick,
177     mouseover: this.onMouseOver,
178     mouseout: this.onMouseOut,
179     scope: this // Important. Ensure "this" is correct during handler execution
180 });
181 </code></pre>.
182 <p>
183
184 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
185 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.direct.Provider.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.direct.Provider.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
186 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
187  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
188 is destroyed.
189
190 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
191 is destroyed.
192
193 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
194 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
195 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
196 is the handler function.</p>
197 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
198 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
199 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
200 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
201 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
202 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.direct.Provider.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.direct.Provider.html#" rel="method-capture" class="cls expand">capture</a>(
203 <span class="pre">Observable o, Function fn, [Object scope]</span>)
204  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
205 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
206 to the supplied function with the event name + standard signature of the event
207 <b>before</b> the event is fired. If the supplied function returns false,
208 the event will not fire.</p>
209 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
210 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
211 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
212 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
213 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.direct.Provider.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.direct.Provider.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
214 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
215 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
216 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.direct.Provider.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.direct.Provider.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
217 </div><div class="long"><p>Removes all managed listeners for this object.</p>
218 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
219 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.direct.Provider.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.direct.Provider.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
220 <span class="pre">String/Array events</span>)
221  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
222 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
223 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
224
225
226 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
227 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
228 access the required target more quickly.</p>
229
230
231 <p>Example:</p>
232
233
234 <pre><code>Ext.override(Ext.form.field.Base, {
235 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
236 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
237     this.enableBubble('change');
238 }),
239
240 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
241 getBubbleTarget : function() {
242     if (!this.formPanel) {
243         this.formPanel = this.findParentByType('form');
244     }
245     return this.formPanel;
246 }
247 });
248
249 var myForm = new Ext.formPanel({
250 title: 'User Details',
251 items: [{
252     ...
253 }],
254 listeners: {
255     change: function() {
256         // Title goes red if form has been modified.
257         myForm.header.setStyle('color', 'red');
258     }
259 }
260 });
261 </code></pre>
262
263 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
264 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
265 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.direct.Provider.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.direct.Provider.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
266 <span class="pre">String eventName, Object... args</span>)
267  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
268
269
270 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
271
272
273 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
274 by calling <a href="Ext.direct.Provider.html#enableBubble" rel="Ext.direct.Provider#enableBubble" class="docClass">enableBubble</a>.</p>
275
276 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
277 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
278 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
279 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.direct.Provider.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.direct.Provider.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
280 <span class="pre">String eventName</span>)
281  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
282 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
283 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
284 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
285 </li></ul></div></div></div><div id="method-isConnected" class="member ni"><a href="Ext.direct.Provider.html#method-isConnected" rel="method-isConnected" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-method-isConnected" class="viewSource">view source</a></div><a name="isConnected"></a><a name="method-isConnected"></a><a href="Ext.direct.Provider.html#" rel="method-isConnected" class="cls expand">isConnected</a> : void</div><div class="description"><div class="short"><p>Returns whether or not the server-side is currently connected.
286 Abstract method for subclasses to implement.</p>
287 </div><div class="long"><p>Returns whether or not the server-side is currently connected.
288 Abstract method for subclasses to implement.</p>
289 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
290 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.direct.Provider.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.direct.Provider.html#" rel="method-observe" class="cls expand">observe</a>(
291 <span class="pre">Function c, Object listeners</span>)
292  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
293
294 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
295
296 <p>This makes any event fired on any instance of the passed class also fire a single event through
297 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
298
299 <p>Usage:</p>
300
301 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
302 Ext.data.Connection.on('beforerequest', function(con, options) {
303     console.log('Ajax request made to ' + options.url);
304 });
305 </code></pre>
306 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
307 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a>.</p>
308 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
309 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.direct.Provider.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.direct.Provider.html#" rel="method-on" class="cls expand">on</a>(
310 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
311  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a>.)</p>
312 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a>.)</p>
313 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
314 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
315 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
316 <b>If omitted, defaults to the object which fired the event.</b></p>
317 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
318 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
319 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.direct.Provider.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.direct.Provider.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
320 <span class="pre">Object origin, Array events, Object prefix</span>)
321  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
322 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
323 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
324 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
325 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
326 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
327 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.direct.Provider.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.direct.Provider.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
328 <span class="pre">Observable o</span>)
329  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
330 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
331 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
332 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
333 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.direct.Provider.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.direct.Provider.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
334 <span class="pre">String eventName, Function handler, [Object scope]</span>)
335  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
336 </div><div class="long"><p>Removes an event handler.</p>
337 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
338 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a> call.</b></p>
339 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
340 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
341 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.direct.Provider.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.direct.Provider.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
342 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
343  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.direct.Provider.html#mon" rel="Ext.direct.Provider#mon" class="docClass">mon</a> method.</p>
344 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.direct.Provider.html#mon" rel="Ext.direct.Provider#mon" class="docClass">mon</a> method.</p>
345 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
346 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
347 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
348 is the handler function.</p>
349 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
350 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
351 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
352 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.direct.Provider.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.direct.Provider.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
353 If events were suspended using the queueSuspended parameter, then all
354 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.direct.Provider.html#suspendEvents" rel="Ext.direct.Provider#suspendEvents" class="docClass">suspendEvents</a>)
355 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
356 events fired during event suspension will be sent to any listeners now.</p>
357 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
358 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.direct.Provider.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.direct.Provider.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
359 <span class="pre">Boolean queueSuspended</span>)
360  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.direct.Provider.html#resumeEvents" rel="Ext.direct.Provider#resumeEvents" class="docClass">resumeEvents</a>)</p>
361 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.direct.Provider.html#resumeEvents" rel="Ext.direct.Provider#resumeEvents" class="docClass">resumeEvents</a>)</p>
362 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
363 after the <a href="Ext.direct.Provider.html#resumeEvents" rel="Ext.direct.Provider#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
364 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
365 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.direct.Provider.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.direct.Provider.html#" rel="method-un" class="cls expand">un</a>(
366 <span class="pre">String eventName, Function handler, [Object scope]</span>)
367  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.direct.Provider.html#removeListener" rel="Ext.direct.Provider#removeListener" class="docClass">removeListener</a>.)</p>
368 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.direct.Provider.html#removeListener" rel="Ext.direct.Provider#removeListener" class="docClass">removeListener</a>.)</p>
369 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
370 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.direct.Provider.html#addListener" rel="Ext.direct.Provider#addListener" class="docClass">addListener</a> call.</b></p>
371 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
373 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-connect" class="member f ni"><a href="Ext.direct.Provider.html#event-connect" rel="event-connect" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-event-connect" class="viewSource">view source</a></div><a name="connect"></a><a name="event-connect"></a><a href="Ext.direct.Provider.html#" rel="event-connect" class="cls expand">connect</a>(
374 <span class="pre">Ext.direct.Provider provider</span>)
375 </div><div class="description"><div class="short"><p>Fires when the Provider connects to the server-side</p>
376 </div><div class="long"><p>Fires when the Provider connects to the server-side</p>
377 <h3 class="pa">Parameters</h3><ul><li><span class="pre">provider</span> : Ext.direct.Provider<div class="sub-desc"><p>The <a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="docClass">Provider</a>.</p>
378 </div></li></ul></div></div></div><div id="event-data" class="member ni"><a href="Ext.direct.Provider.html#event-data" rel="event-data" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-event-data" class="viewSource">view source</a></div><a name="data"></a><a name="event-data"></a><a href="Ext.direct.Provider.html#" rel="event-data" class="cls expand">data</a>(
379 <span class="pre">Ext.direct.Provider provider, event e</span>)
380 </div><div class="description"><div class="short"><p>Fires when the Provider receives data from the server-side</p>
381 </div><div class="long"><p>Fires when the Provider receives data from the server-side</p>
382 <h3 class="pa">Parameters</h3><ul><li><span class="pre">provider</span> : Ext.direct.Provider<div class="sub-desc"><p>The <a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="docClass">Provider</a>.</p>
383 </div></li><li><span class="pre">e</span> : event<div class="sub-desc"><p>The Ext.Direct.Event type that occurred.</p>
384 </div></li></ul></div></div></div><div id="event-disconnect" class="member ni"><a href="Ext.direct.Provider.html#event-disconnect" rel="event-disconnect" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-event-disconnect" class="viewSource">view source</a></div><a name="disconnect"></a><a name="event-disconnect"></a><a href="Ext.direct.Provider.html#" rel="event-disconnect" class="cls expand">disconnect</a>(
385 <span class="pre">Ext.direct.Provider provider</span>)
386 </div><div class="description"><div class="short"><p>Fires when the Provider disconnects from the server-side</p>
387 </div><div class="long"><p>Fires when the Provider disconnects from the server-side</p>
388 <h3 class="pa">Parameters</h3><ul><li><span class="pre">provider</span> : Ext.direct.Provider<div class="sub-desc"><p>The <a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="docClass">Provider</a>.</p>
389 </div></li></ul></div></div></div><div id="event-exception" class="member ni"><a href="Ext.direct.Provider.html#event-exception" rel="event-exception" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Provider.html" class="definedIn docClass">Ext.direct.Provider</a><br/><a href="../source/Provider.html#Ext-direct.Provider-event-exception" class="viewSource">view source</a></div><a name="exception"></a><a name="event-exception"></a><a href="Ext.direct.Provider.html#" rel="event-exception" class="cls expand">exception</a></div><div class="description"><div class="short"><p>Fires when the Provider receives an exception from the server-side</p>
390 </div><div class="long"><p>Fires when the Provider receives an exception from the server-side</p>
391 </div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>