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

   1 {
   2   "name" : "Roo.data.MemoryProxy",
   3   "augments" : [
   4     "Roo.data.DataProxy",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  10   "desc" : "An implementation of Roo.data.DataProxy that simply passes the data specified in its constructor\nto the Reader when its load method is called.",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "MemoryProxy",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "A config object containing the objects needed for the Store to access data,",
  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" : "data",
  43       "type" : "Object",
  44       "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
  45       "memberOf" : "",
  46       "isOptional" : false,
  47       "optvals" : []
  48     }
  49   ],
  50   "methods" : [
  51     {
  52       "name" : "load",
  53       "type" : "function",
  54       "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
  55       "sig" : "(params, reader, callback, scope, arg)",
  56       "static" : false,
  57       "memberOf" : "",
  58       "isStatic" : false,
  59       "isConstructor" : false,
  60       "isPrivate" : false,
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "exceptions" : "",
  66       "requires" : "",
  67       "params" : [
  68         {
  69           "name" : "params",
  70           "type" : "Object",
  71           "desc" : "This parameter is not used by the MemoryProxy class.",
  72           "isOptional" : false
  73         },
  74         {
  75           "name" : "reader",
  76           "type" : "Roo.data.DataReader",
  77           "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
  78           "isOptional" : false
  79         },
  80         {
  81           "name" : "callback",
  82           "type" : "Function",
  83           "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>",
  84           "isOptional" : false
  85         },
  86         {
  87           "name" : "scope",
  88           "type" : "Object",
  89           "desc" : "The scope in which to call the callback",
  90           "isOptional" : false
  91         },
  92         {
  93           "name" : "arg",
  94           "type" : "Object",
  95           "desc" : "An optional argument which is passed to the callback as its second parameter.",
  96           "isOptional" : false
  97         }
  98       ],
  99       "returns" : []
 100     },
 101     {
 102       "name" : "purgeListeners",
 103       "type" : "function",
 104       "desc" : "Removes all listeners for this object",
 105       "sig" : "()\n{\n\n}",
 106       "static" : false,
 107       "memberOf" : "Roo.util.Observable",
 108       "isStatic" : false,
 109       "isConstructor" : false,
 110       "isPrivate" : false,
 111       "example" : "",
 112       "deprecated" : "",
 113       "since" : "",
 114       "see" : "",
 115       "exceptions" : "",
 116       "requires" : "",
 117       "params" : [],
 118       "returns" : []
 119     },
 120     {
 121       "name" : "on",
 122       "type" : "function",
 123       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 124       "sig" : "(eventName, handler, scope, options)",
 125       "static" : false,
 126       "memberOf" : "Roo.util.Observable",
 127       "isStatic" : false,
 128       "isConstructor" : false,
 129       "isPrivate" : false,
 130       "example" : "",
 131       "deprecated" : "",
 132       "since" : "",
 133       "see" : "",
 134       "exceptions" : "",
 135       "requires" : "",
 136       "params" : [
 137         {
 138           "name" : "eventName",
 139           "type" : "String",
 140           "desc" : "The type of event to listen for",
 141           "isOptional" : false
 142         },
 143         {
 144           "name" : "handler",
 145           "type" : "Function",
 146           "desc" : "The method the event invokes",
 147           "isOptional" : false
 148         },
 149         {
 150           "name" : "scope",
 151           "type" : "Object",
 152           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 153           "isOptional" : false
 154         },
 155         {
 156           "name" : "options",
 157           "type" : "Object",
 158           "desc" : "(optional)",
 159           "isOptional" : false
 160         }
 161       ],
 162       "returns" : []
 163     },
 164     {
 165       "name" : "un",
 166       "type" : "function",
 167       "desc" : "Removes a listener (shorthand for removeListener)",
 168       "sig" : "(eventName, handler, scope)",
 169       "static" : false,
 170       "memberOf" : "Roo.util.Observable",
 171       "isStatic" : false,
 172       "isConstructor" : false,
 173       "isPrivate" : false,
 174       "example" : "",
 175       "deprecated" : "",
 176       "since" : "",
 177       "see" : "",
 178       "exceptions" : "",
 179       "requires" : "",
 180       "params" : [
 181         {
 182           "name" : "eventName",
 183           "type" : "String",
 184           "desc" : "The type of event to listen for",
 185           "isOptional" : false
 186         },
 187         {
 188           "name" : "handler",
 189           "type" : "Function",
 190           "desc" : "The handler to remove",
 191           "isOptional" : false
 192         },
 193         {
 194           "name" : "scope",
 195           "type" : "Object",
 196           "desc" : "(optional) The scope (this object) for the handler",
 197           "isOptional" : false
 198         }
 199       ],
 200       "returns" : []
 201     },
 202     {
 203       "name" : "addEvents",
 204       "type" : "function",
 205       "desc" : "Used to define events on this Observable",
 206       "sig" : "(object)",
 207       "static" : false,
 208       "memberOf" : "Roo.util.Observable",
 209       "isStatic" : false,
 210       "isConstructor" : false,
 211       "isPrivate" : false,
 212       "example" : "",
 213       "deprecated" : "",
 214       "since" : "",
 215       "see" : "",
 216       "exceptions" : "",
 217       "requires" : "",
 218       "params" : [
 219         {
 220           "name" : "object",
 221           "type" : "Object",
 222           "desc" : "The object with the events defined",
 223           "isOptional" : false
 224         }
 225       ],
 226       "returns" : []
 227     },
 228     {
 229       "name" : "releaseCapture",
 230       "type" : "function",
 231       "desc" : "Removes <b>all</b> added captures from the Observable.",
 232       "sig" : "(o)",
 233       "static" : true,
 234       "memberOf" : "Roo.util.Observable",
 235       "isStatic" : true,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "example" : "",
 239       "deprecated" : "",
 240       "since" : "",
 241       "see" : "",
 242       "exceptions" : "",
 243       "requires" : "",
 244       "params" : [
 245         {
 246           "name" : "o",
 247           "type" : "Observable",
 248           "desc" : "The Observable to release",
 249           "isOptional" : false
 250         }
 251       ],
 252       "returns" : []
 253     },
 254     {
 255       "name" : "removeListener",
 256       "type" : "function",
 257       "desc" : "Removes a listener",
 258       "sig" : "(eventName, handler, scope)",
 259       "static" : false,
 260       "memberOf" : "Roo.util.Observable",
 261       "isStatic" : false,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "example" : "",
 265       "deprecated" : "",
 266       "since" : "",
 267       "see" : "",
 268       "exceptions" : "",
 269       "requires" : "",
 270       "params" : [
 271         {
 272           "name" : "eventName",
 273           "type" : "String",
 274           "desc" : "The type of event to listen for",
 275           "isOptional" : false
 276         },
 277         {
 278           "name" : "handler",
 279           "type" : "Function",
 280           "desc" : "The handler to remove",
 281           "isOptional" : false
 282         },
 283         {
 284           "name" : "scope",
 285           "type" : "Object",
 286           "desc" : "(optional) The scope (this object) for the handler",
 287           "isOptional" : false
 288         }
 289       ],
 290       "returns" : []
 291     },
 292     {
 293       "name" : "fireEvent",
 294       "type" : "function",
 295       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 296       "sig" : "(eventName, args)",
 297       "static" : false,
 298       "memberOf" : "Roo.util.Observable",
 299       "isStatic" : false,
 300       "isConstructor" : false,
 301       "isPrivate" : false,
 302       "example" : "",
 303       "deprecated" : "",
 304       "since" : "",
 305       "see" : "",
 306       "exceptions" : "",
 307       "requires" : "",
 308       "params" : [
 309         {
 310           "name" : "eventName",
 311           "type" : "String",
 312           "desc" : "",
 313           "isOptional" : false
 314         },
 315         {
 316           "name" : "args",
 317           "type" : "Object...",
 318           "desc" : "Variable number of parameters are passed to handlers",
 319           "isOptional" : false
 320         }
 321       ],
 322       "returns" : [
 323         {
 324           "name" : "",
 325           "type" : "Boolean",
 326           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 327         }
 328       ]
 329     },
 330     {
 331       "name" : "hasListener",
 332       "type" : "function",
 333       "desc" : "Checks to see if this object has any listeners for a specified event",
 334       "sig" : "(eventName)",
 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 name of the event to check for",
 351           "isOptional" : false
 352         }
 353       ],
 354       "returns" : [
 355         {
 356           "name" : "",
 357           "type" : "Boolean",
 358           "desc" : "True if the event is being listened for, else false"
 359         }
 360       ]
 361     },
 362     {
 363       "name" : "capture",
 364       "type" : "function",
 365       "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.",
 366       "sig" : "(o, fn, scope)",
 367       "static" : true,
 368       "memberOf" : "Roo.util.Observable",
 369       "isStatic" : true,
 370       "isConstructor" : false,
 371       "isPrivate" : false,
 372       "example" : "",
 373       "deprecated" : "",
 374       "since" : "",
 375       "see" : "",
 376       "exceptions" : "",
 377       "requires" : "",
 378       "params" : [
 379         {
 380           "name" : "o",
 381           "type" : "Observable",
 382           "desc" : "The Observable to capture",
 383           "isOptional" : false
 384         },
 385         {
 386           "name" : "fn",
 387           "type" : "Function",
 388           "desc" : "The function to call",
 389           "isOptional" : false
 390         },
 391         {
 392           "name" : "scope",
 393           "type" : "Object",
 394           "desc" : "(optional) The scope (this object) for the fn",
 395           "isOptional" : false
 396         }
 397       ],
 398       "returns" : []
 399     },
 400     {
 401       "name" : "addListener",
 402       "type" : "function",
 403       "desc" : "Appends an event handler to this component",
 404       "sig" : "(eventName, handler, scope, options)",
 405       "static" : false,
 406       "memberOf" : "Roo.util.Observable",
 407       "isStatic" : false,
 408       "isConstructor" : false,
 409       "isPrivate" : false,
 410       "example" : "",
 411       "deprecated" : "",
 412       "since" : "",
 413       "see" : "",
 414       "exceptions" : "",
 415       "requires" : "",
 416       "params" : [
 417         {
 418           "name" : "eventName",
 419           "type" : "String",
 420           "desc" : "The type of event to listen for",
 421           "isOptional" : false
 422         },
 423         {
 424           "name" : "handler",
 425           "type" : "Function",
 426           "desc" : "The method the event invokes",
 427           "isOptional" : false
 428         },
 429         {
 430           "name" : "scope",
 431           "type" : "Object",
 432           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 433           "isOptional" : false
 434         },
 435         {
 436           "name" : "options",
 437           "type" : "Object",
 438           "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>",
 439           "isOptional" : false
 440         }
 441       ],
 442       "returns" : []
 443     }
 444   ],
 445   "events" : [
 446     {
 447       "name" : "load",
 448       "type" : "function",
 449       "desc" : "Fires before the load method's callback is called.",
 450       "sig" : "function (This, o, arg)\n{\n\n}",
 451       "memberOf" : "Roo.data.DataProxy",
 452       "example" : "",
 453       "deprecated" : "",
 454       "since" : "",
 455       "see" : "",
 456       "params" : [
 457         {
 458           "name" : "This",
 459           "type" : "Object",
 460           "desc" : "DataProxy object.",
 461           "isOptional" : false
 462         },
 463         {
 464           "name" : "o",
 465           "type" : "Object",
 466           "desc" : "The data object.",
 467           "isOptional" : false
 468         },
 469         {
 470           "name" : "arg",
 471           "type" : "Object",
 472           "desc" : "The callback argument object passed to the load function.",
 473           "isOptional" : false
 474         }
 475       ],
 476       "returns" : []
 477     },
 478     {
 479       "name" : "beforeload",
 480       "type" : "function",
 481       "desc" : "Fires before a network request is made to retrieve a data object.",
 482       "sig" : "function (This, params)\n{\n\n}",
 483       "memberOf" : "Roo.data.DataProxy",
 484       "example" : "",
 485       "deprecated" : "",
 486       "since" : "",
 487       "see" : "",
 488       "params" : [
 489         {
 490           "name" : "This",
 491           "type" : "Object",
 492           "desc" : "DataProxy object.",
 493           "isOptional" : false
 494         },
 495         {
 496           "name" : "params",
 497           "type" : "Object",
 498           "desc" : "The params parameter to the load function.",
 499           "isOptional" : false
 500         }
 501       ],
 502       "returns" : []
 503     },
 504     {
 505       "name" : "loadexception",
 506       "type" : "function",
 507       "desc" : "Fires if an Exception occurs during data retrieval.",
 508       "sig" : "function (This, o, arg, e)\n{\n\n}",
 509       "memberOf" : "Roo.data.DataProxy",
 510       "example" : "",
 511       "deprecated" : "",
 512       "since" : "",
 513       "see" : "",
 514       "params" : [
 515         {
 516           "name" : "This",
 517           "type" : "Object",
 518           "desc" : "DataProxy object.",
 519           "isOptional" : false
 520         },
 521         {
 522           "name" : "o",
 523           "type" : "Object",
 524           "desc" : "The data object.",
 525           "isOptional" : false
 526         },
 527         {
 528           "name" : "arg",
 529           "type" : "Object",
 530           "desc" : "The callback argument object passed to the load function.",
 531           "isOptional" : false
 532         },
 533         {
 534           "name" : "e",
 535           "type" : "Object",
 536           "desc" : "The Exception.",
 537           "isOptional" : false
 538         }
 539       ],
 540       "returns" : []
 541     }
 542   ]
 543 }