Roo/JsonView.js
[roojs1] / 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     tpl: '&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      * @type {String} The root property in the loaded JSON object that contains the data
100      */
101     jsonRoot : "",
102
103     /**
104      * Refreshes the view.
105      */
106     refresh : function(){
107         this.clearSelections();
108         this.el.update("");
109         var html = [];
110         var o = this.jsonData;
111         if(o && o.length > 0){
112             for(var i = 0, len = o.length; i < len; i++){
113                 var data = this.prepareData(o[i], i, o);
114                 html[html.length] = this.tpl.apply(data);
115             }
116         }else{
117             html.push(this.emptyText);
118         }
119         this.el.update(html.join(""));
120         this.nodes = this.el.dom.childNodes;
121         this.updateIndexes(0);
122     },
123
124     /**
125      * 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.
126      * @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:
127      <pre><code>
128      view.load({
129          url: "your-url.php",
130          params: {param1: "foo", param2: "bar"}, // or a URL encoded string
131          callback: yourFunction,
132          scope: yourObject, //(optional scope)
133          discardUrl: false,
134          nocache: false,
135          text: "Loading...",
136          timeout: 30,
137          scripts: false
138      });
139      </code></pre>
140      * The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>
141      * 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.
142      * @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}
143      * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
144      * @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.
145      */
146     load : function(){
147         var um = this.el.getUpdateManager();
148         um.update.apply(um, arguments);
149     },
150
151     // note - render is a standard framework call...
152     // using it for the response is really flaky...
153     render : function(el, response){
154         this.clearSelections();
155         this.el.update("");
156         var o;
157         try{
158             o = Roo.util.JSON.decode(response.responseText);
159             if(this.jsonRoot){
160                 
161                 o = o[this.jsonRoot];
162             }
163         } catch(e){
164         }
165         /**
166          * The current JSON data or null
167          */
168         this.jsonData = o;
169         this.beforeRender();
170         this.refresh();
171     },
172
173 /**
174  * Get the number of records in the current JSON dataset
175  * @return {Number}
176  */
177     getCount : function(){
178         return this.jsonData ? this.jsonData.length : 0;
179     },
180
181 /**
182  * Returns the JSON object for the specified node(s)
183  * @param {HTMLElement/Array} node The node or an array of nodes
184  * @return {Object/Array} If you pass in an array, you get an array back, otherwise
185  * you get the JSON object for the node
186  */
187     getNodeData : function(node){
188         if(node instanceof Array){
189             var data = [];
190             for(var i = 0, len = node.length; i < len; i++){
191                 data.push(this.getNodeData(node[i]));
192             }
193             return data;
194         }
195         return this.jsonData[this.indexOf(node)] || null;
196     },
197
198     beforeRender : function(){
199         this.snapshot = this.jsonData;
200         if(this.sortInfo){
201             this.sort.apply(this, this.sortInfo);
202         }
203         this.fireEvent("beforerender", this, this.jsonData);
204     },
205
206     onLoad : function(el, o){
207         this.fireEvent("load", this, this.jsonData, o);
208     },
209
210     onLoadException : function(el, o){
211         this.fireEvent("loadexception", this, o);
212     },
213
214 /**
215  * Filter the data by a specific property.
216  * @param {String} property A property on your JSON objects
217  * @param {String/RegExp} value Either string that the property values
218  * should start with, or a RegExp to test against the property
219  */
220     filter : function(property, value){
221         if(this.jsonData){
222             var data = [];
223             var ss = this.snapshot;
224             if(typeof value == "string"){
225                 var vlen = value.length;
226                 if(vlen == 0){
227                     this.clearFilter();
228                     return;
229                 }
230                 value = value.toLowerCase();
231                 for(var i = 0, len = ss.length; i < len; i++){
232                     var o = ss[i];
233                     if(o[property].substr(0, vlen).toLowerCase() == value){
234                         data.push(o);
235                     }
236                 }
237             } else if(value.exec){ // regex?
238                 for(var i = 0, len = ss.length; i < len; i++){
239                     var o = ss[i];
240                     if(value.test(o[property])){
241                         data.push(o);
242                     }
243                 }
244             } else{
245                 return;
246             }
247             this.jsonData = data;
248             this.refresh();
249         }
250     },
251
252 /**
253  * Filter by a function. The passed function will be called with each
254  * object in the current dataset. If the function returns true the value is kept,
255  * otherwise it is filtered.
256  * @param {Function} fn
257  * @param {Object} scope (optional) The scope of the function (defaults to this JsonView)
258  */
259     filterBy : function(fn, scope){
260         if(this.jsonData){
261             var data = [];
262             var ss = this.snapshot;
263             for(var i = 0, len = ss.length; i < len; i++){
264                 var o = ss[i];
265                 if(fn.call(scope || this, o)){
266                     data.push(o);
267                 }
268             }
269             this.jsonData = data;
270             this.refresh();
271         }
272     },
273
274 /**
275  * Clears the current filter.
276  */
277     clearFilter : function(){
278         if(this.snapshot && this.jsonData != this.snapshot){
279             this.jsonData = this.snapshot;
280             this.refresh();
281         }
282     },
283
284
285 /**
286  * Sorts the data for this view and refreshes it.
287  * @param {String} property A property on your JSON objects to sort on
288  * @param {String} direction (optional) "desc" or "asc" (defaults to "asc")
289  * @param {Function} sortType (optional) A function to call to convert the data to a sortable value.
290  */
291     sort : function(property, dir, sortType){
292         this.sortInfo = Array.prototype.slice.call(arguments, 0);
293         if(this.jsonData){
294             var p = property;
295             var dsc = dir && dir.toLowerCase() == "desc";
296             var f = function(o1, o2){
297                 var v1 = sortType ? sortType(o1[p]) : o1[p];
298                 var v2 = sortType ? sortType(o2[p]) : o2[p];
299                 ;
300                 if(v1 < v2){
301                     return dsc ? +1 : -1;
302                 } else if(v1 > v2){
303                     return dsc ? -1 : +1;
304                 } else{
305                     return 0;
306                 }
307             };
308             this.jsonData.sort(f);
309             this.refresh();
310             if(this.jsonData != this.snapshot){
311                 this.snapshot.sort(f);
312             }
313         }
314     }
315 });