git.roojs.org Git - roojs1/blob - Roo/View.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.View
  14  * @extends Roo.util.Observable
  15  * Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template.
  16  * This class also supports single and multi selection modes. <br>
  17  * Create a data model bound view:
  18  <pre><code>
  19  var store = new Roo.data.Store(...);
  20
  21  var view = new Roo.View({
  22     el : "my-element",
  23     tpl : '&lt;div id="{0}"&gt;{2} - {1}&lt;/div&gt;', // auto create template
  24
  25     singleSelect: true,
  26     selectedClass: "ydataview-selected",
  27     store: store
  28  });
  29
  30  // listen for node click?
  31  view.on("click", function(vw, index, node, e){
  32  alert('Node "' + node.id + '" at index: ' + index + " was clicked.");
  33  });
  34
  35  // load XML data
  36  dataModel.load("foobar.xml");
  37  </code></pre>
  38  For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}.
  39  * <br><br>
  40  * <b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to
  41  * IE"s limited insertion support with tables and Opera"s faulty event bubbling.</b>
  42  *
  43  * Note: old style constructor is still suported (container, template, config)
  44  *
  45  * @constructor
  46  * Create a new View
  47  * @param {Object} config The config object
  48  *
  49  */
  50 Roo.View = function(config, depreciated_tpl, depreciated_config){
  51
  52     if (typeof(depreciated_tpl) == 'undefined') {
  53         // new way.. - universal constructor.
  54         Roo.apply(this, config);
  55         this.el  = Roo.get(this.el);
  56     } else {
  57         // old format..
  58         this.el  = Roo.get(config);
  59         this.tpl = depreciated_tpl;
  60         Roo.apply(this, depreciated_config);
  61     }
  62
  63
  64     if(typeof(this.tpl) == "string"){
  65         this.tpl = new Roo.Template(this.tpl);
  66     } else {
  67         // support xtype ctors..
  68         this.tpl = new Roo.factory(this.tpl, Roo);
  69     }
  70
  71
  72     this.tpl.compile();
  73
  74
  75
  76     /** @private */
  77     this.addEvents({
  78         /**
  79          * @event beforeclick
  80          * Fires before a click is processed. Returns false to cancel the default action.
  81          * @param {Roo.View} this
  82          * @param {Number} index The index of the target node
  83          * @param {HTMLElement} node The target node
  84          * @param {Roo.EventObject} e The raw event object
  85          */
  86             "beforeclick" : true,
  87         /**
  88          * @event click
  89          * Fires when a template node is clicked.
  90          * @param {Roo.View} this
  91          * @param {Number} index The index of the target node
  92          * @param {HTMLElement} node The target node
  93          * @param {Roo.EventObject} e The raw event object
  94          */
  95             "click" : true,
  96         /**
  97          * @event dblclick
  98          * Fires when a template node is double clicked.
  99          * @param {Roo.View} this
 100          * @param {Number} index The index of the target node
 101          * @param {HTMLElement} node The target node
 102          * @param {Roo.EventObject} e The raw event object
 103          */
 104             "dblclick" : true,
 105         /**
 106          * @event contextmenu
 107          * Fires when a template node is right clicked.
 108          * @param {Roo.View} this
 109          * @param {Number} index The index of the target node
 110          * @param {HTMLElement} node The target node
 111          * @param {Roo.EventObject} e The raw event object
 112          */
 113             "contextmenu" : true,
 114         /**
 115          * @event selectionchange
 116          * Fires when the selected nodes change.
 117          * @param {Roo.View} this
 118          * @param {Array} selections Array of the selected nodes
 119          */
 120             "selectionchange" : true,
 121
 122         /**
 123          * @event beforeselect
 124          * Fires before a selection is made. If any handlers return false, the selection is cancelled.
 125          * @param {Roo.View} this
 126          * @param {HTMLElement} node The node to be selected
 127          * @param {Array} selections Array of currently selected nodes
 128          */
 129             "beforeselect" : true,
 130         /**
 131          * @event preparedata
 132          * Fires on every row to render, to allow you to change the data.
 133          * @param {Roo.View} this
 134          * @param {Object} data to be rendered (change this)
 135          */
 136           "preparedata" : true
 137         });
 138
 139     this.el.on({
 140         "click": this.onClick,
 141         "dblclick": this.onDblClick,
 142         "contextmenu": this.onContextMenu,
 143         scope:this
 144     });
 145
 146     this.selections = [];
 147     this.nodes = [];
 148     this.cmp = new Roo.CompositeElementLite([]);
 149     if(this.store){
 150         this.store = Roo.factory(this.store, Roo.data);
 151         this.setStore(this.store, true);
 152     }
 153     Roo.View.superclass.constructor.call(this);
 154 };
 155
 156 Roo.extend(Roo.View, Roo.util.Observable, {
 157
 158      /**
 159      * @cfg {Roo.data.Store} store Data store to load data from.
 160      */
 161     store : false,
 162
 163     /**
 164      * @cfg {String|Roo.Element} el The container element.
 165      */
 166     el : '',
 167
 168     /**
 169      * @cfg {String|Roo.Template} tpl The template used by this View
 170      */
 171     tpl : false,
 172
 173     /**
 174      * @cfg {String} selectedClass The css class to add to selected nodes
 175      */
 176     selectedClass : "x-view-selected",
 177      /**
 178      * @cfg {String} emptyText The empty text to show when nothing is loaded.
 179      */
 180     emptyText : "",
 181     /**
 182      * @cfg {Boolean} multiSelect Allow multiple selection
 183      */
 184     multiSelect : false,
 185     /**
 186      * @cfg {Boolean} singleSelect Allow single selection
 187      */
 188     singleSelect:  false,
 189
 190     /**
 191      * @cfg {Boolean} toggleSelect - selecting
 192      */
 193     toggleSelect : false,
 194
 195     /**
 196      * Returns the element this view is bound to.
 197      * @return {Roo.Element}
 198      */
 199     getEl : function(){
 200         return this.el;
 201     },
 202
 203     /**
 204      * Refreshes the view.
 205      */
 206     refresh : function(){
 207         var t = this.tpl;
 208         this.clearSelections();
 209         this.el.update("");
 210         var html = [];
 211         var records = this.store.getRange();
 212         if(records.length < 1){
 213             this.el.update(this.emptyText);
 214             return;
 215         }
 216         for(var i = 0, len = records.length; i < len; i++){
 217             var data = this.prepareData(records[i].data, i, records[i]);
 218             this.fireEvent("preparedata", this, data, i, records[i]);
 219             html[html.length] = t.apply(data);
 220         }
 221         this.el.update(html.join(""));
 222         this.nodes = this.el.dom.childNodes;
 223         this.updateIndexes(0);
 224     },
 225
 226     /**
 227      * Function to override to reformat the data that is sent to
 228      * the template for each node.
 229      * @param {Array/Object} data The raw data (array of colData for a data model bound view or
 230      * a JSON object for an UpdateManager bound view).
 231      */
 232     prepareData : function(data){
 233         return data;
 234     },
 235
 236     onUpdate : function(ds, record){
 237         this.clearSelections();
 238         var index = this.store.indexOf(record);
 239         var n = this.nodes[index];
 240         this.tpl.insertBefore(n, this.prepareData(record.data));
 241         n.parentNode.removeChild(n);
 242         this.updateIndexes(index, index);
 243     },
 244
 245     onAdd : function(ds, records, index){
 246         this.clearSelections();
 247         if(this.nodes.length == 0){
 248             this.refresh();
 249             return;
 250         }
 251         var n = this.nodes[index];
 252         for(var i = 0, len = records.length; i < len; i++){
 253             var d = this.prepareData(records[i].data);
 254             if(n){
 255                 this.tpl.insertBefore(n, d);
 256             }else{
 257                 this.tpl.append(this.el, d);
 258             }
 259         }
 260         this.updateIndexes(index);
 261     },
 262
 263     onRemove : function(ds, record, index){
 264         this.clearSelections();
 265         this.el.dom.removeChild(this.nodes[index]);
 266         this.updateIndexes(index);
 267     },
 268
 269     /**
 270      * Refresh an individual node.
 271      * @param {Number} index
 272      */
 273     refreshNode : function(index){
 274         this.onUpdate(this.store, this.store.getAt(index));
 275     },
 276
 277     updateIndexes : function(startIndex, endIndex){
 278         var ns = this.nodes;
 279         startIndex = startIndex || 0;
 280         endIndex = endIndex || ns.length - 1;
 281         for(var i = startIndex; i <= endIndex; i++){
 282             ns[i].nodeIndex = i;
 283         }
 284     },
 285
 286     /**
 287      * Changes the data store this view uses and refresh the view.
 288      * @param {Store} store
 289      */
 290     setStore : function(store, initial){
 291         if(!initial && this.store){
 292             this.store.un("datachanged", this.refresh);
 293             this.store.un("add", this.onAdd);
 294             this.store.un("remove", this.onRemove);
 295             this.store.un("update", this.onUpdate);
 296             this.store.un("clear", this.refresh);
 297         }
 298         if(store){
 299
 300             store.on("datachanged", this.refresh, this);
 301             store.on("add", this.onAdd, this);
 302             store.on("remove", this.onRemove, this);
 303             store.on("update", this.onUpdate, this);
 304             store.on("clear", this.refresh, this);
 305         }
 306
 307         if(store){
 308             this.refresh();
 309         }
 310     },
 311
 312     /**
 313      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 314      * @param {HTMLElement} node
 315      * @return {HTMLElement} The template node
 316      */
 317     findItemFromChild : function(node){
 318         var el = this.el.dom;
 319         if(!node || node.parentNode == el){
 320                     return node;
 321             }
 322             var p = node.parentNode;
 323             while(p && p != el){
 324             if(p.parentNode == el){
 325                 return p;
 326             }
 327             p = p.parentNode;
 328         }
 329             return null;
 330     },
 331
 332     /** @ignore */
 333     onClick : function(e){
 334         var item = this.findItemFromChild(e.getTarget());
 335         if(item){
 336             var index = this.indexOf(item);
 337             if(this.onItemClick(item, index, e) !== false){
 338                 this.fireEvent("click", this, index, item, e);
 339             }
 340         }else{
 341             this.clearSelections();
 342         }
 343     },
 344
 345     /** @ignore */
 346     onContextMenu : function(e){
 347         var item = this.findItemFromChild(e.getTarget());
 348         if(item){
 349             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 350         }
 351     },
 352
 353     /** @ignore */
 354     onDblClick : function(e){
 355         var item = this.findItemFromChild(e.getTarget());
 356         if(item){
 357             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 358         }
 359     },
 360
 361     onItemClick : function(item, index, e)
 362     {
 363         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 364             return false;
 365         }
 366         if (this.toggleSelect) {
 367             var m = this.isSelected(item) ? 'unselect' : 'select';
 368             var _t = this;
 369             _t[m](item, true);
 370
 371         }
 372         if(this.multiSelect || this.singleSelect){
 373             if(this.multiSelect && e.shiftKey && this.lastSelection){
 374                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 375             }else{
 376                 this.select(item, this.multiSelect && e.ctrlKey);
 377                 this.lastSelection = item;
 378             }
 379             e.preventDefault();
 380         }
 381         return true;
 382     },
 383
 384     /**
 385      * Get the number of selected nodes.
 386      * @return {Number}
 387      */
 388     getSelectionCount : function(){
 389         return this.selections.length;
 390     },
 391
 392     /**
 393      * Get the currently selected nodes.
 394      * @return {Array} An array of HTMLElements
 395      */
 396     getSelectedNodes : function(){
 397         return this.selections;
 398     },
 399
 400     /**
 401      * Get the indexes of the selected nodes.
 402      * @return {Array}
 403      */
 404     getSelectedIndexes : function(){
 405         var indexes = [], s = this.selections;
 406         for(var i = 0, len = s.length; i < len; i++){
 407             indexes.push(s[i].nodeIndex);
 408         }
 409         return indexes;
 410     },
 411
 412     /**
 413      * Clear all selections
 414      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 415      */
 416     clearSelections : function(suppressEvent){
 417         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 418             this.cmp.elements = this.selections;
 419             this.cmp.removeClass(this.selectedClass);
 420             this.selections = [];
 421             if(!suppressEvent){
 422                 this.fireEvent("selectionchange", this, this.selections);
 423             }
 424         }
 425     },
 426
 427     /**
 428      * Returns true if the passed node is selected
 429      * @param {HTMLElement/Number} node The node or node index
 430      * @return {Boolean}
 431      */
 432     isSelected : function(node){
 433         var s = this.selections;
 434         if(s.length < 1){
 435             return false;
 436         }
 437         node = this.getNode(node);
 438         return s.indexOf(node) !== -1;
 439     },
 440
 441     /**
 442      * Selects nodes.
 443      * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select
 444      * @param {Boolean} keepExisting (optional) true to keep existing selections
 445      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 446      */
 447     select : function(nodeInfo, keepExisting, suppressEvent){
 448         if(nodeInfo instanceof Array){
 449             if(!keepExisting){
 450                 this.clearSelections(true);
 451             }
 452             for(var i = 0, len = nodeInfo.length; i < len; i++){
 453                 this.select(nodeInfo[i], true, true);
 454             }
 455             return;
 456         }
 457         var node = this.getNode(nodeInfo);
 458         if(!node || this.isSelected(node)){
 459             return; // already selected.
 460         }
 461         if(!keepExisting){
 462             this.clearSelections(true);
 463         }
 464         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 465             Roo.fly(node).addClass(this.selectedClass);
 466             this.selections.push(node);
 467             if(!suppressEvent){
 468                 this.fireEvent("selectionchange", this, this.selections);
 469             }
 470         }
 471
 472
 473     },
 474       /**
 475      * Unselects nodes.
 476      * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select
 477      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 478      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 479      */
 480     unselect : function(nodeInfo, keepExisting, suppressEvent)
 481     {
 482         if(nodeInfo instanceof Array){
 483             Roo.each(this.selections, function(s) {
 484                 this.unselect(s, nodeInfo);
 485             }, this);
 486             return;
 487         }
 488         var node = this.getNode(nodeInfo);
 489         if(!node || !this.isSelected(node)){
 490             return; // not selected.
 491         }
 492         // fireevent???
 493         var ns = [];
 494         Roo.each(this.selections, function(s) {
 495             if (s === node ) {
 496                 return;
 497             }
 498             ns.push(s);
 499         });
 500
 501         this.selections= ns;
 502         this.fireEvent("selectionchange", this, this.selections);
 503     },
 504
 505     /**
 506      * Gets a template node.
 507      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 508      * @return {HTMLElement} The node or null if it wasn't found
 509      */
 510     getNode : function(nodeInfo){
 511         if(typeof nodeInfo == "string"){
 512             return document.getElementById(nodeInfo);
 513         }else if(typeof nodeInfo == "number"){
 514             return this.nodes[nodeInfo];
 515         }
 516         return nodeInfo;
 517     },
 518
 519     /**
 520      * Gets a range template nodes.
 521      * @param {Number} startIndex
 522      * @param {Number} endIndex
 523      * @return {Array} An array of nodes
 524      */
 525     getNodes : function(start, end){
 526         var ns = this.nodes;
 527         start = start || 0;
 528         end = typeof end == "undefined" ? ns.length - 1 : end;
 529         var nodes = [];
 530         if(start <= end){
 531             for(var i = start; i <= end; i++){
 532                 nodes.push(ns[i]);
 533             }
 534         } else{
 535             for(var i = start; i >= end; i--){
 536                 nodes.push(ns[i]);
 537             }
 538         }
 539         return nodes;
 540     },
 541
 542     /**
 543      * Finds the index of the passed node
 544      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 545      * @return {Number} The index of the node or -1
 546      */
 547     indexOf : function(node){
 548         node = this.getNode(node);
 549         if(typeof node.nodeIndex == "number"){
 550             return node.nodeIndex;
 551         }
 552         var ns = this.nodes;
 553         for(var i = 0, len = ns.length; i < len; i++){
 554             if(ns[i] == node){
 555                 return i;
 556             }
 557         }
 558         return -1;
 559     }
 560 });