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      * @cfg {String} dataName the named area of the template to use as the data area
 174      *                          Works with domtemplates roo-name="name"
 175      */
 176     dataName: false,
 177     /**
 178      * @cfg {String} selectedClass The css class to add to selected nodes
 179      */
 180     selectedClass : "x-view-selected",
 181      /**
 182      * @cfg {String} emptyText The empty text to show when nothing is loaded.
 183      */
 184     emptyText : "",
 185     /**
 186      * @cfg {Boolean} multiSelect Allow multiple selection
 187      */
 188     multiSelect : false,
 189     /**
 190      * @cfg {Boolean} singleSelect Allow single selection
 191      */
 192     singleSelect:  false,
 193
 194     /**
 195      * @cfg {Boolean} toggleSelect - selecting
 196      */
 197     toggleSelect : false,
 198
 199     /**
 200      * Returns the element this view is bound to.
 201      * @return {Roo.Element}
 202      */
 203     getEl : function(){
 204         return this.el;
 205     },
 206
 207     /**
 208      * Refreshes the view.
 209      */
 210     refresh : function(){
 211         var t = this.tpl;
 212
 213         // if we are using something like 'domtemplate', then
 214         // the what gets used is:
 215         // t.applySubtemplate(NAME, data, wrapping data..)
 216         // the outer template then get' applied with
 217         //     the store 'extra data'
 218         // and the body get's added to the
 219         //      roo-name="data" node?
 220         //      <span class='roo-tpl-{name}'></span> ?????
 221
 222
 223
 224         this.clearSelections();
 225         this.el.update("");
 226         var html = [];
 227         var records = this.store.getRange();
 228         if(records.length < 1){
 229             this.el.update(this.emptyText);
 230             return;
 231         }
 232
 233
 234         for(var i = 0, len = records.length; i < len; i++){
 235             var data = this.prepareData(records[i].data, i, records[i]);
 236             this.fireEvent("preparedata", this, data, i, records[i]);
 237             html[html.length] = Roo.util.Format.trim( t.apply(data) );
 238         }
 239
 240
 241
 242         this.el.update(html.join(""));
 243         this.nodes = this.el.dom.childNodes;
 244         this.updateIndexes(0);
 245     },
 246
 247     /**
 248      * Function to override to reformat the data that is sent to
 249      * the template for each node.
 250      * DEPRICATED - use the preparedata event handler.
 251      * @param {Array/Object} data The raw data (array of colData for a data model bound view or
 252      * a JSON object for an UpdateManager bound view).
 253      */
 254     prepareData : function(data, index, record)
 255     {
 256         this.fireEvent("preparedata", this, data, index, record);
 257         return data;
 258     },
 259
 260     onUpdate : function(ds, record){
 261         this.clearSelections();
 262         var index = this.store.indexOf(record);
 263         var n = this.nodes[index];
 264         this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
 265         n.parentNode.removeChild(n);
 266         this.updateIndexes(index, index);
 267     },
 268
 269     onAdd : function(ds, records, index){
 270         this.clearSelections();
 271         if(this.nodes.length == 0){
 272             this.refresh();
 273             return;
 274         }
 275         var n = this.nodes[index];
 276         for(var i = 0, len = records.length; i < len; i++){
 277             var d = this.prepareData(records[i].data, i, records[i]);
 278             if(n){
 279                 this.tpl.insertBefore(n, d);
 280             }else{
 281                 this.tpl.append(this.el, d);
 282             }
 283         }
 284         this.updateIndexes(index);
 285     },
 286
 287     onRemove : function(ds, record, index){
 288         this.clearSelections();
 289         this.el.dom.removeChild(this.nodes[index]);
 290         this.updateIndexes(index);
 291     },
 292
 293     /**
 294      * Refresh an individual node.
 295      * @param {Number} index
 296      */
 297     refreshNode : function(index){
 298         this.onUpdate(this.store, this.store.getAt(index));
 299     },
 300
 301     updateIndexes : function(startIndex, endIndex){
 302         var ns = this.nodes;
 303         startIndex = startIndex || 0;
 304         endIndex = endIndex || ns.length - 1;
 305         for(var i = startIndex; i <= endIndex; i++){
 306             ns[i].nodeIndex = i;
 307         }
 308     },
 309
 310     /**
 311      * Changes the data store this view uses and refresh the view.
 312      * @param {Store} store
 313      */
 314     setStore : function(store, initial){
 315         if(!initial && this.store){
 316             this.store.un("datachanged", this.refresh);
 317             this.store.un("add", this.onAdd);
 318             this.store.un("remove", this.onRemove);
 319             this.store.un("update", this.onUpdate);
 320             this.store.un("clear", this.refresh);
 321         }
 322         if(store){
 323
 324             store.on("datachanged", this.refresh, this);
 325             store.on("add", this.onAdd, this);
 326             store.on("remove", this.onRemove, this);
 327             store.on("update", this.onUpdate, this);
 328             store.on("clear", this.refresh, this);
 329         }
 330
 331         if(store){
 332             this.refresh();
 333         }
 334     },
 335
 336     /**
 337      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 338      * @param {HTMLElement} node
 339      * @return {HTMLElement} The template node
 340      */
 341     findItemFromChild : function(node){
 342         var el = this.el.dom;
 343         if(!node || node.parentNode == el){
 344                     return node;
 345             }
 346             var p = node.parentNode;
 347             while(p && p != el){
 348             if(p.parentNode == el){
 349                 return p;
 350             }
 351             p = p.parentNode;
 352         }
 353             return null;
 354     },
 355
 356     /** @ignore */
 357     onClick : function(e){
 358         var item = this.findItemFromChild(e.getTarget());
 359         if(item){
 360             var index = this.indexOf(item);
 361             if(this.onItemClick(item, index, e) !== false){
 362                 this.fireEvent("click", this, index, item, e);
 363             }
 364         }else{
 365             this.clearSelections();
 366         }
 367     },
 368
 369     /** @ignore */
 370     onContextMenu : function(e){
 371         var item = this.findItemFromChild(e.getTarget());
 372         if(item){
 373             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 374         }
 375     },
 376
 377     /** @ignore */
 378     onDblClick : function(e){
 379         var item = this.findItemFromChild(e.getTarget());
 380         if(item){
 381             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 382         }
 383     },
 384
 385     onItemClick : function(item, index, e)
 386     {
 387         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 388             return false;
 389         }
 390         if (this.toggleSelect) {
 391             var m = this.isSelected(item) ? 'unselect' : 'select';
 392             Roo.log(m);
 393             var _t = this;
 394             _t[m](item, true, false);
 395             return true;
 396         }
 397         if(this.multiSelect || this.singleSelect){
 398             if(this.multiSelect && e.shiftKey && this.lastSelection){
 399                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 400             }else{
 401                 this.select(item, this.multiSelect && e.ctrlKey);
 402                 this.lastSelection = item;
 403             }
 404             e.preventDefault();
 405         }
 406         return true;
 407     },
 408
 409     /**
 410      * Get the number of selected nodes.
 411      * @return {Number}
 412      */
 413     getSelectionCount : function(){
 414         return this.selections.length;
 415     },
 416
 417     /**
 418      * Get the currently selected nodes.
 419      * @return {Array} An array of HTMLElements
 420      */
 421     getSelectedNodes : function(){
 422         return this.selections;
 423     },
 424
 425     /**
 426      * Get the indexes of the selected nodes.
 427      * @return {Array}
 428      */
 429     getSelectedIndexes : function(){
 430         var indexes = [], s = this.selections;
 431         for(var i = 0, len = s.length; i < len; i++){
 432             indexes.push(s[i].nodeIndex);
 433         }
 434         return indexes;
 435     },
 436
 437     /**
 438      * Clear all selections
 439      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 440      */
 441     clearSelections : function(suppressEvent){
 442         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 443             this.cmp.elements = this.selections;
 444             this.cmp.removeClass(this.selectedClass);
 445             this.selections = [];
 446             if(!suppressEvent){
 447                 this.fireEvent("selectionchange", this, this.selections);
 448             }
 449         }
 450     },
 451
 452     /**
 453      * Returns true if the passed node is selected
 454      * @param {HTMLElement/Number} node The node or node index
 455      * @return {Boolean}
 456      */
 457     isSelected : function(node){
 458         var s = this.selections;
 459         if(s.length < 1){
 460             return false;
 461         }
 462         node = this.getNode(node);
 463         return s.indexOf(node) !== -1;
 464     },
 465
 466     /**
 467      * Selects nodes.
 468      * @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
 469      * @param {Boolean} keepExisting (optional) true to keep existing selections
 470      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 471      */
 472     select : function(nodeInfo, keepExisting, suppressEvent){
 473         if(nodeInfo instanceof Array){
 474             if(!keepExisting){
 475                 this.clearSelections(true);
 476             }
 477             for(var i = 0, len = nodeInfo.length; i < len; i++){
 478                 this.select(nodeInfo[i], true, true);
 479             }
 480             return;
 481         }
 482         var node = this.getNode(nodeInfo);
 483         if(!node || this.isSelected(node)){
 484             return; // already selected.
 485         }
 486         if(!keepExisting){
 487             this.clearSelections(true);
 488         }
 489         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 490             Roo.fly(node).addClass(this.selectedClass);
 491             this.selections.push(node);
 492             if(!suppressEvent){
 493                 this.fireEvent("selectionchange", this, this.selections);
 494             }
 495         }
 496
 497
 498     },
 499       /**
 500      * Unselects nodes.
 501      * @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
 502      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 503      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 504      */
 505     unselect : function(nodeInfo, keepExisting, suppressEvent)
 506     {
 507         if(nodeInfo instanceof Array){
 508             Roo.each(this.selections, function(s) {
 509                 this.unselect(s, nodeInfo);
 510             }, this);
 511             return;
 512         }
 513         var node = this.getNode(nodeInfo);
 514         if(!node || !this.isSelected(node)){
 515             Roo.log("not selected");
 516             return; // not selected.
 517         }
 518         // fireevent???
 519         var ns = [];
 520         Roo.each(this.selections, function(s) {
 521             if (s == node ) {
 522                 Roo.fly(node).removeClass(this.selectedClass);
 523
 524                 return;
 525             }
 526             ns.push(s);
 527         },this);
 528
 529         this.selections= ns;
 530         this.fireEvent("selectionchange", this, this.selections);
 531     },
 532
 533     /**
 534      * Gets a template node.
 535      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 536      * @return {HTMLElement} The node or null if it wasn't found
 537      */
 538     getNode : function(nodeInfo){
 539         if(typeof nodeInfo == "string"){
 540             return document.getElementById(nodeInfo);
 541         }else if(typeof nodeInfo == "number"){
 542             return this.nodes[nodeInfo];
 543         }
 544         return nodeInfo;
 545     },
 546
 547     /**
 548      * Gets a range template nodes.
 549      * @param {Number} startIndex
 550      * @param {Number} endIndex
 551      * @return {Array} An array of nodes
 552      */
 553     getNodes : function(start, end){
 554         var ns = this.nodes;
 555         start = start || 0;
 556         end = typeof end == "undefined" ? ns.length - 1 : end;
 557         var nodes = [];
 558         if(start <= end){
 559             for(var i = start; i <= end; i++){
 560                 nodes.push(ns[i]);
 561             }
 562         } else{
 563             for(var i = start; i >= end; i--){
 564                 nodes.push(ns[i]);
 565             }
 566         }
 567         return nodes;
 568     },
 569
 570     /**
 571      * Finds the index of the passed node
 572      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 573      * @return {Number} The index of the node or -1
 574      */
 575     indexOf : function(node){
 576         node = this.getNode(node);
 577         if(typeof node.nodeIndex == "number"){
 578             return node.nodeIndex;
 579         }
 580         var ns = this.nodes;
 581         for(var i = 0, len = ns.length; i < len; i++){
 582             if(ns[i] == node){
 583                 return i;
 584             }
 585         }
 586         return -1;
 587     }
 588 });