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