2 "name" : "Roo.data.HttpProxy",
10 "desc" : "An implementation of {@link Roo.data.DataProxy} that reads a data object from an {@link Roo.data.Connection} object\nconfigured to reference a certain URL.<br><br>\n<p>\n<em>Note that this class cannot be used to retrieve data from a domain other than the domain\nfrom which the running page was served.<br><br>\n<p>\nFor cross-domain access to remote data, use an {@link Roo.data.ScriptTagProxy}.</em><br><br>\n<p>\nBe aware that to enable the browser to parse an XML document, the server must set\nthe Content-Type header in the HTTP response to \"text/xml\".",
11 "isSingleton" : false,
15 "isBuilderTop" : false,
16 "memberOf" : "HttpProxy",
25 "desc" : "Connection config options to add to each request (e.g. {url: 'foo.php'} or\nan {@link Roo.data.Connection} object. If a Connection config is passed, the singleton {@link Roo.Ajax} object\nwill be used to make the request.",
36 "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
37 "memberOf" : "Roo.util.Observable"
42 "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
43 "memberOf" : "Roo.data.HttpProxy"
48 "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
49 "memberOf" : "Roo.data.HttpProxy"
54 "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
55 "memberOf" : "Roo.data.HttpProxy"
60 "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
61 "memberOf" : "Roo.data.HttpProxy"
64 "name" : "extraParams",
66 "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
67 "memberOf" : "Roo.data.HttpProxy"
70 "name" : "disableCaching",
72 "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
73 "memberOf" : "Roo.data.HttpProxy"
76 "name" : "defaultHeaders",
78 "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
79 "memberOf" : "Roo.data.HttpProxy"
84 "name" : "getConnection",
86 "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
91 "isConstructor" : false,
103 "type" : "Connection",
104 "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
111 "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
112 "sig" : "(params, reader, callback, scope, arg)",
116 "isConstructor" : false,
128 "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
133 "type" : "Roo.data.DataReader",
134 "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
140 "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
146 "desc" : "The scope in which to call the callback",
152 "desc" : "An optional argument which is passed to the callback as its second parameter.",
159 "name" : "purgeListeners",
161 "desc" : "Removes all listeners for this object",
162 "sig" : "()\n{\n\n}",
164 "memberOf" : "Roo.util.Observable",
166 "isConstructor" : false,
180 "desc" : "Appends an event handler to this element (shorthand for addListener)",
181 "sig" : "(eventName, handler, scope, options)",
183 "memberOf" : "Roo.util.Observable",
185 "isConstructor" : false,
195 "name" : "eventName",
197 "desc" : "The type of event to listen for",
203 "desc" : "The method the event invokes",
209 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
215 "desc" : "(optional)",
224 "desc" : "Removes a listener (shorthand for removeListener)",
225 "sig" : "(eventName, handler, scope)",
227 "memberOf" : "Roo.util.Observable",
229 "isConstructor" : false,
239 "name" : "eventName",
241 "desc" : "The type of event to listen for",
247 "desc" : "The handler to remove",
253 "desc" : "(optional) The scope (this object) for the handler",
260 "name" : "addEvents",
262 "desc" : "Used to define events on this Observable",
265 "memberOf" : "Roo.util.Observable",
267 "isConstructor" : false,
279 "desc" : "The object with the events defined",
286 "name" : "releaseCapture",
288 "desc" : "Removes <b>all</b> added captures from the Observable.",
291 "memberOf" : "Roo.util.Observable",
293 "isConstructor" : false,
304 "type" : "Observable",
305 "desc" : "The Observable to release",
312 "name" : "removeListener",
314 "desc" : "Removes a listener",
315 "sig" : "(eventName, handler, scope)",
317 "memberOf" : "Roo.util.Observable",
319 "isConstructor" : false,
329 "name" : "eventName",
331 "desc" : "The type of event to listen for",
337 "desc" : "The handler to remove",
343 "desc" : "(optional) The scope (this object) for the handler",
350 "name" : "fireEvent",
352 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
353 "sig" : "(eventName, args)",
355 "memberOf" : "Roo.util.Observable",
357 "isConstructor" : false,
367 "name" : "eventName",
374 "type" : "Object...",
375 "desc" : "Variable number of parameters are passed to handlers",
383 "desc" : "returns false if any of the handlers return false otherwise it returns true"
388 "name" : "hasListener",
390 "desc" : "Checks to see if this object has any listeners for a specified event",
391 "sig" : "(eventName)",
393 "memberOf" : "Roo.util.Observable",
395 "isConstructor" : false,
405 "name" : "eventName",
407 "desc" : "The name of the event to check for",
415 "desc" : "True if the event is being listened for, else false"
422 "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
423 "sig" : "(o, fn, scope)",
425 "memberOf" : "Roo.util.Observable",
427 "isConstructor" : false,
438 "type" : "Observable",
439 "desc" : "The Observable to capture",
445 "desc" : "The function to call",
451 "desc" : "(optional) The scope (this object) for the fn",
458 "name" : "addListener",
460 "desc" : "Appends an event handler to this component",
461 "sig" : "(eventName, handler, scope, options)",
463 "memberOf" : "Roo.util.Observable",
465 "isConstructor" : false,
475 "name" : "eventName",
477 "desc" : "The type of event to listen for",
483 "desc" : "The method the event invokes",
489 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
495 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
506 "desc" : "Fires before the load method's callback is called.",
507 "sig" : "function (This, o, arg)\n{\n\n}",
508 "memberOf" : "Roo.data.DataProxy",
517 "desc" : "DataProxy object.",
523 "desc" : "The data object.",
529 "desc" : "The callback argument object passed to the load function.",
536 "name" : "beforeload",
538 "desc" : "Fires before a network request is made to retrieve a data object.",
539 "sig" : "function (This, params)\n{\n\n}",
540 "memberOf" : "Roo.data.DataProxy",
549 "desc" : "DataProxy object.",
555 "desc" : "The params parameter to the load function.",
562 "name" : "loadexception",
564 "desc" : "Fires if an Exception occurs during data retrieval.",
565 "sig" : "function (This, o, arg, e)\n{\n\n}",
566 "memberOf" : "Roo.data.DataProxy",
575 "desc" : "DataProxy object.",
581 "desc" : "The data object.",
587 "desc" : "The callback argument object passed to the load function.",
593 "desc" : "The Exception.",