Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.proxy.Direct.html
1 <!DOCTYPE html><html><head><title>Ext.data.proxy.Direct | 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.data.proxy.Direct',
13         docClass: 'Ext.data.proxy.Direct',
14         docReq: 'Ext.data.proxy.Direct',
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 = 'Direct.html#Ext-data.proxy.Direct';
33     clsInfo = {"methods":["Direct","addEvents","addListener","addManagedListener","batch","buildRequest","buildUrl","capture","clearListeners","clearManagedListeners","doRequest","enableBubble","encodeFilters","encodeSorters","fireEvent","getModel","getReader","getWriter","hasListener","observe","on","processResponse","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setModel","setReader","setWriter","suspendEvents","un"],"cfgs":["api","batchActions","batchOrder","cacheString","directFn","directionParam","extraParams","filterParam","groupParam","limitParam","listeners","model","noCache","pageParam","paramOrder","paramsAsHash","reader","simpleSortMode","sortParam","startParam","timeout","url","writer"],"properties":["afterRequest","create","destroy","read","update"],"events":["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/Direct.html#Ext-data.proxy.Direct" target="_blank">Ext.data.proxy.Direct</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.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="cls docClass">Ext.data.proxy.Proxy</a><div class="subclass"><a href="Ext.data.proxy.Server.html" rel="Ext.data.proxy.Server" class="cls docClass">Ext.data.proxy.Server</a><div class="subclass"><strong>Ext.data.proxy.Direct</strong></div></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>This class is used to send requests to the server using <a href="Ext.direct.html" rel="Ext.direct" class="docClass">Ext.direct</a>. When a request is made,
38 the transport mechanism is handed off to the appropriate <a href="Ext.direct.RemotingProvider.html" rel="Ext.direct.RemotingProvider" class="docClass">Provider</a>
39 to complete the call.</p>
40
41 <h2>Specifying the function</h2>
42
43 <p>This proxy expects a Direct remoting method to be passed in order to be able to complete requests.
44 This can be done by specifying the <a href="Ext.data.proxy.Direct.html#directFn" rel="Ext.data.proxy.Direct#directFn" class="docClass">directFn</a> configuration. This will use the same direct
45 method for all requests. Alternatively, you can provide an <a href="Ext.data.proxy.Direct.html#api" rel="Ext.data.proxy.Direct#api" class="docClass">api</a> configuration. This
46 allows you to specify a different remoting method for each CRUD action.</p>
47
48 <h2>Paramaters</h2>
49
50 <p>This proxy provides options to help configure which parameters will be sent to the server.
51 By specifying the <a href="Ext.data.proxy.Direct.html#paramsAsHash" rel="Ext.data.proxy.Direct#paramsAsHash" class="docClass">paramsAsHash</a> option, it will send an object literal containing each
52 of the passed parameters. The <a href="Ext.data.proxy.Direct.html#paramOrder" rel="Ext.data.proxy.Direct#paramOrder" class="docClass">paramOrder</a> option can be used to specify the order in which
53 the remoting method parameters are passed.</p>
54
55 <h2>Example Usage</h2>
56
57 <pre class="prettyprint"><code>Ext.define('User', {
58     extend: 'Ext.data.Model',
59     fields: ['firstName', 'lastName'],
60     proxy: {
61         type: 'direct',
62         directFn: MyApp.getUsers,
63         paramOrder: 'id' // Tells the proxy to pass the id as the first parameter to the remoting method.
64     }
65 });
66 User.load(1);
67 </code></pre>
68 <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-api" class="member f ni"><a href="Ext.data.proxy.Direct.html#config-api" rel="config-api" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Direct.html" class="definedIn docClass">Ext.data.proxy.Direct</a><br/><a href="../source/Direct.html#Ext-data.proxy.Direct-cfg-api" class="viewSource">view source</a></div><a name="api"></a><a name="config-api"></a><a href="Ext.data.proxy.Direct.html#" rel="config-api" class="cls expand">api</a><span> : Object</span></div><div class="description"><div class="short"><p>The same as <a href="Ext.data.proxy.Server.html#api" rel="Ext.data.proxy.Server#api" class="docClass">Ext.data.proxy.Server.api</a>, however instead of providing urls, you should provide a direct
69 function call.</p>
70 </div><div class="long"><p>The same as <a href="Ext.data.proxy.Server.html#api" rel="Ext.data.proxy.Server#api" class="docClass">Ext.data.proxy.Server.api</a>, however instead of providing urls, you should provide a direct
71 function call.</p>
72 </div></div></div><div id="config-batchActions" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-batchActions" rel="config-batchActions" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-batchActions" class="viewSource">view source</a></div><a name="batchActions"></a><a name="config-batchActions"></a><a href="Ext.data.proxy.Direct.html#" rel="config-batchActions" class="cls expand">batchActions</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to batch actions of a particular type when synchronizing the store.
73 Defaults to <tt>true</tt>.</p>
74 </div><div class="long"><p>True to batch actions of a particular type when synchronizing the store.
75 Defaults to <tt>true</tt>.</p>
76 </div></div></div><div id="config-batchOrder" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-batchOrder" rel="config-batchOrder" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-batchOrder" class="viewSource">view source</a></div><a name="batchOrder"></a><a name="config-batchOrder"></a><a href="Ext.data.proxy.Direct.html#" rel="config-batchOrder" class="cls expand">batchOrder</a><span> : String</span></div><div class="description"><div class="short">Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this
77 to set a different ord...</div><div class="long"><p>Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this
78 to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'</p>
79 </div></div></div><div id="config-cacheString" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-cacheString" rel="config-cacheString" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-cacheString" class="viewSource">view source</a></div><a name="cacheString"></a><a name="config-cacheString"></a><a href="Ext.data.proxy.Direct.html#" rel="config-cacheString" class="cls expand">cacheString</a><span> : String</span></div><div class="description"><div class="short"><p>The name of the cache param added to the url when using noCache (defaults to "_dc")</p>
80 </div><div class="long"><p>The name of the cache param added to the url when using noCache (defaults to "_dc")</p>
81 </div></div></div><div id="config-directFn" class="member ni"><a href="Ext.data.proxy.Direct.html#config-directFn" rel="config-directFn" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Direct.html" class="definedIn docClass">Ext.data.proxy.Direct</a><br/><a href="../source/Direct.html#Ext-data.proxy.Direct-cfg-directFn" class="viewSource">view source</a></div><a name="directFn"></a><a name="config-directFn"></a><a href="Ext.data.proxy.Direct.html#" rel="config-directFn" class="cls expand">directFn</a><span> : Function</span></div><div class="description"><div class="short">Function to call when executing a request.  directFn is a simple alternative to defining the api configuration-parame...</div><div class="long"><p>Function to call when executing a request.  directFn is a simple alternative to defining the api configuration-parameter
82 for Store's which will not implement a full CRUD api.</p>
83 </div></div></div><div id="config-directionParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-directionParam" rel="config-directionParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-directionParam" class="viewSource">view source</a></div><a name="directionParam"></a><a name="config-directionParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-directionParam" class="cls expand">directionParam</a><span> : String</span></div><div class="description"><div class="short">The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.
84 Defau...</div><div class="long"><p>The name of the direction parameter to send in a request. <strong>This is only used when simpleSortMode is set to true.</strong>
85 Defaults to 'dir'.</p>
86 </div></div></div><div id="config-extraParams" class="member ni"><a href="Ext.data.proxy.Direct.html#config-extraParams" rel="config-extraParams" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Direct.html" class="definedIn docClass">Ext.data.proxy.Direct</a><br/><a href="../source/Direct.html#Ext-data.proxy.Direct-cfg-extraParams" class="viewSource">view source</a></div><a name="extraParams"></a><a name="config-extraParams"></a><a href="Ext.data.proxy.Direct.html#" rel="config-extraParams" class="cls expand">extraParams</a><span> : Object</span></div><div class="description"><div class="short">Extra parameters that will be included on every read request. Individual requests with params
87 of the same name will o...</div><div class="long"><p>Extra parameters that will be included on every read request. Individual requests with params
88 of the same name will override these params when they are in conflict.</p>
89 </div></div></div><div id="config-filterParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-filterParam" rel="config-filterParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-filterParam" class="viewSource">view source</a></div><a name="filterParam"></a><a name="config-filterParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-filterParam" class="cls expand">filterParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set
90 this to undefined if you don't wan...</div><div class="long"><p>The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set
91 this to undefined if you don't want to send a filter parameter</p>
92 </div></div></div><div id="config-groupParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-groupParam" rel="config-groupParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-groupParam" class="viewSource">view source</a></div><a name="groupParam"></a><a name="config-groupParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-groupParam" class="cls expand">groupParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this
93 to undefined if you don't want ...</div><div class="long"><p>The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this
94 to undefined if you don't want to send a group parameter</p>
95 </div></div></div><div id="config-limitParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-limitParam" rel="config-limitParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-limitParam" class="viewSource">view source</a></div><a name="limitParam"></a><a name="config-limitParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-limitParam" class="cls expand">limitParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this
96 to undefined if you don't want ...</div><div class="long"><p>The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this
97 to undefined if you don't want to send a limit parameter</p>
98 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.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
99 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
100 object during initialization.  This should be a valid listeners config object as specified in the
101 <a href="Ext.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
102
103 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
104
105
106 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
107
108
109 <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
110 <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
111 events directly from a child element of a Component, we need to specify the <code>element</code> option to
112 identify the Component property to add a DOM listener to:</p>
113
114 <pre><code>new Ext.panel.Panel({
115     width: 400,
116     height: 200,
117     dockedItems: [{
118         xtype: 'toolbar'
119     }],
120     listeners: {
121         click: {
122             element: 'el', //bind to the underlying el property on the panel
123             fn: function(){ console.log('click el'); }
124         },
125         dblclick: {
126             element: 'body', //bind to the underlying body property on the panel
127             fn: function(){ console.log('dblclick body'); }
128         }
129     }
130 });
131 </code></pre>
132
133
134 <p></p></p>
135 </div></div></div><div id="config-model" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-model" rel="config-model" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-model" class="viewSource">view source</a></div><a name="model"></a><a name="config-model"></a><a href="Ext.data.proxy.Direct.html#" rel="config-model" class="cls expand">model</a><span> : String/Ext.data.Model</span></div><div class="description"><div class="short">The name of the Model to tie to this Proxy. Can be either the string name of
136 the Model, or a reference to the Model c...</div><div class="long"><p>The name of the Model to tie to this Proxy. Can be either the string name of
137 the Model, or a reference to the Model constructor. Required.</p>
138 </div></div></div><div id="config-noCache" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-noCache" rel="config-noCache" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-noCache" class="viewSource">view source</a></div><a name="noCache"></a><a name="config-noCache"></a><a href="Ext.data.proxy.Direct.html#" rel="config-noCache" class="cls expand">noCache</a><span> : Boolean</span></div><div class="description"><div class="short"><p>(optional) Defaults to true. Disable caching by adding a unique parameter
139 name to the request.</p>
140 </div><div class="long"><p>(optional) Defaults to true. Disable caching by adding a unique parameter
141 name to the request.</p>
142 </div></div></div><div id="config-pageParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-pageParam" rel="config-pageParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-pageParam" class="viewSource">view source</a></div><a name="pageParam"></a><a name="config-pageParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-pageParam" class="cls expand">pageParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to
143 undefined if you don't want to...</div><div class="long"><p>The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to
144 undefined if you don't want to send a page parameter</p>
145 </div></div></div><div id="config-paramOrder" class="member ni"><a href="Ext.data.proxy.Direct.html#config-paramOrder" rel="config-paramOrder" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Direct.html" class="definedIn docClass">Ext.data.proxy.Direct</a><br/><a href="../source/Direct.html#Ext-data.proxy.Direct-cfg-paramOrder" class="viewSource">view source</a></div><a name="paramOrder"></a><a name="config-paramOrder"></a><a href="Ext.data.proxy.Direct.html#" rel="config-paramOrder" class="cls expand">paramOrder</a><span> : Array/String</span></div><div class="description"><div class="short">Defaults to undefined. A list of params to be executed
146 server side.  Specify the params in the order in which they mu...</div><div class="long"><p>Defaults to <tt>undefined</tt>. A list of params to be executed
147 server side.  Specify the params in the order in which they must be executed on the server-side
148 as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,
149 comma, or pipe. For example,
150 any of the following would be acceptable:</p>
151
152 <pre><code>paramOrder: ['param1','param2','param3']
153 paramOrder: 'param1 param2 param3'
154 paramOrder: 'param1,param2,param3'
155 paramOrder: 'param1|param2|param'
156      </code></pre>
157
158 </div></div></div><div id="config-paramsAsHash" class="member ni"><a href="Ext.data.proxy.Direct.html#config-paramsAsHash" rel="config-paramsAsHash" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Direct.html" class="definedIn docClass">Ext.data.proxy.Direct</a><br/><a href="../source/Direct.html#Ext-data.proxy.Direct-cfg-paramsAsHash" class="viewSource">view source</a></div><a name="paramsAsHash"></a><a name="config-paramsAsHash"></a><a href="Ext.data.proxy.Direct.html#" rel="config-paramsAsHash" class="cls expand">paramsAsHash</a><span> : Boolean</span></div><div class="description"><div class="short">Send parameters as a collection of named arguments (defaults to true). Providing a
159 paramOrder nullifies this configur...</div><div class="long"><p>Send parameters as a collection of named arguments (defaults to <tt>true</tt>). Providing a
160 <tt><a href="Ext.data.proxy.Direct.html#paramOrder" rel="Ext.data.proxy.Direct#paramOrder" class="docClass">paramOrder</a></tt> nullifies this configuration.</p>
161 </div></div></div><div id="config-reader" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-reader" rel="config-reader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-reader" class="viewSource">view source</a></div><a name="reader"></a><a name="config-reader"></a><a href="Ext.data.proxy.Direct.html#" rel="config-reader" class="cls expand">reader</a><span> : Object/String/Ext.data.reader.Reader</span></div><div class="description"><div class="short">The Ext.data.reader.Reader to use to decode the server's response. This can
162 either be a Reader instance, a config obj...</div><div class="long"><p>The <a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="docClass">Ext.data.reader.Reader</a> to use to decode the server's response. This can
163 either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').</p>
164 </div></div></div><div id="config-simpleSortMode" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-simpleSortMode" rel="config-simpleSortMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-simpleSortMode" class="viewSource">view source</a></div><a name="simpleSortMode"></a><a name="config-simpleSortMode"></a><a href="Ext.data.proxy.Direct.html#" rel="config-simpleSortMode" class="cls expand">simpleSortMode</a><span> : Boolean</span></div><div class="description"><div class="short">Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote...</div><div class="long"><p>Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested.
165 The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'</p>
166 </div></div></div><div id="config-sortParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-sortParam" rel="config-sortParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-sortParam" class="viewSource">view source</a></div><a name="sortParam"></a><a name="config-sortParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-sortParam" class="cls expand">sortParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this
167 to undefined if you don't want to...</div><div class="long"><p>The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this
168 to undefined if you don't want to send a sort parameter</p>
169 </div></div></div><div id="config-startParam" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-startParam" rel="config-startParam" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-startParam" class="viewSource">view source</a></div><a name="startParam"></a><a name="config-startParam"></a><a href="Ext.data.proxy.Direct.html#" rel="config-startParam" class="cls expand">startParam</a><span> : String</span></div><div class="description"><div class="short">The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this
170 to undefined if you don't want ...</div><div class="long"><p>The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this
171 to undefined if you don't want to send a start parameter</p>
172 </div></div></div><div id="config-timeout" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-timeout" rel="config-timeout" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-timeout" class="viewSource">view source</a></div><a name="timeout"></a><a name="config-timeout"></a><a href="Ext.data.proxy.Direct.html#" rel="config-timeout" class="cls expand">timeout</a><span> : Number</span></div><div class="description"><div class="short"><p>(optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.</p>
173 </div><div class="long"><p>(optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.</p>
174 </div></div></div><div id="config-url" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-url" rel="config-url" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-url" class="viewSource">view source</a></div><a name="url"></a><a name="config-url"></a><a href="Ext.data.proxy.Direct.html#" rel="config-url" class="cls expand">url</a><span> : String</span></div><div class="description"><div class="short"><p>The URL from which to request the data object.</p>
175 </div><div class="long"><p>The URL from which to request the data object.</p>
176 </div></div></div><div id="config-writer" class="member inherited"><a href="Ext.data.proxy.Direct.html#config-writer" rel="config-writer" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-cfg-writer" class="viewSource">view source</a></div><a name="writer"></a><a name="config-writer"></a><a href="Ext.data.proxy.Direct.html#" rel="config-writer" class="cls expand">writer</a><span> : Object/String/Ext.data.writer.Writer</span></div><div class="description"><div class="short">The Ext.data.writer.Writer to use to encode any request sent to the server.
177 This can either be a Writer instance, a c...</div><div class="long"><p>The <a href="Ext.data.writer.Writer.html" rel="Ext.data.writer.Writer" class="docClass">Ext.data.writer.Writer</a> to use to encode any request sent to the server.
178 This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').</p>
179 </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-afterRequest" class="member f inherited"><a href="Ext.data.proxy.Direct.html#property-afterRequest" rel="property-afterRequest" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-property-afterRequest" class="viewSource">view source</a></div><a name="afterRequest"></a><a name="property-afterRequest"></a><a href="Ext.data.proxy.Direct.html#" rel="property-afterRequest" class="cls expand">afterRequest</a><span> : Object</span></div><div class="description"><div class="short"><p>Optional callback function which can be used to clean up after a request has been completed.</p>
180 </div><div class="long"><p>Optional callback function which can be used to clean up after a request has been completed.</p>
181 </div></div></div><div id="property-create" class="member inherited"><a href="Ext.data.proxy.Direct.html#property-create" rel="property-create" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-create" class="viewSource">view source</a></div><a name="create"></a><a name="property-create"></a><a href="Ext.data.proxy.Direct.html#" rel="property-create" class="cls expand">create</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given create operation.</p>
182 </div><div class="long"><p>Performs the given create operation.</p>
183 </div></div></div><div id="property-destroy" class="member inherited"><a href="Ext.data.proxy.Direct.html#property-destroy" rel="property-destroy" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="property-destroy"></a><a href="Ext.data.proxy.Direct.html#" rel="property-destroy" class="cls expand">destroy</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given destroy operation.</p>
184 </div><div class="long"><p>Performs the given destroy operation.</p>
185 </div></div></div><div id="property-read" class="member inherited"><a href="Ext.data.proxy.Direct.html#property-read" rel="property-read" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-read" class="viewSource">view source</a></div><a name="read"></a><a name="property-read"></a><a href="Ext.data.proxy.Direct.html#" rel="property-read" class="cls expand">read</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given read operation.</p>
186 </div><div class="long"><p>Performs the given read operation.</p>
187 </div></div></div><div id="property-update" class="member inherited"><a href="Ext.data.proxy.Direct.html#property-update" rel="property-update" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-update" class="viewSource">view source</a></div><a name="update"></a><a name="property-update"></a><a href="Ext.data.proxy.Direct.html#" rel="property-update" class="cls expand">update</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given update operation.</p>
188 </div><div class="long"><p>Performs the given update operation.</p>
189 </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-Direct" class="member f inherited"><a href="Ext.data.proxy.Direct.html#method-Direct" rel="method-Direct" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-constructor" class="viewSource">view source</a></div><a name="Direct"></a><a name="method-Direct"></a><a href="Ext.data.proxy.Direct.html#" rel="method-Direct" class="cls expand">Direct</a>(
190 <span class="pre">Object config</span>)
191  : void</div><div class="description"><div class="short"><p>Creates the Proxy</p>
192 </div><div class="long"><p>Creates the Proxy</p>
193 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
194 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
195 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
196 <span class="pre">Object/String o, String </span>)
197  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
198 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
199 <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>
200 or the first event name string if multiple event names are being passed as separate parameters.</p>
201 </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.
202 Usage:</p>
203
204 <pre><code>this.addEvents('storeloaded', 'storecleared');
205 </code></pre>
206
207 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
208 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-addListener" class="cls expand">addListener</a>(
209 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
210  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
211 </div><div class="long"><p>Appends an event handler to this object.</p>
212 <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>
213 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
214 </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.
215 <b>If omitted, defaults to the object which fired the event.</b></p>
216 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
217 properties. This may contain any of the following properties:<ul>
218 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
219 <b>If omitted, defaults to the object which fired the event.</b></div></li>
220 <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>
221 <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>
222 <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
223 by the specified number of milliseconds. If the event fires again within that time, the original
224 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
225 <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>
226 if the event was bubbled up from a child Observable.</div></li>
227 <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>
228 The name of a Component property which references an element to add a listener to.</p>
229
230 <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
231 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
232 <pre><code>new Ext.panel.Panel({
233     title: 'The title',
234     listeners: {
235         click: this.handlePanelClick,
236         element: 'body'
237     }
238 });
239 </code></pre></p>
240
241
242 <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>
243
244
245 <p></div></li>
246 </ul><br></p>
247
248 <p>
249 <b>Combining Options</b><br>
250 Using the options argument, it is possible to combine different types of listeners:<br>
251 <br>
252 A delayed, one-time listener.
253 <pre><code>myPanel.on('hide', this.handleClick, this, {
254 single: true,
255 delay: 100
256 });</code></pre>
257 <p>
258 <b>Attaching multiple handlers in 1 call</b><br>
259 The method also allows for a single argument to be passed which is a config object containing properties
260 which specify multiple events. For example:
261 <pre><code>myGridPanel.on({
262     cellClick: this.onCellClick,
263     mouseover: this.onMouseOver,
264     mouseout: this.onMouseOut,
265     scope: this // Important. Ensure "this" is correct during handler execution
266 });
267 </code></pre>.
268 <p>
269
270 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
271 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
272 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
273  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
274 is destroyed.
275
276 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
277 is destroyed.
278
279 <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>
280 </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>
281 </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
282 is the handler function.</p>
283 </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
284 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
285 </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
286 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
287 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
288 </li></ul></div></div></div><div id="method-batch" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-batch" rel="method-batch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-batch" class="viewSource">view source</a></div><a name="batch"></a><a name="method-batch"></a><a href="Ext.data.proxy.Direct.html#" rel="method-batch" class="cls expand">batch</a>(
289 <span class="pre">Object operations, Object listeners</span>)
290  : Ext.data.Batch</div><div class="description"><div class="short">Performs a batch of Operations, in the order specified by batchOrder. Used internally by
291 Ext.data.Store's sync method...</div><div class="long"><p>Performs a batch of <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Operations</a>, in the order specified by <a href="Ext.data.proxy.Direct.html#batchOrder" rel="Ext.data.proxy.Direct#batchOrder" class="docClass">batchOrder</a>. Used internally by
292 <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a>'s <a href="Ext.data.Store.html#sync" rel="Ext.data.Store#sync" class="docClass">sync</a> method. Example usage:</p>
293
294 <pre><code>myProxy.batch({
295     create : [myModel1, myModel2],
296     update : [myModel3],
297     destroy: [myModel4, myModel5]
298 });
299 </code></pre>
300
301
302 <p>Where the myModel* above are <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> instances - in this case 1 and 2 are new instances and have not been
303 saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.</p>
304 <h3 class="pa">Parameters</h3><ul><li><span class="pre">operations</span> : Object<div class="sub-desc"><p>Object containing the Model instances to act upon, keyed by action name</p>
305 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>Optional listeners object passed straight through to the Batch - see <a href="Ext.data.Batch.html" rel="Ext.data.Batch" class="docClass">Ext.data.Batch</a></p>
306 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Batch</span>&nbsp; &nbsp;<p>The newly created <a href="Ext.data.Batch.html" rel="Ext.data.Batch" class="docClass">Ext.data.Batch</a> object</p>
307 </li></ul></div></div></div><div id="method-buildRequest" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-buildRequest" rel="method-buildRequest" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-buildRequest" class="viewSource">view source</a></div><a name="buildRequest"></a><a name="method-buildRequest"></a><a href="Ext.data.proxy.Direct.html#" rel="method-buildRequest" class="cls expand">buildRequest</a>(
308 <span class="pre">Ext.data.Operation operation</span>)
309  : Ext.data.Request</div><div class="description"><div class="short"><p>Creates and returns an <a href="Ext.data.Request.html" rel="Ext.data.Request" class="docClass">Ext.data.Request</a> object based on the options passed by the <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Store</a>
310 that this Proxy is attached to.</p>
311 </div><div class="long"><p>Creates and returns an <a href="Ext.data.Request.html" rel="Ext.data.Request" class="docClass">Ext.data.Request</a> object based on the options passed by the <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Store</a>
312 that this Proxy is attached to.</p>
313 <h3 class="pa">Parameters</h3><ul><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Operation</a> object to execute</p>
314 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Request</span>&nbsp; &nbsp;<p>The request object</p>
315 </li></ul></div></div></div><div id="method-buildUrl" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-buildUrl" rel="method-buildUrl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-buildUrl" class="viewSource">view source</a></div><a name="buildUrl"></a><a name="method-buildUrl"></a><a href="Ext.data.proxy.Direct.html#" rel="method-buildUrl" class="cls expand">buildUrl</a>(
316 <span class="pre">Ext.data.Request request</span>)
317  : String</div><div class="description"><div class="short">Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will
318 add the cache-buste...</div><div class="long"><p>Generates a url based on a given <a href="Ext.data.Request.html" rel="Ext.data.Request" class="docClass">Ext.data.Request</a> object. By default, ServerProxy's buildUrl will
319 add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications
320 to the url.</p>
321 <h3 class="pa">Parameters</h3><ul><li><span class="pre">request</span> : Ext.data.Request<div class="sub-desc"><p>The request object</p>
322 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The url</p>
323 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-capture" class="cls expand">capture</a>(
324 <span class="pre">Observable o, Function fn, [Object scope]</span>)
325  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
326 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
327 to the supplied function with the event name + standard signature of the event
328 <b>before</b> the event is fired. If the supplied function returns false,
329 the event will not fire.</p>
330 <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>
331 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
332 </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>
333 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
334 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.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>
335 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
336 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
337 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.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>
338 </div><div class="long"><p>Removes all managed listeners for this object.</p>
339 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
340 </li></ul></div></div></div><div id="method-doRequest" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-doRequest" rel="method-doRequest" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-doRequest" class="viewSource">view source</a></div><a name="doRequest"></a><a name="method-doRequest"></a><a href="Ext.data.proxy.Direct.html#" rel="method-doRequest" class="cls expand">doRequest</a>(
341 <span class="pre">Ext.data.Operation operation, Function callback, Object scope</span>)
342  : void</div><div class="description"><div class="short">In ServerProxy subclasses, the create, read, update and destroy methods all pass
343 through to doRequest. Each ServerPro...</div><div class="long"><p>In ServerProxy subclasses, the <a href="Ext.data.proxy.Direct.html#create" rel="Ext.data.proxy.Direct#create" class="docClass">create</a>, <a href="Ext.data.proxy.Direct.html#read" rel="Ext.data.proxy.Direct#read" class="docClass">read</a>, <a href="Ext.data.proxy.Direct.html#update" rel="Ext.data.proxy.Direct#update" class="docClass">update</a> and <a href="Ext.data.proxy.Direct.html#destroy" rel="Ext.data.proxy.Direct#destroy" class="docClass">destroy</a> methods all pass
344 through to doRequest. Each ServerProxy subclass must implement the doRequest method - see <a href="Ext.data.proxy.JsonP.html" rel="Ext.data.proxy.JsonP" class="docClass">Ext.data.proxy.JsonP</a>
345 and <a href="Ext.data.proxy.Ajax.html" rel="Ext.data.proxy.Ajax" class="docClass">Ext.data.proxy.Ajax</a> for examples. This method carries the same signature as each of the methods that delegate to it.</p>
346 <h3 class="pa">Parameters</h3><ul><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object</p>
347 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>The callback function to call when the Operation has completed</p>
348 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>The scope in which to execute the callback</p>
349 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
350 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
351 <span class="pre">String/Array events</span>)
352  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
353 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
354 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
355
356
357 <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
358 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
359 access the required target more quickly.</p>
360
361
362 <p>Example:</p>
363
364
365 <pre><code>Ext.override(Ext.form.field.Base, {
366 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
367 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
368     this.enableBubble('change');
369 }),
370
371 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
372 getBubbleTarget : function() {
373     if (!this.formPanel) {
374         this.formPanel = this.findParentByType('form');
375     }
376     return this.formPanel;
377 }
378 });
379
380 var myForm = new Ext.formPanel({
381 title: 'User Details',
382 items: [{
383     ...
384 }],
385 listeners: {
386     change: function() {
387         // Title goes red if form has been modified.
388         myForm.header.setStyle('color', 'red');
389     }
390 }
391 });
392 </code></pre>
393
394 <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>
395 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
396 </li></ul></div></div></div><div id="method-encodeFilters" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-encodeFilters" rel="method-encodeFilters" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-encodeFilters" class="viewSource">view source</a></div><a name="encodeFilters"></a><a name="method-encodeFilters"></a><a href="Ext.data.proxy.Direct.html#" rel="method-encodeFilters" class="cls expand">encodeFilters</a>(
397 <span class="pre">Array sorters</span>)
398  : String</div><div class="description"><div class="short">Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default,
399 this simply JSO...</div><div class="long"><p>Encodes the array of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Ext.util.Filter</a> objects into a string to be sent in the request url. By default,
400 this simply JSON-encodes the filter data</p>
401 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorters</span> : Array<div class="sub-desc"><p>The array of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filter</a> objects</p>
402 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The encoded filters</p>
403 </li></ul></div></div></div><div id="method-encodeSorters" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-encodeSorters" rel="method-encodeSorters" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-encodeSorters" class="viewSource">view source</a></div><a name="encodeSorters"></a><a name="method-encodeSorters"></a><a href="Ext.data.proxy.Direct.html#" rel="method-encodeSorters" class="cls expand">encodeSorters</a>(
404 <span class="pre">Array sorters</span>)
405  : String</div><div class="description"><div class="short">Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default,
406 this simply JSO...</div><div class="long"><p>Encodes the array of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Ext.util.Sorter</a> objects into a string to be sent in the request url. By default,
407 this simply JSON-encodes the sorter data</p>
408 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorters</span> : Array<div class="sub-desc"><p>The array of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorter</a> objects</p>
409 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The encoded sorters</p>
410 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
411 <span class="pre">String eventName, Object... args</span>)
412  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
413
414
415 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>
416
417
418 <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>)
419 by calling <a href="Ext.data.proxy.Direct.html#enableBubble" rel="Ext.data.proxy.Direct#enableBubble" class="docClass">enableBubble</a>.</p>
420
421 <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>
422 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
423 </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>
424 </li></ul></div></div></div><div id="method-getModel" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-getModel" rel="method-getModel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getModel" class="viewSource">view source</a></div><a name="getModel"></a><a name="method-getModel"></a><a href="Ext.data.proxy.Direct.html#" rel="method-getModel" class="cls expand">getModel</a> : Ext.data.Model</div><div class="description"><div class="short"><p>Returns the model attached to this Proxy</p>
425 </div><div class="long"><p>Returns the model attached to this Proxy</p>
426 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The model</p>
427 </li></ul></div></div></div><div id="method-getReader" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-getReader" rel="method-getReader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getReader" class="viewSource">view source</a></div><a name="getReader"></a><a name="method-getReader"></a><a href="Ext.data.proxy.Direct.html#" rel="method-getReader" class="cls expand">getReader</a> : Ext.data.reader.Reader</div><div class="description"><div class="short"><p>Returns the reader currently attached to this proxy instance</p>
428 </div><div class="long"><p>Returns the reader currently attached to this proxy instance</p>
429 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.reader.Reader</span>&nbsp; &nbsp;<p>The Reader instance</p>
430 </li></ul></div></div></div><div id="method-getWriter" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-getWriter" rel="method-getWriter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getWriter" class="viewSource">view source</a></div><a name="getWriter"></a><a name="method-getWriter"></a><a href="Ext.data.proxy.Direct.html#" rel="method-getWriter" class="cls expand">getWriter</a> : Ext.data.writer.Writer</div><div class="description"><div class="short"><p>Returns the writer currently attached to this proxy instance</p>
431 </div><div class="long"><p>Returns the writer currently attached to this proxy instance</p>
432 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.writer.Writer</span>&nbsp; &nbsp;<p>The Writer instance</p>
433 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
434 <span class="pre">String eventName</span>)
435  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
436 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
437 <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>
438 </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>
439 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-observe" class="cls expand">observe</a>(
440 <span class="pre">Function c, Object listeners</span>)
441  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
442
443 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>
444
445 <p>This makes any event fired on any instance of the passed class also fire a single event through
446 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
447
448 <p>Usage:</p>
449
450 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
451 Ext.data.Connection.on('beforerequest', function(con, options) {
452     console.log('Ajax request made to ' + options.url);
453 });
454 </code></pre>
455 <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>
456 </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.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a>.</p>
457 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
458 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-on" class="cls expand">on</a>(
459 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
460  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a>.)</p>
461 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a>.)</p>
462 <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>
463 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
464 </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.
465 <b>If omitted, defaults to the object which fired the event.</b></p>
466 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
467 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
468 </li></ul></div></div></div><div id="method-processResponse" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-processResponse" rel="method-processResponse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-method-processResponse" class="viewSource">view source</a></div><a name="processResponse"></a><a name="method-processResponse"></a><a href="Ext.data.proxy.Direct.html#" rel="method-processResponse" class="cls expand">processResponse</a>(
469 <span class="pre">Object success, Object operation, Object request, Object response, Object callback, Object scope</span>)
470  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
471 <h3 class="pa">Parameters</h3><ul><li><span class="pre">success</span> : Object<div class="sub-desc">
472 </div></li><li><span class="pre">operation</span> : Object<div class="sub-desc">
473 </div></li><li><span class="pre">request</span> : Object<div class="sub-desc">
474 </div></li><li><span class="pre">response</span> : Object<div class="sub-desc">
475 </div></li><li><span class="pre">callback</span> : Object<div class="sub-desc">
476 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc">
477 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
478 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
479 <span class="pre">Object origin, Array events, Object prefix</span>)
480  : 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>
481 </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>
482 <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>
483 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
484 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
485 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
486 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
487 <span class="pre">Observable o</span>)
488  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
489 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
490 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
491 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
492 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
493 <span class="pre">String eventName, Function handler, [Object scope]</span>)
494  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
495 </div><div class="long"><p>Removes an event handler.</p>
496 <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>
497 </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.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a> call.</b></p>
498 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
499 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
500 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
501 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
502  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.proxy.Direct.html#mon" rel="Ext.data.proxy.Direct#mon" class="docClass">mon</a> method.</p>
503 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.proxy.Direct.html#mon" rel="Ext.data.proxy.Direct#mon" class="docClass">mon</a> method.</p>
504 <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>
505 </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>
506 </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
507 is the handler function.</p>
508 </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
509 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
510 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
511 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
512 If events were suspended using the queueSuspended parameter, then all
513 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.proxy.Direct.html#suspendEvents" rel="Ext.data.proxy.Direct#suspendEvents" class="docClass">suspendEvents</a>)
514 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
515 events fired during event suspension will be sent to any listeners now.</p>
516 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
517 </li></ul></div></div></div><div id="method-setModel" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-setModel" rel="method-setModel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setModel" class="viewSource">view source</a></div><a name="setModel"></a><a name="method-setModel"></a><a href="Ext.data.proxy.Direct.html#" rel="method-setModel" class="cls expand">setModel</a>(
518 <span class="pre">String|Ext.data.Model model, Boolean setOnStore</span>)
519  : void</div><div class="description"><div class="short"><p>Sets the model associated with this proxy. This will only usually be called by a Store</p>
520 </div><div class="long"><p>Sets the model associated with this proxy. This will only usually be called by a Store</p>
521 <h3 class="pa">Parameters</h3><ul><li><span class="pre">model</span> : String|Ext.data.Model<div class="sub-desc"><p>The new model. Can be either the model name string,
522 or a reference to the model's constructor</p>
523 </div></li><li><span class="pre">setOnStore</span> : Boolean<div class="sub-desc"><p>Sets the new model on the associated Store, if one is present</p>
524 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
525 </li></ul></div></div></div><div id="method-setReader" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-setReader" rel="method-setReader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setReader" class="viewSource">view source</a></div><a name="setReader"></a><a name="method-setReader"></a><a href="Ext.data.proxy.Direct.html#" rel="method-setReader" class="cls expand">setReader</a>(
526 <span class="pre">String|Object|Ext.data.reader.Reader reader</span>)
527  : Ext.data.reader.Reader</div><div class="description"><div class="short"><p>Sets the Proxy's Reader by string, config object or Reader instance</p>
528 </div><div class="long"><p>Sets the Proxy's Reader by string, config object or Reader instance</p>
529 <h3 class="pa">Parameters</h3><ul><li><span class="pre">reader</span> : String|Object|Ext.data.reader.Reader<div class="sub-desc"><p>The new Reader, which can be either a type string, a configuration object
530 or an <a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="docClass">Ext.data.reader.Reader</a> instance</p>
531 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.reader.Reader</span>&nbsp; &nbsp;<p>The attached Reader object</p>
532 </li></ul></div></div></div><div id="method-setWriter" class="member inherited"><a href="Ext.data.proxy.Direct.html#method-setWriter" rel="method-setWriter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setWriter" class="viewSource">view source</a></div><a name="setWriter"></a><a name="method-setWriter"></a><a href="Ext.data.proxy.Direct.html#" rel="method-setWriter" class="cls expand">setWriter</a>(
533 <span class="pre">String|Object|Ext.data.writer.Writer writer</span>)
534  : Ext.data.writer.Writer</div><div class="description"><div class="short"><p>Sets the Proxy's Writer by string, config object or Writer instance</p>
535 </div><div class="long"><p>Sets the Proxy's Writer by string, config object or Writer instance</p>
536 <h3 class="pa">Parameters</h3><ul><li><span class="pre">writer</span> : String|Object|Ext.data.writer.Writer<div class="sub-desc"><p>The new Writer, which can be either a type string, a configuration object
537 or an <a href="Ext.data.writer.Writer.html" rel="Ext.data.writer.Writer" class="docClass">Ext.data.writer.Writer</a> instance</p>
538 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.writer.Writer</span>&nbsp; &nbsp;<p>The attached Writer object</p>
539 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
540 <span class="pre">Boolean queueSuspended</span>)
541  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.Direct.html#resumeEvents" rel="Ext.data.proxy.Direct#resumeEvents" class="docClass">resumeEvents</a>)</p>
542 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.Direct.html#resumeEvents" rel="Ext.data.proxy.Direct#resumeEvents" class="docClass">resumeEvents</a>)</p>
543 <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
544 after the <a href="Ext.data.proxy.Direct.html#resumeEvents" rel="Ext.data.proxy.Direct#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
545 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
546 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.proxy.Direct.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.data.proxy.Direct.html#" rel="method-un" class="cls expand">un</a>(
547 <span class="pre">String eventName, Function handler, [Object scope]</span>)
548  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.Direct.html#removeListener" rel="Ext.data.proxy.Direct#removeListener" class="docClass">removeListener</a>.)</p>
549 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.Direct.html#removeListener" rel="Ext.data.proxy.Direct#removeListener" class="docClass">removeListener</a>.)</p>
550 <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>
551 </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.data.proxy.Direct.html#addListener" rel="Ext.data.proxy.Direct#addListener" class="docClass">addListener</a> call.</b></p>
552 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
553 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
554 </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-exception" class="member f inherited"><a href="Ext.data.proxy.Direct.html#event-exception" rel="event-exception" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Server.html" class="definedIn docClass">Ext.data.proxy.Server</a><br/><a href="../source/Server.html#Ext-data.proxy.Server-event-exception" class="viewSource">view source</a></div><a name="exception"></a><a name="event-exception"></a><a href="Ext.data.proxy.Direct.html#" rel="event-exception" class="cls expand">exception</a>(
555 <span class="pre">Ext.data.proxy.Proxy this, Object response, Ext.data.Operation operation</span>)
556 </div><div class="description"><div class="short"><p>Fires when the server returns an exception</p>
557 </div><div class="long"><p>Fires when the server returns an exception</p>
558 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.proxy.Proxy<div class="sub-desc">
559 </div></li><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The response from the AJAX request</p>
560 </div></li><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The operation that triggered request</p>
561 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>