git.roojs.org Git - roojs1/blob - Roo/JsonView.js

   1 /*
   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  * <script type="text/javascript">
  10  */
  11
  12 /**
  13  * @class Roo.JsonView
  14  * @extends Roo.View
  15  * Shortcut class to create a JSON + {@link Roo.UpdateManager} template view. Usage:
  16 <pre><code>
  17 var view = new Roo.JsonView({
  18     container: "my-element",
  19     template: '&lt;div id="{id}"&gt;{foo} - {bar}&lt;/div&gt;', // auto create template
  20     multiSelect: true,
  21     jsonRoot: "data"
  22 });
  23
  24 // listen for node click?
  25 view.on("click", function(vw, index, node, e){
  26     alert('Node "' + node.id + '" at index: ' + index + " was clicked.");
  27 });
  28
  29 // direct load of JSON data
  30 view.load("foobar.php");
  31
  32 // Example from my blog list
  33 var tpl = new Roo.Template(
  34     '&lt;div class="entry"&gt;' +
  35     '&lt;a class="entry-title" href="{link}"&gt;{title}&lt;/a&gt;' +
  36     "&lt;h4&gt;{date} by {author} | {comments} Comments&lt;/h4&gt;{description}" +
  37     "&lt;/div&gt;&lt;hr /&gt;"
  38 );
  39
  40 var moreView = new Roo.JsonView({
  41     container :  "entry-list",
  42     template : tpl,
  43     jsonRoot: "posts"
  44 });
  45 moreView.on("beforerender", this.sortEntries, this);
  46 moreView.load({
  47     url: "/blog/get-posts.php",
  48     params: "allposts=true",
  49     text: "Loading Blog Entries..."
  50 });
  51 </code></pre>
  52 *
  53 * Note: old code is supported with arguments : (container, template, config)
  54 *
  55 *
  56  * @constructor
  57  * Create a new JsonView
  58  *
  59  * @param {Object} config The config object
  60  *
  61  */
  62 Roo.JsonView = function(config, depreciated_tpl, depreciated_config){
  63
  64
  65     Roo.JsonView.superclass.constructor.call(this, config, depreciated_tpl, depreciated_config);
  66
  67     var um = this.el.getUpdateManager();
  68     um.setRenderer(this);
  69     um.on("update", this.onLoad, this);
  70     um.on("failure", this.onLoadException, this);
  71
  72     /**
  73      * @event beforerender
  74      * Fires before rendering of the downloaded JSON data.
  75      * @param {Roo.JsonView} this
  76      * @param {Object} data The JSON data loaded
  77      */
  78     /**
  79      * @event load
  80      * Fires when data is loaded.
  81      * @param {Roo.JsonView} this
  82      * @param {Object} data The JSON data loaded
  83      * @param {Object} response The raw Connect response object
  84      */
  85     /**
  86      * @event loadexception
  87      * Fires when loading fails.
  88      * @param {Roo.JsonView} this
  89      * @param {Object} response The raw Connect response object
  90      */
  91     this.addEvents({
  92         'beforerender' : true,
  93         'load' : true,
  94         'loadexception' : true
  95     });
  96 };
  97 Roo.extend(Roo.JsonView, Roo.View, {
  98     /**
  99      * The root property in the loaded JSON object that contains the data
 100      * @type {String}
 101      */
 102     jsonRoot : "",
 103
 104     /**
 105      * Refreshes the view.
 106      */
 107     refresh : function(){
 108         this.clearSelections();
 109         this.el.update("");
 110         var html = [];
 111         var o = this.jsonData;
 112         if(o && o.length > 0){
 113             for(var i = 0, len = o.length; i < len; i++){
 114                 var data = this.prepareData(o[i], i, o);
 115                 html[html.length] = this.tpl.apply(data);
 116             }
 117         }else{
 118             html.push(this.emptyText);
 119         }
 120         this.el.update(html.join(""));
 121         this.nodes = this.el.dom.childNodes;
 122         this.updateIndexes(0);
 123     },
 124
 125     /**
 126      * Performs an async HTTP request, and loads the JSON from the response. If <i>params</i> are specified it uses POST, otherwise it uses GET.
 127      * @param {Object/String/Function} url The URL for this request, or a function to call to get the URL, or a config object containing any of the following options:
 128      <pre><code>
 129      view.load({
 130          url: "your-url.php",
 131          params: {param1: "foo", param2: "bar"}, // or a URL encoded string
 132          callback: yourFunction,
 133          scope: yourObject, //(optional scope)
 134          discardUrl: false,
 135          nocache: false,
 136          text: "Loading...",
 137          timeout: 30,
 138          scripts: false
 139      });
 140      </code></pre>
 141      * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>
 142      * are respectively shorthand for <i>disableCaching</i>, <i>indicatorText</i>, and <i>loadScripts</i> and are used to set their associated property on this UpdateManager instance.
 143      * @param {String/Object} params (optional) The parameters to pass, as either a URL encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2}
 144      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
 145      * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.
 146      */
 147     load : function(){
 148         var um = this.el.getUpdateManager();
 149         um.update.apply(um, arguments);
 150     },
 151
 152     render : function(el, response){
 153         this.clearSelections();
 154         this.el.update("");
 155         var o;
 156         try{
 157             o = Roo.util.JSON.decode(response.responseText);
 158             if(this.jsonRoot){
 159
 160                 o = /** eval:var:o */ eval("o." + this.jsonRoot);
 161             }
 162         } catch(e){
 163         }
 164         /**
 165          * The current JSON data or null
 166          */
 167         this.jsonData = o;
 168         this.beforeRender();
 169         this.refresh();
 170     },
 171
 172 /**
 173  * Get the number of records in the current JSON dataset
 174  * @return {Number}
 175  */
 176     getCount : function(){
 177         return this.jsonData ? this.jsonData.length : 0;
 178     },
 179
 180 /**
 181  * Returns the JSON object for the specified node(s)
 182  * @param {HTMLElement/Array} node The node or an array of nodes
 183  * @return {Object/Array} If you pass in an array, you get an array back, otherwise
 184  * you get the JSON object for the node
 185  */
 186     getNodeData : function(node){
 187         if(node instanceof Array){
 188             var data = [];
 189             for(var i = 0, len = node.length; i < len; i++){
 190                 data.push(this.getNodeData(node[i]));
 191             }
 192             return data;
 193         }
 194         return this.jsonData[this.indexOf(node)] || null;
 195     },
 196
 197     beforeRender : function(){
 198         this.snapshot = this.jsonData;
 199         if(this.sortInfo){
 200             this.sort.apply(this, this.sortInfo);
 201         }
 202         this.fireEvent("beforerender", this, this.jsonData);
 203     },
 204
 205     onLoad : function(el, o){
 206         this.fireEvent("load", this, this.jsonData, o);
 207     },
 208
 209     onLoadException : function(el, o){
 210         this.fireEvent("loadexception", this, o);
 211     },
 212
 213 /**
 214  * Filter the data by a specific property.
 215  * @param {String} property A property on your JSON objects
 216  * @param {String/RegExp} value Either string that the property values
 217  * should start with, or a RegExp to test against the property
 218  */
 219     filter : function(property, value){
 220         if(this.jsonData){
 221             var data = [];
 222             var ss = this.snapshot;
 223             if(typeof value == "string"){
 224                 var vlen = value.length;
 225                 if(vlen == 0){
 226                     this.clearFilter();
 227                     return;
 228                 }
 229                 value = value.toLowerCase();
 230                 for(var i = 0, len = ss.length; i < len; i++){
 231                     var o = ss[i];
 232                     if(o[property].substr(0, vlen).toLowerCase() == value){
 233                         data.push(o);
 234                     }
 235                 }
 236             } else if(value.exec){ // regex?
 237                 for(var i = 0, len = ss.length; i < len; i++){
 238                     var o = ss[i];
 239                     if(value.test(o[property])){
 240                         data.push(o);
 241                     }
 242                 }
 243             } else{
 244                 return;
 245             }
 246             this.jsonData = data;
 247             this.refresh();
 248         }
 249     },
 250
 251 /**
 252  * Filter by a function. The passed function will be called with each
 253  * object in the current dataset. If the function returns true the value is kept,
 254  * otherwise it is filtered.
 255  * @param {Function} fn
 256  * @param {Object} scope (optional) The scope of the function (defaults to this JsonView)
 257  */
 258     filterBy : function(fn, scope){
 259         if(this.jsonData){
 260             var data = [];
 261             var ss = this.snapshot;
 262             for(var i = 0, len = ss.length; i < len; i++){
 263                 var o = ss[i];
 264                 if(fn.call(scope || this, o)){
 265                     data.push(o);
 266                 }
 267             }
 268             this.jsonData = data;
 269             this.refresh();
 270         }
 271     },
 272
 273 /**
 274  * Clears the current filter.
 275  */
 276     clearFilter : function(){
 277         if(this.snapshot && this.jsonData != this.snapshot){
 278             this.jsonData = this.snapshot;
 279             this.refresh();
 280         }
 281     },
 282
 283
 284 /**
 285  * Sorts the data for this view and refreshes it.
 286  * @param {String} property A property on your JSON objects to sort on
 287  * @param {String} direction (optional) "desc" or "asc" (defaults to "asc")
 288  * @param {Function} sortType (optional) A function to call to convert the data to a sortable value.
 289  */
 290     sort : function(property, dir, sortType){
 291         this.sortInfo = Array.prototype.slice.call(arguments, 0);
 292         if(this.jsonData){
 293             var p = property;
 294             var dsc = dir && dir.toLowerCase() == "desc";
 295             var f = function(o1, o2){
 296                 var v1 = sortType ? sortType(o1[p]) : o1[p];
 297                 var v2 = sortType ? sortType(o2[p]) : o2[p];
 298                 ;
 299                 if(v1 < v2){
 300                     return dsc ? +1 : -1;
 301                 } else if(v1 > v2){
 302                     return dsc ? -1 : +1;
 303                 } else{
 304                     return 0;
 305                 }
 306             };
 307             this.jsonData.sort(f);
 308             this.refresh();
 309             if(this.jsonData != this.snapshot){
 310                 this.snapshot.sort(f);
 311             }
 312         }
 313     }
 314 });