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

   1 {
   2   "name" : "Roo.data.DataProxy",
   3   "augments" : [],
   4   "childClasses" : [
   5     "Roo.data.HttpProxy"
   6   ],
   7   "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}.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "DataProxy",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [],
  17   "returns" : [],
  18   "throws" : "",
  19   "requires" : "",
  20   "config" : [],
  21   "methods" : [],
  22   "events" : [
  23     {
  24       "name" : "load",
  25       "type" : "function",
  26       "desc" : "Fires before the load method's callback is called.",
  27       "sig" : "function (This, o, arg)\n{\n\n}",
  28       "memberOf" : "",
  29       "example" : "",
  30       "deprecated" : "",
  31       "since" : "",
  32       "see" : "",
  33       "params" : [
  34         {
  35           "name" : "This",
  36           "type" : "Object",
  37           "desc" : "DataProxy object.",
  38           "isOptional" : false
  39         },
  40         {
  41           "name" : "o",
  42           "type" : "Object",
  43           "desc" : "The data object.",
  44           "isOptional" : false
  45         },
  46         {
  47           "name" : "arg",
  48           "type" : "Object",
  49           "desc" : "The callback argument object passed to the load function.",
  50           "isOptional" : false
  51         }
  52       ],
  53       "returns" : []
  54     },
  55     {
  56       "name" : "beforeload",
  57       "type" : "function",
  58       "desc" : "Fires before a network request is made to retrieve a data object.",
  59       "sig" : "function (This, params)\n{\n\n}",
  60       "memberOf" : "",
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "params" : [
  66         {
  67           "name" : "This",
  68           "type" : "Object",
  69           "desc" : "DataProxy object.",
  70           "isOptional" : false
  71         },
  72         {
  73           "name" : "params",
  74           "type" : "Object",
  75           "desc" : "The params parameter to the load function.",
  76           "isOptional" : false
  77         }
  78       ],
  79       "returns" : []
  80     },
  81     {
  82       "name" : "loadexception",
  83       "type" : "function",
  84       "desc" : "Fires if an Exception occurs during data retrieval.",
  85       "sig" : "function (This, o, arg, e)\n{\n\n}",
  86       "memberOf" : "",
  87       "example" : "",
  88       "deprecated" : "",
  89       "since" : "",
  90       "see" : "",
  91       "params" : [
  92         {
  93           "name" : "This",
  94           "type" : "Object",
  95           "desc" : "DataProxy object.",
  96           "isOptional" : false
  97         },
  98         {
  99           "name" : "o",
 100           "type" : "Object",
 101           "desc" : "The data object.",
 102           "isOptional" : false
 103         },
 104         {
 105           "name" : "arg",
 106           "type" : "Object",
 107           "desc" : "The callback argument object passed to the load function.",
 108           "isOptional" : false
 109         },
 110         {
 111           "name" : "e",
 112           "type" : "Object",
 113           "desc" : "The Exception.",
 114           "isOptional" : false
 115         }
 116       ],
 117       "returns" : []
 118     }
 119   ]
 120 }