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