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

   1 {
   2   "name" : "Roo.data.DataProxy",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "childClasses" : {
   7     "Roo.data.DataProxy" : [
   8       "Roo.data.HttpProxy"
   9     ]
  10   },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "desc" : "This class is an abstract base class for implementations which provide retrieval of\nunformatted data objects.<br>\n<p>\nDataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader\n(of the appropriate type which knows how to parse the data object) to provide a block of\n{@link Roo.data.Records} to an {@link Roo.data.Store}.<br>\n<p>\nCustom implementations must implement the load method as described in\n{@link Roo.data.HttpProxy#load}.",
  14   "isSingleton" : false,
  15   "isStatic" : true,
  16   "isBuiltin" : false,
  17   "isAbstract" : true,
  18   "isBuilderTop" : false,
  19   "memberOf" : "DataProxy",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [],
  25   "returns" : [],
  26   "throws" : "",
  27   "requires" : "",
  28   "config" : [
  29     {
  30       "name" : "listeners",
  31       "type" : "Object",
  32       "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>",
  33       "memberOf" : "Roo.util.Observable"
  34     }
  35   ],
  36   "methods" : [
  37     {
  38       "name" : "purgeListeners",
  39       "type" : "function",
  40       "desc" : "Removes all listeners for this object",
  41       "sig" : "()\n{\n\n}",
  42       "static" : false,
  43       "memberOf" : "Roo.util.Observable",
  44       "isStatic" : false,
  45       "isConstructor" : false,
  46       "isPrivate" : false,
  47       "example" : "",
  48       "deprecated" : "",
  49       "since" : "",
  50       "see" : "",
  51       "exceptions" : "",
  52       "requires" : "",
  53       "params" : [],
  54       "returns" : []
  55     },
  56     {
  57       "name" : "on",
  58       "type" : "function",
  59       "desc" : "Appends an event handler to this element (shorthand for addListener)",
  60       "sig" : "(eventName, handler, scope, options)",
  61       "static" : false,
  62       "memberOf" : "Roo.util.Observable",
  63       "isStatic" : false,
  64       "isConstructor" : false,
  65       "isPrivate" : false,
  66       "example" : "",
  67       "deprecated" : "",
  68       "since" : "",
  69       "see" : "",
  70       "exceptions" : "",
  71       "requires" : "",
  72       "params" : [
  73         {
  74           "name" : "eventName",
  75           "type" : "String",
  76           "desc" : "The type of event to listen for",
  77           "isOptional" : false
  78         },
  79         {
  80           "name" : "handler",
  81           "type" : "Function",
  82           "desc" : "The method the event invokes",
  83           "isOptional" : false
  84         },
  85         {
  86           "name" : "scope",
  87           "type" : "Object",
  88           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
  89           "isOptional" : false
  90         },
  91         {
  92           "name" : "options",
  93           "type" : "Object",
  94           "desc" : "(optional)",
  95           "isOptional" : false
  96         }
  97       ],
  98       "returns" : []
  99     },
 100     {
 101       "name" : "un",
 102       "type" : "function",
 103       "desc" : "Removes a listener (shorthand for removeListener)",
 104       "sig" : "(eventName, handler, scope)",
 105       "static" : false,
 106       "memberOf" : "Roo.util.Observable",
 107       "isStatic" : false,
 108       "isConstructor" : false,
 109       "isPrivate" : false,
 110       "example" : "",
 111       "deprecated" : "",
 112       "since" : "",
 113       "see" : "",
 114       "exceptions" : "",
 115       "requires" : "",
 116       "params" : [
 117         {
 118           "name" : "eventName",
 119           "type" : "String",
 120           "desc" : "The type of event to listen for",
 121           "isOptional" : false
 122         },
 123         {
 124           "name" : "handler",
 125           "type" : "Function",
 126           "desc" : "The handler to remove",
 127           "isOptional" : false
 128         },
 129         {
 130           "name" : "scope",
 131           "type" : "Object",
 132           "desc" : "(optional) The scope (this object) for the handler",
 133           "isOptional" : false
 134         }
 135       ],
 136       "returns" : []
 137     },
 138     {
 139       "name" : "addEvents",
 140       "type" : "function",
 141       "desc" : "Used to define events on this Observable",
 142       "sig" : "(object)",
 143       "static" : false,
 144       "memberOf" : "Roo.util.Observable",
 145       "isStatic" : false,
 146       "isConstructor" : false,
 147       "isPrivate" : false,
 148       "example" : "",
 149       "deprecated" : "",
 150       "since" : "",
 151       "see" : "",
 152       "exceptions" : "",
 153       "requires" : "",
 154       "params" : [
 155         {
 156           "name" : "object",
 157           "type" : "Object",
 158           "desc" : "The object with the events defined",
 159           "isOptional" : false
 160         }
 161       ],
 162       "returns" : []
 163     },
 164     {
 165       "name" : "releaseCapture",
 166       "type" : "function",
 167       "desc" : "Removes <b>all</b> added captures from the Observable.",
 168       "sig" : "(o)",
 169       "static" : true,
 170       "memberOf" : "Roo.util.Observable",
 171       "isStatic" : true,
 172       "isConstructor" : false,
 173       "isPrivate" : false,
 174       "example" : "",
 175       "deprecated" : "",
 176       "since" : "",
 177       "see" : "",
 178       "exceptions" : "",
 179       "requires" : "",
 180       "params" : [
 181         {
 182           "name" : "o",
 183           "type" : "Observable",
 184           "desc" : "The Observable to release",
 185           "isOptional" : false
 186         }
 187       ],
 188       "returns" : []
 189     },
 190     {
 191       "name" : "removeListener",
 192       "type" : "function",
 193       "desc" : "Removes a listener",
 194       "sig" : "(eventName, handler, scope)",
 195       "static" : false,
 196       "memberOf" : "Roo.util.Observable",
 197       "isStatic" : false,
 198       "isConstructor" : false,
 199       "isPrivate" : false,
 200       "example" : "",
 201       "deprecated" : "",
 202       "since" : "",
 203       "see" : "",
 204       "exceptions" : "",
 205       "requires" : "",
 206       "params" : [
 207         {
 208           "name" : "eventName",
 209           "type" : "String",
 210           "desc" : "The type of event to listen for",
 211           "isOptional" : false
 212         },
 213         {
 214           "name" : "handler",
 215           "type" : "Function",
 216           "desc" : "The handler to remove",
 217           "isOptional" : false
 218         },
 219         {
 220           "name" : "scope",
 221           "type" : "Object",
 222           "desc" : "(optional) The scope (this object) for the handler",
 223           "isOptional" : false
 224         }
 225       ],
 226       "returns" : []
 227     },
 228     {
 229       "name" : "fireEvent",
 230       "type" : "function",
 231       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 232       "sig" : "(eventName, args)",
 233       "static" : false,
 234       "memberOf" : "Roo.util.Observable",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "example" : "",
 239       "deprecated" : "",
 240       "since" : "",
 241       "see" : "",
 242       "exceptions" : "",
 243       "requires" : "",
 244       "params" : [
 245         {
 246           "name" : "eventName",
 247           "type" : "String",
 248           "desc" : "",
 249           "isOptional" : false
 250         },
 251         {
 252           "name" : "args",
 253           "type" : "Object...",
 254           "desc" : "Variable number of parameters are passed to handlers",
 255           "isOptional" : false
 256         }
 257       ],
 258       "returns" : [
 259         {
 260           "name" : "",
 261           "type" : "Boolean",
 262           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 263         }
 264       ]
 265     },
 266     {
 267       "name" : "hasListener",
 268       "type" : "function",
 269       "desc" : "Checks to see if this object has any listeners for a specified event",
 270       "sig" : "(eventName)",
 271       "static" : false,
 272       "memberOf" : "Roo.util.Observable",
 273       "isStatic" : false,
 274       "isConstructor" : false,
 275       "isPrivate" : false,
 276       "example" : "",
 277       "deprecated" : "",
 278       "since" : "",
 279       "see" : "",
 280       "exceptions" : "",
 281       "requires" : "",
 282       "params" : [
 283         {
 284           "name" : "eventName",
 285           "type" : "String",
 286           "desc" : "The name of the event to check for",
 287           "isOptional" : false
 288         }
 289       ],
 290       "returns" : [
 291         {
 292           "name" : "",
 293           "type" : "Boolean",
 294           "desc" : "True if the event is being listened for, else false"
 295         }
 296       ]
 297     },
 298     {
 299       "name" : "capture",
 300       "type" : "function",
 301       "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.",
 302       "sig" : "(o, fn, scope)",
 303       "static" : true,
 304       "memberOf" : "Roo.util.Observable",
 305       "isStatic" : true,
 306       "isConstructor" : false,
 307       "isPrivate" : false,
 308       "example" : "",
 309       "deprecated" : "",
 310       "since" : "",
 311       "see" : "",
 312       "exceptions" : "",
 313       "requires" : "",
 314       "params" : [
 315         {
 316           "name" : "o",
 317           "type" : "Observable",
 318           "desc" : "The Observable to capture",
 319           "isOptional" : false
 320         },
 321         {
 322           "name" : "fn",
 323           "type" : "Function",
 324           "desc" : "The function to call",
 325           "isOptional" : false
 326         },
 327         {
 328           "name" : "scope",
 329           "type" : "Object",
 330           "desc" : "(optional) The scope (this object) for the fn",
 331           "isOptional" : false
 332         }
 333       ],
 334       "returns" : []
 335     },
 336     {
 337       "name" : "addListener",
 338       "type" : "function",
 339       "desc" : "Appends an event handler to this component",
 340       "sig" : "(eventName, handler, scope, options)",
 341       "static" : false,
 342       "memberOf" : "Roo.util.Observable",
 343       "isStatic" : false,
 344       "isConstructor" : false,
 345       "isPrivate" : false,
 346       "example" : "",
 347       "deprecated" : "",
 348       "since" : "",
 349       "see" : "",
 350       "exceptions" : "",
 351       "requires" : "",
 352       "params" : [
 353         {
 354           "name" : "eventName",
 355           "type" : "String",
 356           "desc" : "The type of event to listen for",
 357           "isOptional" : false
 358         },
 359         {
 360           "name" : "handler",
 361           "type" : "Function",
 362           "desc" : "The method the event invokes",
 363           "isOptional" : false
 364         },
 365         {
 366           "name" : "scope",
 367           "type" : "Object",
 368           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 369           "isOptional" : false
 370         },
 371         {
 372           "name" : "options",
 373           "type" : "Object",
 374           "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>",
 375           "isOptional" : false
 376         }
 377       ],
 378       "returns" : []
 379     }
 380   ],
 381   "events" : [
 382     {
 383       "name" : "load",
 384       "type" : "function",
 385       "desc" : "Fires before the load method's callback is called.",
 386       "sig" : "function (This, o, arg)\n{\n\n}",
 387       "memberOf" : "",
 388       "example" : "",
 389       "deprecated" : "",
 390       "since" : "",
 391       "see" : "",
 392       "params" : [
 393         {
 394           "name" : "This",
 395           "type" : "Object",
 396           "desc" : "DataProxy object.",
 397           "isOptional" : false
 398         },
 399         {
 400           "name" : "o",
 401           "type" : "Object",
 402           "desc" : "The data object.",
 403           "isOptional" : false
 404         },
 405         {
 406           "name" : "arg",
 407           "type" : "Object",
 408           "desc" : "The callback argument object passed to the load function.",
 409           "isOptional" : false
 410         }
 411       ],
 412       "returns" : []
 413     },
 414     {
 415       "name" : "beforeload",
 416       "type" : "function",
 417       "desc" : "Fires before a network request is made to retrieve a data object.",
 418       "sig" : "function (This, params)\n{\n\n}",
 419       "memberOf" : "",
 420       "example" : "",
 421       "deprecated" : "",
 422       "since" : "",
 423       "see" : "",
 424       "params" : [
 425         {
 426           "name" : "This",
 427           "type" : "Object",
 428           "desc" : "DataProxy object.",
 429           "isOptional" : false
 430         },
 431         {
 432           "name" : "params",
 433           "type" : "Object",
 434           "desc" : "The params parameter to the load function.",
 435           "isOptional" : false
 436         }
 437       ],
 438       "returns" : []
 439     },
 440     {
 441       "name" : "loadexception",
 442       "type" : "function",
 443       "desc" : "Fires if an Exception occurs during data retrieval.",
 444       "sig" : "function (This, o, arg, e)\n{\n\n}",
 445       "memberOf" : "",
 446       "example" : "",
 447       "deprecated" : "",
 448       "since" : "",
 449       "see" : "",
 450       "params" : [
 451         {
 452           "name" : "This",
 453           "type" : "Object",
 454           "desc" : "DataProxy object.",
 455           "isOptional" : false
 456         },
 457         {
 458           "name" : "o",
 459           "type" : "Object",
 460           "desc" : "The data object.",
 461           "isOptional" : false
 462         },
 463         {
 464           "name" : "arg",
 465           "type" : "Object",
 466           "desc" : "The callback argument object passed to the load function.",
 467           "isOptional" : false
 468         },
 469         {
 470           "name" : "e",
 471           "type" : "Object",
 472           "desc" : "The Exception.",
 473           "isOptional" : false
 474         }
 475       ],
 476       "returns" : []
 477     }
 478   ]
 479 }