git.roojs.org Git - roojs1/blob - docs/src/Roo_data_DataProxy.js.html

   1 <html><head><title>Roo/data/DataProxy.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * &lt;script type=&quot;text/javascript&quot;&gt;
  10  */
  11
  12 /**
  13  * @class Roo.data.DataProxy
  14  * @extends Roo.util.Observable
  15  * @abstract
  16  * This class is an abstract base class for implementations which provide retrieval of
  17  * unformatted data objects.&lt;br&gt;
  18  * &lt;p&gt;
  19  * DataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader
  20  * (of the appropriate type which knows how to parse the data object) to provide a block of
  21  * {@link Roo.data.Records} to an {@link Roo.data.Store}.&lt;br&gt;
  22  * &lt;p&gt;
  23  * Custom implementations must implement the load method as described in
  24  * {@link Roo.data.HttpProxy#load}.
  25  */
  26 </span><span class="jsdoc-var">Roo.data.DataProxy </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  27     </span><span class="jsdoc-var">this.addEvents</span><span class="jsdoc-syntax">({
  28         </span><span class="jsdoc-comment">/**
  29          * @event beforeload
  30          * Fires before a network request is made to retrieve a data object.
  31          * @param {Object} This DataProxy object.
  32          * @param {Object} params The params parameter to the load function.
  33          */
  34         </span><span class="jsdoc-var">beforeload </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
  35         </span><span class="jsdoc-comment">/**
  36          * @event load
  37          * Fires before the load method's callback is called.
  38          * @param {Object} This DataProxy object.
  39          * @param {Object} o The data object.
  40          * @param {Object} arg The callback argument object passed to the load function.
  41          */
  42         </span><span class="jsdoc-var">load </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
  43         </span><span class="jsdoc-comment">/**
  44          * @event loadexception
  45          * Fires if an Exception occurs during data retrieval.
  46          * @param {Object} This DataProxy object.
  47          * @param {Object} o The data object.
  48          * @param {Object} arg The callback argument object passed to the load function.
  49          * @param {Object} e The Exception.
  50          */
  51         </span><span class="jsdoc-var">loadexception </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true
  52     </span><span class="jsdoc-syntax">});
  53     </span><span class="jsdoc-var">Roo.data.DataProxy.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">);
  54 };
  55
  56 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.data.DataProxy</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.util.Observable</span><span class="jsdoc-syntax">);
  57
  58     </span><span class="jsdoc-comment">/**
  59      * @cfg {void} listeners (Not available) Constructor blocks listeners from being set
  60      */
  61 </span></code></body></html>