X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.Ajax.json;fp=docs%2Fsymbols%2FRoo.Ajax.json;h=079d703a2e2ce2359ad4aa50237e583012af4a77;hp=7555e1160fdc187b7275637012db48d03f3770f7;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.Ajax.json b/docs/symbols/Roo.Ajax.json index 7555e1160f..079d703a2e 100644 --- a/docs/symbols/Roo.Ajax.json +++ b/docs/symbols/Roo.Ajax.json @@ -4,10 +4,15 @@ "Roo.data.Connection", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "Global Ajax request class.", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "Ajax", "example" : "", "deprecated" : "", @@ -15,76 +20,75 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n
",
- "memberOf" : "Roo.util.Observable",
- "optvals" : []
+ "memberOf" : "Roo.util.Observable"
},
{
"name" : "method",
"type" : "String",
"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)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "autoAbort",
"type" : "Boolean",
"desc" : "(Optional) Whether a new request should abort any pending requests. (defaults to false)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "url",
"type" : "String",
"desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "extraParams",
"type" : "Object",
"desc" : "An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "disableCaching",
"type" : "Boolean",
"desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "defaultHeaders",
"type" : "Object",
"desc" : "An object containing request headers which are added to each request made by this object. (defaults to undefined)",
- "memberOf" : "Roo.Ajax",
- "optvals" : []
+ "memberOf" : "Roo.Ajax"
}
],
"methods" : [
{
"name" : "isLoading",
+ "type" : "function",
"desc" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "Roo.data.Connection",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "transactionId",
@@ -103,15 +107,20 @@
},
{
"name" : "request",
+ "type" : "function",
"desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Connection",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "options",
@@ -130,15 +139,20 @@
},
{
"name" : "abort",
+ "type" : "function",
"desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "Roo.data.Connection",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "transactionId",
@@ -151,29 +165,39 @@
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -204,15 +228,20 @@
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -237,15 +266,20 @@
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
@@ -258,15 +292,20 @@
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes all added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -279,15 +318,20 @@
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -312,15 +356,20 @@
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -345,15 +394,20 @@
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -372,15 +426,20 @@
},
{
"name" : "capture",
+ "type" : "function",
"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\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -405,15 +464,20 @@
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -446,7 +510,9 @@
"events" : [
{
"name" : "requestcomplete",
+ "type" : "function",
"desc" : "Fires if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",
@@ -476,7 +542,9 @@
},
{
"name" : "beforerequest",
+ "type" : "function",
"desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
"memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",
@@ -500,7 +568,9 @@
},
{
"name" : "requestexception",
+ "type" : "function",
"desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "Roo.data.Connection",
"example" : "",
"deprecated" : "",