Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.direct.JsonProvider.html
1 <!DOCTYPE html><html><head><title>Ext.direct.JsonProvider | 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.JsonProvider',
13         docClass: 'Ext.direct.JsonProvider',
14         docReq: 'Ext.direct.JsonProvider',
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 = 'JsonProvider.html#Ext-direct.JsonProvider';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","createEvent","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.PollingProvider","Ext.direct.RemotingProvider"]};
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/JsonProvider.html#Ext-direct.JsonProvider" target="_blank">Ext.direct.JsonProvider</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.direct.Provider.html" rel="Ext.direct.Provider" class="cls docClass">Ext.direct.Provider</a><div class="subclass"><strong>Ext.direct.JsonProvider</strong></div></div><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>A base provider for communicating using JSON. This is an abstract class
38 and should not be instanced directly.</p>
39 <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 inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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).
40 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>).
41 You should assign an id if you need to be able to access the provider later and you do
42 not have an object reference available, for example:</p>
43
44 <pre><code>Ext.direct.Manager.addProvider({
45     type: 'polling',
46     url:  'php/poll.php',
47     id:   'poll-provider'
48 });     
49 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');
50 p.disconnect();
51 </code></pre>
52
53 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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
54 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
55 object during initialization.  This should be a valid listeners config object as specified in the
56 <a href="Ext.direct.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
57
58 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
59
60
61 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
62
63
64 <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
65 <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
66 events directly from a child element of a Component, we need to specify the <code>element</code> option to
67 identify the Component property to add a DOM listener to:</p>
68
69 <pre><code>new Ext.panel.Panel({
70     width: 400,
71     height: 200,
72     dockedItems: [{
73         xtype: 'toolbar'
74     }],
75     listeners: {
76         click: {
77             element: 'el', //bind to the underlying el property on the panel
78             fn: function(){ console.log('click el'); }
79         },
80         dblclick: {
81             element: 'body', //bind to the underlying body property on the panel
82             fn: function(){ console.log('dblclick body'); }
83         }
84     }
85 });
86 </code></pre>
87
88
89 <p></p></p>
90 </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 inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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>
91 </div><div class="long"><p>Abstract methods for subclasses to implement.</p>
92 </div></div></div><div id="property-disconnect" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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>
93 </div><div class="long"><p>Abstract methods for subclasses to implement.</p>
94 </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.JsonProvider.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.JsonProvider.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
95 <span class="pre">Object/String o, String </span>)
96  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
97 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
98 <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>
99 or the first event name string if multiple event names are being passed as separate parameters.</p>
100 </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.
101 Usage:</p>
102
103 <pre><code>this.addEvents('storeloaded', 'storecleared');
104 </code></pre>
105
106 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
107 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-addListener" class="cls expand">addListener</a>(
108 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
109  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
110 </div><div class="long"><p>Appends an event handler to this object.</p>
111 <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>
112 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
113 </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.
114 <b>If omitted, defaults to the object which fired the event.</b></p>
115 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
116 properties. This may contain any of the following properties:<ul>
117 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
118 <b>If omitted, defaults to the object which fired the event.</b></div></li>
119 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
120 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
121 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
122 by the specified number of milliseconds. If the event fires again within that time, the original
123 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
124 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
125 if the event was bubbled up from a child Observable.</div></li>
126 <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>
127 The name of a Component property which references an element to add a listener to.</p>
128
129 <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
130 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
131 <pre><code>new Ext.panel.Panel({
132     title: 'The title',
133     listeners: {
134         click: this.handlePanelClick,
135         element: 'body'
136     }
137 });
138 </code></pre></p>
139
140
141 <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>
142
143
144 <p></div></li>
145 </ul><br></p>
146
147 <p>
148 <b>Combining Options</b><br>
149 Using the options argument, it is possible to combine different types of listeners:<br>
150 <br>
151 A delayed, one-time listener.
152 <pre><code>myPanel.on('hide', this.handleClick, this, {
153 single: true,
154 delay: 100
155 });</code></pre>
156 <p>
157 <b>Attaching multiple handlers in 1 call</b><br>
158 The method also allows for a single argument to be passed which is a config object containing properties
159 which specify multiple events. For example:
160 <pre><code>myGridPanel.on({
161     cellClick: this.onCellClick,
162     mouseover: this.onMouseOver,
163     mouseout: this.onMouseOut,
164     scope: this // Important. Ensure "this" is correct during handler execution
165 });
166 </code></pre>.
167 <p>
168
169 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
170 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
171 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
172  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
173 is destroyed.
174
175 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
176 is destroyed.
177
178 <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>
179 </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>
180 </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
181 is the handler function.</p>
182 </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
183 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
184 </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
185 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
186 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
187 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-capture" class="cls expand">capture</a>(
188 <span class="pre">Observable o, Function fn, [Object scope]</span>)
189  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
190 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
191 to the supplied function with the event name + standard signature of the event
192 <b>before</b> the event is fired. If the supplied function returns false,
193 the event will not fire.</p>
194 <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>
195 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
196 </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>
197 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
198 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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>
199 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
200 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
201 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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>
202 </div><div class="long"><p>Removes all managed listeners for this object.</p>
203 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
204 </li></ul></div></div></div><div id="method-createEvent" class="member ni"><a href="Ext.direct.JsonProvider.html#method-createEvent" rel="method-createEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.direct.JsonProvider.html" class="definedIn docClass">Ext.direct.JsonProvider</a><br/><a href="../source/JsonProvider.html#Ext-direct.JsonProvider-method-createEvent" class="viewSource">view source</a></div><a name="createEvent"></a><a name="method-createEvent"></a><a href="Ext.direct.JsonProvider.html#" rel="method-createEvent" class="cls expand">createEvent</a>(
205 <span class="pre">Object response</span>)
206  : Ext.direct.Event</div><div class="description"><div class="short"><p>Create an event from a response object</p>
207 </div><div class="long"><p>Create an event from a response object</p>
208 <h3 class="pa">Parameters</h3><ul><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The XHR response object</p>
209 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.direct.Event</span>&nbsp; &nbsp;<p>The event</p>
210 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
211 <span class="pre">String/Array events</span>)
212  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
213 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
214 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
215
216
217 <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
218 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
219 access the required target more quickly.</p>
220
221
222 <p>Example:</p>
223
224
225 <pre><code>Ext.override(Ext.form.field.Base, {
226 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
227 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
228     this.enableBubble('change');
229 }),
230
231 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
232 getBubbleTarget : function() {
233     if (!this.formPanel) {
234         this.formPanel = this.findParentByType('form');
235     }
236     return this.formPanel;
237 }
238 });
239
240 var myForm = new Ext.formPanel({
241 title: 'User Details',
242 items: [{
243     ...
244 }],
245 listeners: {
246     change: function() {
247         // Title goes red if form has been modified.
248         myForm.header.setStyle('color', 'red');
249     }
250 }
251 });
252 </code></pre>
253
254 <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>
255 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
256 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
257 <span class="pre">String eventName, Object... args</span>)
258  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
259
260
261 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>
262
263
264 <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>)
265 by calling <a href="Ext.direct.JsonProvider.html#enableBubble" rel="Ext.direct.JsonProvider#enableBubble" class="docClass">enableBubble</a>.</p>
266
267 <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>
268 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
269 </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>
270 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
271 <span class="pre">String eventName</span>)
272  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
273 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
274 <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>
275 </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>
276 </li></ul></div></div></div><div id="method-isConnected" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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.
277 Abstract method for subclasses to implement.</p>
278 </div><div class="long"><p>Returns whether or not the server-side is currently connected.
279 Abstract method for subclasses to implement.</p>
280 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
281 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-observe" class="cls expand">observe</a>(
282 <span class="pre">Function c, Object listeners</span>)
283  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
284
285 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>
286
287 <p>This makes any event fired on any instance of the passed class also fire a single event through
288 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
289
290 <p>Usage:</p>
291
292 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
293 Ext.data.Connection.on('beforerequest', function(con, options) {
294     console.log('Ajax request made to ' + options.url);
295 });
296 </code></pre>
297 <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>
298 </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.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a>.</p>
299 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
300 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-on" class="cls expand">on</a>(
301 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
302  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a>.)</p>
303 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.direct.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a>.)</p>
304 <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>
305 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
306 </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.
307 <b>If omitted, defaults to the object which fired the event.</b></p>
308 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
309 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
310 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
311 <span class="pre">Object origin, Array events, Object prefix</span>)
312  : 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>
313 </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>
314 <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>
315 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
316 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
317 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
318 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
319 <span class="pre">Observable o</span>)
320  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
321 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
322 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
323 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
324 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
325 <span class="pre">String eventName, Function handler, [Object scope]</span>)
326  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
327 </div><div class="long"><p>Removes an event handler.</p>
328 <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>
329 </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.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a> call.</b></p>
330 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
331 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
332 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
333 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
334  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.direct.JsonProvider.html#mon" rel="Ext.direct.JsonProvider#mon" class="docClass">mon</a> method.</p>
335 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.direct.JsonProvider.html#mon" rel="Ext.direct.JsonProvider#mon" class="docClass">mon</a> method.</p>
336 <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>
337 </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>
338 </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
339 is the handler function.</p>
340 </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
341 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
342 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
343 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
344 If events were suspended using the queueSuspended parameter, then all
345 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.direct.JsonProvider.html#suspendEvents" rel="Ext.direct.JsonProvider#suspendEvents" class="docClass">suspendEvents</a>)
346 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
347 events fired during event suspension will be sent to any listeners now.</p>
348 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
349 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
350 <span class="pre">Boolean queueSuspended</span>)
351  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.direct.JsonProvider.html#resumeEvents" rel="Ext.direct.JsonProvider#resumeEvents" class="docClass">resumeEvents</a>)</p>
352 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.direct.JsonProvider.html#resumeEvents" rel="Ext.direct.JsonProvider#resumeEvents" class="docClass">resumeEvents</a>)</p>
353 <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
354 after the <a href="Ext.direct.JsonProvider.html#resumeEvents" rel="Ext.direct.JsonProvider#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
355 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
356 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="method-un" class="cls expand">un</a>(
357 <span class="pre">String eventName, Function handler, [Object scope]</span>)
358  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.direct.JsonProvider.html#removeListener" rel="Ext.direct.JsonProvider#removeListener" class="docClass">removeListener</a>.)</p>
359 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.direct.JsonProvider.html#removeListener" rel="Ext.direct.JsonProvider#removeListener" class="docClass">removeListener</a>.)</p>
360 <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>
361 </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.JsonProvider.html#addListener" rel="Ext.direct.JsonProvider#addListener" class="docClass">addListener</a> call.</b></p>
362 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
363 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
364 </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 inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="event-connect" class="cls expand">connect</a>(
365 <span class="pre">Ext.direct.Provider provider</span>)
366 </div><div class="description"><div class="short"><p>Fires when the Provider connects to the server-side</p>
367 </div><div class="long"><p>Fires when the Provider connects to the server-side</p>
368 <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>
369 </div></li></ul></div></div></div><div id="event-data" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="event-data" class="cls expand">data</a>(
370 <span class="pre">Ext.direct.Provider provider, event e</span>)
371 </div><div class="description"><div class="short"><p>Fires when the Provider receives data from the server-side</p>
372 </div><div class="long"><p>Fires when the Provider receives data from the server-side</p>
373 <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>
374 </div></li><li><span class="pre">e</span> : event<div class="sub-desc"><p>The Ext.Direct.Event type that occurred.</p>
375 </div></li></ul></div></div></div><div id="event-disconnect" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.html#" rel="event-disconnect" class="cls expand">disconnect</a>(
376 <span class="pre">Ext.direct.Provider provider</span>)
377 </div><div class="description"><div class="short"><p>Fires when the Provider disconnects from the server-side</p>
378 </div><div class="long"><p>Fires when the Provider disconnects from the server-side</p>
379 <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>
380 </div></li></ul></div></div></div><div id="event-exception" class="member inherited"><a href="Ext.direct.JsonProvider.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.JsonProvider.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>
381 </div><div class="long"><p>Fires when the Provider receives an exception from the server-side</p>
382 </div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>