Manager2.html
10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-direct-Manager'>/**
</span> * Ext.Direct aims to streamline communication between the client and server by providing a single interface that
* reduces the amount of common code typically required to validate data and handle returned data packets (reading data,
* error conditions, etc).
*
* The Ext.direct namespace includes several classes for a closer integration with the server-side. The Ext.data
* namespace also includes classes for working with Ext.data.Stores which are backed by data from an Ext.Direct method.
*
* # Specification
*
* For additional information consult the [Ext.Direct Specification][1].
*
* # Providers
*
* Ext.Direct uses a provider architecture, where one or more providers are used to transport data to and from the
* server. There are several providers that exist in the core at the moment:
*
* - {@link Ext.direct.JsonProvider JsonProvider} for simple JSON operations
* - {@link Ext.direct.PollingProvider PollingProvider} for repeated requests
* - {@link Ext.direct.RemotingProvider RemotingProvider} exposes server side on the client.
*
* A provider does not need to be invoked directly, providers are added via {@link Ext.direct.Manager}.{@link #addProvider}.
*
* # Router
*
* Ext.Direct utilizes a "router" on the server to direct requests from the client to the appropriate server-side
* method. Because the Ext.Direct API is completely platform-agnostic, you could completely swap out a Java based server
* solution and replace it with one that uses C# without changing the client side JavaScript at all.
*
* # Server side events
*
* Custom events from the server may be handled by the client by adding listeners, for example:
*
* {"type":"event","name":"message","data":"Successfully polled at: 11:19:30 am"}
*
* // add a handler for a 'message' event sent by the server
* Ext.direct.Manager.on('message', function(e){
* out.append(String.format('<p><i>{0}</i></p>', e.data));
* out.el.scrollTo('t', 100000, true);
* });
*
* [1]: http://sencha.com/products/extjs/extdirect
*
* @singleton
* @alternateClassName Ext.Direct
*/
Ext.define('Ext.direct.Manager', {
/* Begin Definitions */
singleton: true,
mixins: {
observable: 'Ext.util.Observable'
},
requires: ['Ext.util.MixedCollection'],
<span id='Ext-direct-Manager-property-exceptions'> /**
</span> * Exception types.
*/
exceptions: {
TRANSPORT: 'xhr',
PARSE: 'parse',
LOGIN: 'login',
SERVER: 'exception'
},
/* End Definitions */
constructor: function(){
var me = this;
me.addEvents(
<span id='Ext-direct-Manager-event-event'> /**
</span> * @event event
* Fires after an event.
* @param {Ext.direct.Event} e The Ext.direct.Event type that occurred.
* @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
*/
'event',
<span id='Ext-direct-Manager-event-exception'> /**
</span> * @event exception
* Fires after an event exception.
* @param {Ext.direct.Event} e The event type that occurred.
*/
'exception'
);
me.transactions = new Ext.util.MixedCollection();
me.providers = new Ext.util.MixedCollection();
me.mixins.observable.constructor.call(me);
},
<span id='Ext-direct-Manager-method-addProvider'> /**
</span> * Adds an Ext.Direct Provider and creates the proxy or stub methods to execute server-side methods. If the provider
* is not already connected, it will auto-connect.
*
* var pollProv = new Ext.direct.PollingProvider({
* url: 'php/poll2.php'
* });
*
* Ext.direct.Manager.addProvider({
* "type":"remoting", // create a {@link Ext.direct.RemotingProvider}
* "url":"php\/router.php", // url to connect to the Ext.Direct server-side router.
* "actions":{ // each property within the actions object represents a Class
* "TestAction":[ // array of methods within each server side Class
* {
* "name":"doEcho", // name of method
* "len":1
* },{
* "name":"multiply",
* "len":1
* },{
* "name":"doForm",
* "formHandler":true, // handle form on server with Ext.Direct.Transaction
* "len":1
* }]
* },
* "namespace":"myApplication",// namespace to create the Remoting Provider in
* },{
* type: 'polling', // create a {@link Ext.direct.PollingProvider}
* url: 'php/poll.php'
* }, pollProv); // reference to previously created instance
*
* @param {Ext.direct.Provider/Object...} provider
* Accepts any number of Provider descriptions (an instance or config object for
* a Provider). Each Provider description instructs Ext.Directhow to create
* client-side stub methods.
*/
addProvider : function(provider){
var me = this,
args = arguments,
i = 0,
len;
if (args.length > 1) {
for (len = args.length; i < len; ++i) {
me.addProvider(args[i]);
}
return;
}
// if provider has not already been instantiated
if (!provider.isProvider) {
provider = Ext.create('direct.' + provider.type + 'provider', provider);
}
me.providers.add(provider);
provider.on('data', me.onProviderData, me);
if (!provider.isConnected()) {
provider.connect();
}
return provider;
},
<span id='Ext-direct-Manager-method-getProvider'> /**
</span> * Retrieves a {@link Ext.direct.Provider provider} by the **{@link Ext.direct.Provider#id id}** specified when the
* provider is {@link #addProvider added}.
* @param {String/Ext.direct.Provider} id The id of the provider, or the provider instance.
*/
getProvider : function(id){
return id.isProvider ? id : this.providers.get(id);
},
<span id='Ext-direct-Manager-method-removeProvider'> /**
</span> * Removes the provider.
* @param {String/Ext.direct.Provider} provider The provider instance or the id of the provider.
* @return {Ext.direct.Provider} The provider, null if not found.
*/
removeProvider : function(provider){
var me = this,
providers = me.providers;
provider = provider.isProvider ? provider : providers.get(provider);
if (provider) {
provider.un('data', me.onProviderData, me);
providers.remove(provider);
return provider;
}
return null;
},
<span id='Ext-direct-Manager-method-addTransaction'> /**
</span> * Adds a transaction to the manager.
* @private
* @param {Ext.direct.Transaction} transaction The transaction to add
* @return {Ext.direct.Transaction} transaction
*/
addTransaction: function(transaction){
this.transactions.add(transaction);
return transaction;
},
<span id='Ext-direct-Manager-method-removeTransaction'> /**
</span> * Removes a transaction from the manager.
* @private
* @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to remove
* @return {Ext.direct.Transaction} transaction
*/
removeTransaction: function(transaction){
transaction = this.getTransaction(transaction);
this.transactions.remove(transaction);
return transaction;
},
<span id='Ext-direct-Manager-method-getTransaction'> /**
</span> * Gets a transaction
* @private
* @param {String/Ext.direct.Transaction} transaction The transaction/id of transaction to get
* @return {Ext.direct.Transaction}
*/
getTransaction: function(transaction){
return Ext.isObject(transaction) ? transaction : this.transactions.get(transaction);
},
onProviderData : function(provider, event){
var me = this,
i = 0,
len;
if (Ext.isArray(event)) {
for (len = event.length; i < len; ++i) {
me.onProviderData(provider, event[i]);
}
return;
}
if (event.name && event.name != 'event' && event.name != 'exception') {
me.fireEvent(event.name, event);
} else if (event.status === false) {
me.fireEvent('exception', event);
}
me.fireEvent('event', event, provider);
},
<span id='Ext-direct-Manager-method-parseMethod'> /**
</span> * Parses a direct function. It may be passed in a string format, for example:
* "MyApp.Person.read".
* @protected
* @param {String/Function} fn The direct function
* @return {Function} The function to use in the direct call. Null if not found
*/
parseMethod: function(fn){
if (Ext.isString(fn)) {
var parts = fn.split('.'),
i = 0,
len = parts.length,
current = window;
while (current && i < len) {
current = current[parts[i]];
++i;
}
fn = Ext.isFunction(current) ? current : null;
}
return fn || null;
}
}, function(){
// Backwards compatibility
Ext.Direct = Ext.direct.Manager;
});
</pre>
</body>
</html>