git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.HttpProxy.json

   1 {
   2   "name" : "Roo.data.HttpProxy",
   3   "augments" : [
   4     "Roo.data.DataProxy",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  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,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "HttpProxy",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [
  22     {
  23       "name" : "conn",
  24       "type" : "Object",
  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.",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [],
  30   "throws" : "",
  31   "requires" : "",
  32   "config" : [
  33     {
  34       "name" : "listeners",
  35       "type" : "Object",
  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",
  38       "isOptional" : false,
  39       "optvals" : []
  40     },
  41     {
  42       "name" : "method",
  43       "type" : "String",
  44       "desc" : "T)  The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GE",
  45       "memberOf" : "",
  46       "isOptional" : false,
  47       "optvals" : [
  48         "GET",
  49         "POST"
  50       ]
  51     },
  52     {
  53       "name" : "timeout",
  54       "type" : "Number",
  55       "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
  56       "memberOf" : "",
  57       "isOptional" : false,
  58       "optvals" : []
  59     },
  60     {
  61       "name" : "autoAbort",
  62       "type" : "Boolean",
  63       "desc" : "Whether this request should abort any pending requests. (defaults to false)",
  64       "memberOf" : "",
  65       "isOptional" : false,
  66       "optvals" : []
  67     },
  68     {
  69       "name" : "url",
  70       "type" : "String",
  71       "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
  72       "memberOf" : "",
  73       "isOptional" : false,
  74       "optvals" : []
  75     },
  76     {
  77       "name" : "extraParams",
  78       "type" : "Object",
  79       "desc" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
  80       "memberOf" : "",
  81       "isOptional" : false,
  82       "optvals" : []
  83     },
  84     {
  85       "name" : "disableCaching",
  86       "type" : "Boolean",
  87       "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
  88       "memberOf" : "",
  89       "isOptional" : false,
  90       "optvals" : []
  91     },
  92     {
  93       "name" : "defaultHeaders",
  94       "type" : "Object",
  95       "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
  96       "memberOf" : "",
  97       "isOptional" : false,
  98       "optvals" : []
  99     }
 100   ],
 101   "methods" : [
 102     {
 103       "name" : "getConnection",
 104       "type" : "function",
 105       "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
 106       "sig" : "()\n{\n\n}",
 107       "static" : false,
 108       "memberOf" : "",
 109       "isStatic" : false,
 110       "isConstructor" : false,
 111       "isPrivate" : false,
 112       "example" : "",
 113       "deprecated" : "",
 114       "since" : "",
 115       "see" : "",
 116       "exceptions" : "",
 117       "requires" : "",
 118       "params" : [],
 119       "returns" : [
 120         {
 121           "name" : "",
 122           "type" : "Connection",
 123           "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
 124         }
 125       ]
 126     },
 127     {
 128       "name" : "load",
 129       "type" : "function",
 130       "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.",
 131       "sig" : "(params, reader, callback, scope, arg)",
 132       "static" : false,
 133       "memberOf" : "",
 134       "isStatic" : false,
 135       "isConstructor" : false,
 136       "isPrivate" : false,
 137       "example" : "",
 138       "deprecated" : "",
 139       "since" : "",
 140       "see" : "",
 141       "exceptions" : "",
 142       "requires" : "",
 143       "params" : [
 144         {
 145           "name" : "params",
 146           "type" : "Object",
 147           "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
 148           "isOptional" : false
 149         },
 150         {
 151           "name" : "reader",
 152           "type" : "Roo.data.DataReader",
 153           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
 154           "isOptional" : false
 155         },
 156         {
 157           "name" : "callback",
 158           "type" : "Function",
 159           "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>",
 160           "isOptional" : false
 161         },
 162         {
 163           "name" : "scope",
 164           "type" : "Object",
 165           "desc" : "The scope in which to call the callback",
 166           "isOptional" : false
 167         },
 168         {
 169           "name" : "arg",
 170           "type" : "Object",
 171           "desc" : "An optional argument which is passed to the callback as its second parameter.",
 172           "isOptional" : false
 173         }
 174       ],
 175       "returns" : []
 176     },
 177     {
 178       "name" : "purgeListeners",
 179       "type" : "function",
 180       "desc" : "Removes all listeners for this object",
 181       "sig" : "()\n{\n\n}",
 182       "static" : false,
 183       "memberOf" : "Roo.util.Observable",
 184       "isStatic" : false,
 185       "isConstructor" : false,
 186       "isPrivate" : false,
 187       "example" : "",
 188       "deprecated" : "",
 189       "since" : "",
 190       "see" : "",
 191       "exceptions" : "",
 192       "requires" : "",
 193       "params" : [],
 194       "returns" : []
 195     },
 196     {
 197       "name" : "on",
 198       "type" : "function",
 199       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 200       "sig" : "(eventName, handler, scope, options)",
 201       "static" : false,
 202       "memberOf" : "Roo.util.Observable",
 203       "isStatic" : false,
 204       "isConstructor" : false,
 205       "isPrivate" : false,
 206       "example" : "",
 207       "deprecated" : "",
 208       "since" : "",
 209       "see" : "",
 210       "exceptions" : "",
 211       "requires" : "",
 212       "params" : [
 213         {
 214           "name" : "eventName",
 215           "type" : "String",
 216           "desc" : "The type of event to listen for",
 217           "isOptional" : false
 218         },
 219         {
 220           "name" : "handler",
 221           "type" : "Function",
 222           "desc" : "The method the event invokes",
 223           "isOptional" : false
 224         },
 225         {
 226           "name" : "scope",
 227           "type" : "Object",
 228           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 229           "isOptional" : false
 230         },
 231         {
 232           "name" : "options",
 233           "type" : "Object",
 234           "desc" : "(optional)",
 235           "isOptional" : false
 236         }
 237       ],
 238       "returns" : []
 239     },
 240     {
 241       "name" : "un",
 242       "type" : "function",
 243       "desc" : "Removes a listener (shorthand for removeListener)",
 244       "sig" : "(eventName, handler, scope)",
 245       "static" : false,
 246       "memberOf" : "Roo.util.Observable",
 247       "isStatic" : false,
 248       "isConstructor" : false,
 249       "isPrivate" : false,
 250       "example" : "",
 251       "deprecated" : "",
 252       "since" : "",
 253       "see" : "",
 254       "exceptions" : "",
 255       "requires" : "",
 256       "params" : [
 257         {
 258           "name" : "eventName",
 259           "type" : "String",
 260           "desc" : "The type of event to listen for",
 261           "isOptional" : false
 262         },
 263         {
 264           "name" : "handler",
 265           "type" : "Function",
 266           "desc" : "The handler to remove",
 267           "isOptional" : false
 268         },
 269         {
 270           "name" : "scope",
 271           "type" : "Object",
 272           "desc" : "(optional) The scope (this object) for the handler",
 273           "isOptional" : false
 274         }
 275       ],
 276       "returns" : []
 277     },
 278     {
 279       "name" : "addEvents",
 280       "type" : "function",
 281       "desc" : "Used to define events on this Observable",
 282       "sig" : "(object)",
 283       "static" : false,
 284       "memberOf" : "Roo.util.Observable",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "example" : "",
 289       "deprecated" : "",
 290       "since" : "",
 291       "see" : "",
 292       "exceptions" : "",
 293       "requires" : "",
 294       "params" : [
 295         {
 296           "name" : "object",
 297           "type" : "Object",
 298           "desc" : "The object with the events defined",
 299           "isOptional" : false
 300         }
 301       ],
 302       "returns" : []
 303     },
 304     {
 305       "name" : "releaseCapture",
 306       "type" : "function",
 307       "desc" : "Removes <b>all</b> added captures from the Observable.",
 308       "sig" : "(o)",
 309       "static" : true,
 310       "memberOf" : "Roo.util.Observable",
 311       "isStatic" : true,
 312       "isConstructor" : false,
 313       "isPrivate" : false,
 314       "example" : "",
 315       "deprecated" : "",
 316       "since" : "",
 317       "see" : "",
 318       "exceptions" : "",
 319       "requires" : "",
 320       "params" : [
 321         {
 322           "name" : "o",
 323           "type" : "Observable",
 324           "desc" : "The Observable to release",
 325           "isOptional" : false
 326         }
 327       ],
 328       "returns" : []
 329     },
 330     {
 331       "name" : "removeListener",
 332       "type" : "function",
 333       "desc" : "Removes a listener",
 334       "sig" : "(eventName, handler, scope)",
 335       "static" : false,
 336       "memberOf" : "Roo.util.Observable",
 337       "isStatic" : false,
 338       "isConstructor" : false,
 339       "isPrivate" : false,
 340       "example" : "",
 341       "deprecated" : "",
 342       "since" : "",
 343       "see" : "",
 344       "exceptions" : "",
 345       "requires" : "",
 346       "params" : [
 347         {
 348           "name" : "eventName",
 349           "type" : "String",
 350           "desc" : "The type of event to listen for",
 351           "isOptional" : false
 352         },
 353         {
 354           "name" : "handler",
 355           "type" : "Function",
 356           "desc" : "The handler to remove",
 357           "isOptional" : false
 358         },
 359         {
 360           "name" : "scope",
 361           "type" : "Object",
 362           "desc" : "(optional) The scope (this object) for the handler",
 363           "isOptional" : false
 364         }
 365       ],
 366       "returns" : []
 367     },
 368     {
 369       "name" : "fireEvent",
 370       "type" : "function",
 371       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 372       "sig" : "(eventName, args)",
 373       "static" : false,
 374       "memberOf" : "Roo.util.Observable",
 375       "isStatic" : false,
 376       "isConstructor" : false,
 377       "isPrivate" : false,
 378       "example" : "",
 379       "deprecated" : "",
 380       "since" : "",
 381       "see" : "",
 382       "exceptions" : "",
 383       "requires" : "",
 384       "params" : [
 385         {
 386           "name" : "eventName",
 387           "type" : "String",
 388           "desc" : "",
 389           "isOptional" : false
 390         },
 391         {
 392           "name" : "args",
 393           "type" : "Object...",
 394           "desc" : "Variable number of parameters are passed to handlers",
 395           "isOptional" : false
 396         }
 397       ],
 398       "returns" : [
 399         {
 400           "name" : "",
 401           "type" : "Boolean",
 402           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 403         }
 404       ]
 405     },
 406     {
 407       "name" : "hasListener",
 408       "type" : "function",
 409       "desc" : "Checks to see if this object has any listeners for a specified event",
 410       "sig" : "(eventName)",
 411       "static" : false,
 412       "memberOf" : "Roo.util.Observable",
 413       "isStatic" : false,
 414       "isConstructor" : false,
 415       "isPrivate" : false,
 416       "example" : "",
 417       "deprecated" : "",
 418       "since" : "",
 419       "see" : "",
 420       "exceptions" : "",
 421       "requires" : "",
 422       "params" : [
 423         {
 424           "name" : "eventName",
 425           "type" : "String",
 426           "desc" : "The name of the event to check for",
 427           "isOptional" : false
 428         }
 429       ],
 430       "returns" : [
 431         {
 432           "name" : "",
 433           "type" : "Boolean",
 434           "desc" : "True if the event is being listened for, else false"
 435         }
 436       ]
 437     },
 438     {
 439       "name" : "capture",
 440       "type" : "function",
 441       "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.",
 442       "sig" : "(o, fn, scope)",
 443       "static" : true,
 444       "memberOf" : "Roo.util.Observable",
 445       "isStatic" : true,
 446       "isConstructor" : false,
 447       "isPrivate" : false,
 448       "example" : "",
 449       "deprecated" : "",
 450       "since" : "",
 451       "see" : "",
 452       "exceptions" : "",
 453       "requires" : "",
 454       "params" : [
 455         {
 456           "name" : "o",
 457           "type" : "Observable",
 458           "desc" : "The Observable to capture",
 459           "isOptional" : false
 460         },
 461         {
 462           "name" : "fn",
 463           "type" : "Function",
 464           "desc" : "The function to call",
 465           "isOptional" : false
 466         },
 467         {
 468           "name" : "scope",
 469           "type" : "Object",
 470           "desc" : "(optional) The scope (this object) for the fn",
 471           "isOptional" : false
 472         }
 473       ],
 474       "returns" : []
 475     },
 476     {
 477       "name" : "addListener",
 478       "type" : "function",
 479       "desc" : "Appends an event handler to this component",
 480       "sig" : "(eventName, handler, scope, options)",
 481       "static" : false,
 482       "memberOf" : "Roo.util.Observable",
 483       "isStatic" : false,
 484       "isConstructor" : false,
 485       "isPrivate" : false,
 486       "example" : "",
 487       "deprecated" : "",
 488       "since" : "",
 489       "see" : "",
 490       "exceptions" : "",
 491       "requires" : "",
 492       "params" : [
 493         {
 494           "name" : "eventName",
 495           "type" : "String",
 496           "desc" : "The type of event to listen for",
 497           "isOptional" : false
 498         },
 499         {
 500           "name" : "handler",
 501           "type" : "Function",
 502           "desc" : "The method the event invokes",
 503           "isOptional" : false
 504         },
 505         {
 506           "name" : "scope",
 507           "type" : "Object",
 508           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 509           "isOptional" : false
 510         },
 511         {
 512           "name" : "options",
 513           "type" : "Object",
 514           "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>",
 515           "isOptional" : false
 516         }
 517       ],
 518       "returns" : []
 519     }
 520   ],
 521   "events" : [
 522     {
 523       "name" : "load",
 524       "type" : "function",
 525       "desc" : "Fires before the load method's callback is called.",
 526       "sig" : "function (This, o, arg)\n{\n\n}",
 527       "memberOf" : "Roo.data.DataProxy",
 528       "example" : "",
 529       "deprecated" : "",
 530       "since" : "",
 531       "see" : "",
 532       "params" : [
 533         {
 534           "name" : "This",
 535           "type" : "Object",
 536           "desc" : "DataProxy object.",
 537           "isOptional" : false
 538         },
 539         {
 540           "name" : "o",
 541           "type" : "Object",
 542           "desc" : "The data object.",
 543           "isOptional" : false
 544         },
 545         {
 546           "name" : "arg",
 547           "type" : "Object",
 548           "desc" : "The callback argument object passed to the load function.",
 549           "isOptional" : false
 550         }
 551       ],
 552       "returns" : []
 553     },
 554     {
 555       "name" : "beforeload",
 556       "type" : "function",
 557       "desc" : "Fires before a network request is made to retrieve a data object.",
 558       "sig" : "function (This, params)\n{\n\n}",
 559       "memberOf" : "Roo.data.DataProxy",
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "params" : [
 565         {
 566           "name" : "This",
 567           "type" : "Object",
 568           "desc" : "DataProxy object.",
 569           "isOptional" : false
 570         },
 571         {
 572           "name" : "params",
 573           "type" : "Object",
 574           "desc" : "The params parameter to the load function.",
 575           "isOptional" : false
 576         }
 577       ],
 578       "returns" : []
 579     },
 580     {
 581       "name" : "loadexception",
 582       "type" : "function",
 583       "desc" : "Fires if an Exception occurs during data retrieval.",
 584       "sig" : "function (This, o, arg, e)\n{\n\n}",
 585       "memberOf" : "Roo.data.DataProxy",
 586       "example" : "",
 587       "deprecated" : "",
 588       "since" : "",
 589       "see" : "",
 590       "params" : [
 591         {
 592           "name" : "This",
 593           "type" : "Object",
 594           "desc" : "DataProxy object.",
 595           "isOptional" : false
 596         },
 597         {
 598           "name" : "o",
 599           "type" : "Object",
 600           "desc" : "The data object.",
 601           "isOptional" : false
 602         },
 603         {
 604           "name" : "arg",
 605           "type" : "Object",
 606           "desc" : "The callback argument object passed to the load function.",
 607           "isOptional" : false
 608         },
 609         {
 610           "name" : "e",
 611           "type" : "Object",
 612           "desc" : "The Exception.",
 613           "isOptional" : false
 614         }
 615       ],
 616       "returns" : []
 617     }
 618   ]
 619 }