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

   1 <html><head><title>/home/edward/gitlive/roojs1/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.data.Observable
  15  * This class is an abstract base class for implementations which provide retrieval of
  16  * unformatted data objects.&lt;br&gt;
  17  * &lt;p&gt;
  18  * DataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader
  19  * (of the appropriate type which knows how to parse the data object) to provide a block of
  20  * {@link Roo.data.Records} to an {@link Roo.data.Store}.&lt;br&gt;
  21  * &lt;p&gt;
  22  * Custom implementations must implement the load method as described in
  23  * {@link Roo.data.HttpProxy#load}.
  24  */
  25 </span><span class="jsdoc-var">Roo.data.DataProxy </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  26     </span><span class="jsdoc-var">this.addEvents</span><span class="jsdoc-syntax">({
  27         </span><span class="jsdoc-comment">/**
  28          * @event beforeload
  29          * Fires before a network request is made to retrieve a data object.
  30          * @param {Object} This DataProxy object.
  31          * @param {Object} params The params parameter to the load function.
  32          */
  33         </span><span class="jsdoc-var">beforeload </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
  34         </span><span class="jsdoc-comment">/**
  35          * @event load
  36          * Fires before the load method's callback is called.
  37          * @param {Object} This DataProxy object.
  38          * @param {Object} o The data object.
  39          * @param {Object} arg The callback argument object passed to the load function.
  40          */
  41         </span><span class="jsdoc-var">load </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">,
  42         </span><span class="jsdoc-comment">/**
  43          * @event loadexception
  44          * Fires if an Exception occurs during data retrieval.
  45          * @param {Object} This DataProxy object.
  46          * @param {Object} o The data object.
  47          * @param {Object} arg The callback argument object passed to the load function.
  48          * @param {Object} e The Exception.
  49          */
  50         </span><span class="jsdoc-var">loadexception </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">true
  51     </span><span class="jsdoc-syntax">});
  52     </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">);
  53 };
  54
  55 </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">);
  56
  57     </span><span class="jsdoc-comment">/**
  58      * @cfg {void} listeners (Not available) Constructor blocks listeners from being set
  59      */
  60 </span></code></body></html>