Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.direct.Manager.html
1 <!DOCTYPE html><html><head><title>Ext.direct.Manager | 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.Manager',
13         docClass: 'Ext.direct.Manager',
14         docReq: 'Ext.direct.Manager',
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 = 'Manager2.html#Ext-direct.Manager';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","addProvider","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","getProvider","hasListener","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","removeProvider","resumeEvents","suspendEvents","un"],"cfgs":["listeners"],"properties":[],"events":["event","exception"],"subclasses":[]};
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/Manager2.html#Ext-direct.Manager" target="_blank">Ext.direct.Manager</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><b><u>Overview</u></b></p>
38
39
40
41
42 <p>Ext.Direct aims to streamline communication between the client and server
43 by providing a single interface that reduces the amount of common code
44 typically required to validate data and handle returned data packets
45 (reading data, error conditions, etc).</p>
46
47
48
49
50 <p>The Ext.direct namespace includes several classes for a closer integration
51 with the server-side. The Ext.data namespace also includes classes for working
52 with Ext.data.Stores which are backed by data from an Ext.Direct method.</p>
53
54
55
56
57 <p><b><u>Specification</u></b></p>
58
59
60
61
62 <p>For additional information consult the
63 <a href="http://sencha.com/products/extjs/extdirect">Ext.Direct Specification</a>.</p>
64
65
66
67
68 <p><b><u>Providers</u></b></p>
69
70
71
72
73 <p>Ext.Direct uses a provider architecture, where one or more providers are
74 used to transport data to and from the server. There are several providers
75 that exist in the core at the moment:</p>
76
77
78 <div class="mdetail-params"><ul>
79
80 <li><a href="Ext.direct.JsonProvider.html" rel="Ext.direct.JsonProvider" class="docClass">JsonProvider</a> for simple JSON operations</li>
81 <li><a href="Ext.direct.PollingProvider.html" rel="Ext.direct.PollingProvider" class="docClass">PollingProvider</a> for repeated requests</li>
82 <li><a href="Ext.direct.RemotingProvider.html" rel="Ext.direct.RemotingProvider" class="docClass">RemotingProvider</a> exposes server side
83 on the client.</li>
84 </ul></div>
85
86
87
88
89 <p>A provider does not need to be invoked directly, providers are added via
90 <a href="Ext.direct.Manager.html" rel="Ext.direct.Manager" class="docClass">Ext.direct.Manager</a>.<a href="Ext.direct.Manager.html#add" rel="Ext.direct.Manager#add" class="docClass">add</a>.</p>
91
92
93
94
95 <p><b><u>Router</u></b></p>
96
97
98
99
100 <p>Ext.Direct utilizes a "router" on the server to direct requests from the client
101 to the appropriate server-side method. Because the Ext.Direct API is completely
102 platform-agnostic, you could completely swap out a Java based server solution
103 and replace it with one that uses C# without changing the client side JavaScript
104 at all.</p>
105
106
107
108
109 <p><b><u>Server side events</u></b></p>
110
111
112
113
114 <p>Custom events from the server may be handled by the client by adding
115 listeners, for example:</p>
116
117
118 <pre class="prettyprint"><code>{"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
119
120 // add a handler for a 'message' event sent by the server
121 Ext.direct.Manager.on('message', function(e){
122     out.append(String.format('&lt;p>&lt;i>{0}&lt;/i>&lt;/p>', e.data));
123             out.el.scrollTo('t', 100000, true);
124 });
125 </code></pre>
126
127 <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-listeners" class="member f inherited"><a href="Ext.direct.Manager.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.Manager.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
128 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
129 object during initialization.  This should be a valid listeners config object as specified in the
130 <a href="Ext.direct.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
131
132 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
133
134
135 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
136
137
138 <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
139 <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
140 events directly from a child element of a Component, we need to specify the <code>element</code> option to
141 identify the Component property to add a DOM listener to:</p>
142
143 <pre><code>new Ext.panel.Panel({
144     width: 400,
145     height: 200,
146     dockedItems: [{
147         xtype: 'toolbar'
148     }],
149     listeners: {
150         click: {
151             element: 'el', //bind to the underlying el property on the panel
152             fn: function(){ console.log('click el'); }
153         },
154         dblclick: {
155             element: 'body', //bind to the underlying body property on the panel
156             fn: function(){ console.log('dblclick body'); }
157         }
158     }
159 });
160 </code></pre>
161
162
163 <p></p></p>
164 </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.Manager.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.Manager.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
165 <span class="pre">Object/String o, String </span>)
166  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
167 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
168 <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>
169 or the first event name string if multiple event names are being passed as separate parameters.</p>
170 </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.
171 Usage:</p>
172
173 <pre><code>this.addEvents('storeloaded', 'storecleared');
174 </code></pre>
175
176 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
177 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-addListener" class="cls expand">addListener</a>(
178 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
179  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
180 </div><div class="long"><p>Appends an event handler to this object.</p>
181 <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>
182 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
183 </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.
184 <b>If omitted, defaults to the object which fired the event.</b></p>
185 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
186 properties. This may contain any of the following properties:<ul>
187 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
188 <b>If omitted, defaults to the object which fired the event.</b></div></li>
189 <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>
190 <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>
191 <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
192 by the specified number of milliseconds. If the event fires again within that time, the original
193 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
194 <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>
195 if the event was bubbled up from a child Observable.</div></li>
196 <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>
197 The name of a Component property which references an element to add a listener to.</p>
198
199 <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
200 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
201 <pre><code>new Ext.panel.Panel({
202     title: 'The title',
203     listeners: {
204         click: this.handlePanelClick,
205         element: 'body'
206     }
207 });
208 </code></pre></p>
209
210
211 <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>
212
213
214 <p></div></li>
215 </ul><br></p>
216
217 <p>
218 <b>Combining Options</b><br>
219 Using the options argument, it is possible to combine different types of listeners:<br>
220 <br>
221 A delayed, one-time listener.
222 <pre><code>myPanel.on('hide', this.handleClick, this, {
223 single: true,
224 delay: 100
225 });</code></pre>
226 <p>
227 <b>Attaching multiple handlers in 1 call</b><br>
228 The method also allows for a single argument to be passed which is a config object containing properties
229 which specify multiple events. For example:
230 <pre><code>myGridPanel.on({
231     cellClick: this.onCellClick,
232     mouseover: this.onMouseOver,
233     mouseout: this.onMouseOut,
234     scope: this // Important. Ensure "this" is correct during handler execution
235 });
236 </code></pre>.
237 <p>
238
239 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
240 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
241 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
242  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
243 is destroyed.
244
245 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
246 is destroyed.
247
248 <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>
249 </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>
250 </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
251 is the handler function.</p>
252 </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
253 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
254 </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
255 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
256 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
257 </li></ul></div></div></div><div id="method-addProvider" class="member ni"><a href="Ext.direct.Manager.html#method-addProvider" rel="method-addProvider" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Manager.html" class="definedIn docClass">Ext.direct.Manager</a><br/><a href="../source/Manager2.html#Ext-direct.Manager-method-addProvider" class="viewSource">view source</a></div><a name="addProvider"></a><a name="method-addProvider"></a><a href="Ext.direct.Manager.html#" rel="method-addProvider" class="cls expand">addProvider</a>(
258 <span class="pre">Object/Array provider</span>)
259  : void</div><div class="description"><div class="short">Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
260 If the provider is ...</div><div class="long"><p>Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods.
261 If the provider is not already connected, it will auto-connect.</p>
262
263 <pre><code>var pollProv = new Ext.direct.PollingProvider({
264     url: 'php/poll2.php'
265 });
266
267 Ext.direct.Manager.addProvider({
268     "type":"remoting",       // create a <a href="Ext.direct.RemotingProvider.html" rel="Ext.direct.RemotingProvider" class="docClass">Ext.direct.RemotingProvider</a>
269     "url":"php\/router.php", // url to connect to the Ext.Direct server-side router.
270     "actions":{              // each property within the actions object represents a Class
271         "TestAction":[       // array of methods within each server side Class
272         {
273             "name":"doEcho", // name of method
274             "len":1
275         },{
276             "name":"multiply",
277             "len":1
278         },{
279             "name":"doForm",
280             "formHandler":true, // handle form on server with Ext.Direct.Transaction
281             "len":1
282         }]
283     },
284     "namespace":"myApplication",// namespace to create the Remoting Provider in
285 },{
286     type: 'polling', // create a <a href="Ext.direct.PollingProvider.html" rel="Ext.direct.PollingProvider" class="docClass">Ext.direct.PollingProvider</a>
287     url:  'php/poll.php'
288 }, pollProv); // reference to previously created instance
289 </code></pre>
290
291 <h3 class="pa">Parameters</h3><ul><li><span class="pre">provider</span> : Object/Array<div class="sub-desc"><p>Accepts either an Array of Provider descriptions (an instance
292 or config object for a Provider) or any number of Provider descriptions as arguments.  Each
293 Provider description instructs Ext.Direct how to create client-side stub methods.</p>
294 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
295 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-capture" class="cls expand">capture</a>(
296 <span class="pre">Observable o, Function fn, [Object scope]</span>)
297  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
298 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
299 to the supplied function with the event name + standard signature of the event
300 <b>before</b> the event is fired. If the supplied function returns false,
301 the event will not fire.</p>
302 <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>
303 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
304 </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>
305 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
306 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.direct.Manager.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.Manager.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>
307 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
308 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
309 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.direct.Manager.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.Manager.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>
310 </div><div class="long"><p>Removes all managed listeners for this object.</p>
311 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
312 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
313 <span class="pre">String/Array events</span>)
314  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
315 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
316 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
317
318
319 <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
320 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
321 access the required target more quickly.</p>
322
323
324 <p>Example:</p>
325
326
327 <pre><code>Ext.override(Ext.form.field.Base, {
328 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
329 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
330     this.enableBubble('change');
331 }),
332
333 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
334 getBubbleTarget : function() {
335     if (!this.formPanel) {
336         this.formPanel = this.findParentByType('form');
337     }
338     return this.formPanel;
339 }
340 });
341
342 var myForm = new Ext.formPanel({
343 title: 'User Details',
344 items: [{
345     ...
346 }],
347 listeners: {
348     change: function() {
349         // Title goes red if form has been modified.
350         myForm.header.setStyle('color', 'red');
351     }
352 }
353 });
354 </code></pre>
355
356 <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>
357 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
358 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
359 <span class="pre">String eventName, Object... args</span>)
360  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
361
362
363 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>
364
365
366 <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>)
367 by calling <a href="Ext.direct.Manager.html#enableBubble" rel="Ext.direct.Manager#enableBubble" class="docClass">enableBubble</a>.</p>
368
369 <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>
370 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
371 </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>
372 </li></ul></div></div></div><div id="method-getProvider" class="member ni"><a href="Ext.direct.Manager.html#method-getProvider" rel="method-getProvider" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Manager.html" class="definedIn docClass">Ext.direct.Manager</a><br/><a href="../source/Manager2.html#Ext-direct.Manager-method-getProvider" class="viewSource">view source</a></div><a name="getProvider"></a><a name="method-getProvider"></a><a href="Ext.direct.Manager.html#" rel="method-getProvider" class="cls expand">getProvider</a>(
373 <span class="pre">String/Ext.data.Provider id</span>)
374  : void</div><div class="description"><div class="short"><p>Retrieve a <a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="docClass">provider</a> by the
375 <b><tt><a href="Ext.direct.Provider.html#id" rel="Ext.direct.Provider#id" class="docClass">id</a></tt></b> specified when the provider is
376 <a href="Ext.direct.Manager.html#addProvider" rel="Ext.direct.Manager#addProvider" class="docClass">added</a>.</p>
377 </div><div class="long"><p>Retrieve a <a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="docClass">provider</a> by the
378 <b><tt><a href="Ext.direct.Provider.html#id" rel="Ext.direct.Provider#id" class="docClass">id</a></tt></b> specified when the provider is
379 <a href="Ext.direct.Manager.html#addProvider" rel="Ext.direct.Manager#addProvider" class="docClass">added</a>.</p>
380 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String/Ext.data.Provider<div class="sub-desc"><p>The id of the provider, or the provider instance.</p>
381 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
382 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
383 <span class="pre">String eventName</span>)
384  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
385 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
386 <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>
387 </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>
388 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-observe" class="cls expand">observe</a>(
389 <span class="pre">Function c, Object listeners</span>)
390  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
391
392 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>
393
394 <p>This makes any event fired on any instance of the passed class also fire a single event through
395 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
396
397 <p>Usage:</p>
398
399 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
400 Ext.data.Connection.on('beforerequest', function(con, options) {
401     console.log('Ajax request made to ' + options.url);
402 });
403 </code></pre>
404 <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>
405 </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.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a>.</p>
406 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
407 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-on" class="cls expand">on</a>(
408 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
409  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a>.)</p>
410 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a>.)</p>
411 <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>
412 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
413 </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.
414 <b>If omitted, defaults to the object which fired the event.</b></p>
415 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
416 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
417 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
418 <span class="pre">Object origin, Array events, Object prefix</span>)
419  : 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>
420 </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>
421 <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>
422 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
423 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
424 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
425 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
426 <span class="pre">Observable o</span>)
427  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
428 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
429 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
430 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
431 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
432 <span class="pre">String eventName, Function handler, [Object scope]</span>)
433  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
434 </div><div class="long"><p>Removes an event handler.</p>
435 <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>
436 </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.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a> call.</b></p>
437 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
438 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
439 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
440 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
441  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.direct.Manager.html#mon" rel="Ext.direct.Manager#mon" class="docClass">mon</a> method.</p>
442 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.direct.Manager.html#mon" rel="Ext.direct.Manager#mon" class="docClass">mon</a> method.</p>
443 <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>
444 </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>
445 </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
446 is the handler function.</p>
447 </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
448 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
449 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
450 </li></ul></div></div></div><div id="method-removeProvider" class="member ni"><a href="Ext.direct.Manager.html#method-removeProvider" rel="method-removeProvider" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Manager.html" class="definedIn docClass">Ext.direct.Manager</a><br/><a href="../source/Manager2.html#Ext-direct.Manager-method-removeProvider" class="viewSource">view source</a></div><a name="removeProvider"></a><a name="method-removeProvider"></a><a href="Ext.direct.Manager.html#" rel="method-removeProvider" class="cls expand">removeProvider</a>(
451 <span class="pre">String/Ext.direct.Provider provider</span>)
452  : Ext.direct.Provider</div><div class="description"><div class="short"><p>Removes the provider.</p>
453 </div><div class="long"><p>Removes the provider.</p>
454 <h3 class="pa">Parameters</h3><ul><li><span class="pre">provider</span> : String/Ext.direct.Provider<div class="sub-desc"><p>The provider instance or the id of the provider.</p>
455 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.direct.Provider</span>&nbsp; &nbsp;<p>The provider, null if not found.</p>
456 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
457 If events were suspended using the queueSuspended parameter, then all
458 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.direct.Manager.html#suspendEvents" rel="Ext.direct.Manager#suspendEvents" class="docClass">suspendEvents</a>)
459 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
460 events fired during event suspension will be sent to any listeners now.</p>
461 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
462 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
463 <span class="pre">Boolean queueSuspended</span>)
464  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.direct.Manager.html#resumeEvents" rel="Ext.direct.Manager#resumeEvents" class="docClass">resumeEvents</a>)</p>
465 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.direct.Manager.html#resumeEvents" rel="Ext.direct.Manager#resumeEvents" class="docClass">resumeEvents</a>)</p>
466 <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
467 after the <a href="Ext.direct.Manager.html#resumeEvents" rel="Ext.direct.Manager#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
468 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
469 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.direct.Manager.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.Manager.html#" rel="method-un" class="cls expand">un</a>(
470 <span class="pre">String eventName, Function handler, [Object scope]</span>)
471  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.direct.Manager.html#removeListener" rel="Ext.direct.Manager#removeListener" class="docClass">removeListener</a>.)</p>
472 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.direct.Manager.html#removeListener" rel="Ext.direct.Manager#removeListener" class="docClass">removeListener</a>.)</p>
473 <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>
474 </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.Manager.html#addListener" rel="Ext.direct.Manager#addListener" class="docClass">addListener</a> call.</b></p>
475 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
476 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
477 </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-event" class="member f ni"><a href="Ext.direct.Manager.html#event-event" rel="event-event" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Manager.html" class="definedIn docClass">Ext.direct.Manager</a><br/><a href="../source/Manager2.html#Ext-direct.Manager-event-event" class="viewSource">view source</a></div><a name="event"></a><a name="event-event"></a><a href="Ext.direct.Manager.html#" rel="event-event" class="cls expand">event</a>(
478 <span class="pre">event e, Ext.direct.Provider provider</span>)
479 </div><div class="description"><div class="short"><p>Fires after an event.</p>
480 </div><div class="long"><p>Fires after an event.</p>
481 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : event<div class="sub-desc"><p>The <a href="Ext.direct.Event.html" rel="Ext.direct.Event" class="docClass">Ext.direct.Event</a> type that occurred.</p>
482 </div></li><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>
483 </div></li></ul></div></div></div><div id="event-exception" class="member ni"><a href="Ext.direct.Manager.html#event-exception" rel="event-exception" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.Manager.html" class="definedIn docClass">Ext.direct.Manager</a><br/><a href="../source/Manager2.html#Ext-direct.Manager-event-exception" class="viewSource">view source</a></div><a name="exception"></a><a name="event-exception"></a><a href="Ext.direct.Manager.html#" rel="event-exception" class="cls expand">exception</a>(
484 <span class="pre">event e</span>)
485 </div><div class="description"><div class="short"><p>Fires after an event exception.</p>
486 </div><div class="long"><p>Fires after an event exception.</p>
487 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : event<div class="sub-desc"><p>The <a href="Ext.direct.Event.html" rel="Ext.direct.Event" class="docClass">Ext.direct.Event</a> type that occurred.</p>
488 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>