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     this.wrapEl  = this.el.wrap().wrap();
  63     ///this.el = this.wrapEla.appendChild(document.createElement("div"));
  64
  65
  66     if(typeof(this.tpl) == "string"){
  67         this.tpl = new Roo.Template(this.tpl);
  68     } else {
  69         // support xtype ctors..
  70         this.tpl = new Roo.factory(this.tpl, Roo);
  71     }
  72
  73
  74     this.tpl.compile();
  75
  76
  77
  78
  79     /** @private */
  80     this.addEvents({
  81         /**
  82          * @event beforeclick
  83          * Fires before a click is processed. Returns false to cancel the default action.
  84          * @param {Roo.View} this
  85          * @param {Number} index The index of the target node
  86          * @param {HTMLElement} node The target node
  87          * @param {Roo.EventObject} e The raw event object
  88          */
  89             "beforeclick" : true,
  90         /**
  91          * @event click
  92          * Fires when a template node is clicked.
  93          * @param {Roo.View} this
  94          * @param {Number} index The index of the target node
  95          * @param {HTMLElement} node The target node
  96          * @param {Roo.EventObject} e The raw event object
  97          */
  98             "click" : true,
  99         /**
 100          * @event dblclick
 101          * Fires when a template node is double clicked.
 102          * @param {Roo.View} this
 103          * @param {Number} index The index of the target node
 104          * @param {HTMLElement} node The target node
 105          * @param {Roo.EventObject} e The raw event object
 106          */
 107             "dblclick" : true,
 108         /**
 109          * @event contextmenu
 110          * Fires when a template node is right clicked.
 111          * @param {Roo.View} this
 112          * @param {Number} index The index of the target node
 113          * @param {HTMLElement} node The target node
 114          * @param {Roo.EventObject} e The raw event object
 115          */
 116             "contextmenu" : true,
 117         /**
 118          * @event selectionchange
 119          * Fires when the selected nodes change.
 120          * @param {Roo.View} this
 121          * @param {Array} selections Array of the selected nodes
 122          */
 123             "selectionchange" : true,
 124
 125         /**
 126          * @event beforeselect
 127          * Fires before a selection is made. If any handlers return false, the selection is cancelled.
 128          * @param {Roo.View} this
 129          * @param {HTMLElement} node The node to be selected
 130          * @param {Array} selections Array of currently selected nodes
 131          */
 132             "beforeselect" : true,
 133         /**
 134          * @event preparedata
 135          * Fires on every row to render, to allow you to change the data.
 136          * @param {Roo.View} this
 137          * @param {Object} data to be rendered (change this)
 138          */
 139           "preparedata" : true
 140
 141
 142         });
 143
 144
 145
 146     this.el.on({
 147         "click": this.onClick,
 148         "dblclick": this.onDblClick,
 149         "contextmenu": this.onContextMenu,
 150         scope:this
 151     });
 152
 153     this.selections = [];
 154     this.nodes = [];
 155     this.cmp = new Roo.CompositeElementLite([]);
 156     if(this.store){
 157         this.store = Roo.factory(this.store, Roo.data);
 158         this.setStore(this.store, true);
 159     }
 160
 161     if ( this.footer && this.footer.xtype) {
 162
 163          var fctr = this.wrapEl.appendChild(document.createElement("div"));
 164
 165         this.footer.dataSource = this.store
 166         this.footer.container = fctr;
 167         this.footer = Roo.factory(this.footer, Roo);
 168         fctr.insertFirst(this.el);
 169
 170         // this is a bit insane - as the paging toolbar seems to detach the el..
 171 //        dom.parentNode.parentNode.parentNode
 172          // they get detached?
 173     }
 174
 175
 176     Roo.View.superclass.constructor.call(this);
 177
 178
 179 };
 180
 181 Roo.extend(Roo.View, Roo.util.Observable, {
 182
 183      /**
 184      * @cfg {Roo.data.Store} store Data store to load data from.
 185      */
 186     store : false,
 187
 188     /**
 189      * @cfg {String|Roo.Element} el The container element.
 190      */
 191     el : '',
 192
 193     /**
 194      * @cfg {String|Roo.Template} tpl The template used by this View
 195      */
 196     tpl : false,
 197     /**
 198      * @cfg {String} dataName the named area of the template to use as the data area
 199      *                          Works with domtemplates roo-name="name"
 200      */
 201     dataName: false,
 202     /**
 203      * @cfg {String} selectedClass The css class to add to selected nodes
 204      */
 205     selectedClass : "x-view-selected",
 206      /**
 207      * @cfg {String} emptyText The empty text to show when nothing is loaded.
 208      */
 209     emptyText : "",
 210
 211     /**
 212      * @cfg {String} text to display on mask (default Loading)
 213      */
 214     mask : false,
 215     /**
 216      * @cfg {Boolean} multiSelect Allow multiple selection
 217      */
 218     multiSelect : false,
 219     /**
 220      * @cfg {Boolean} singleSelect Allow single selection
 221      */
 222     singleSelect:  false,
 223
 224     /**
 225      * @cfg {Boolean} toggleSelect - selecting
 226      */
 227     toggleSelect : false,
 228
 229     /**
 230      * Returns the element this view is bound to.
 231      * @return {Roo.Element}
 232      */
 233     getEl : function(){
 234         return this.wrapEl;
 235     },
 236
 237
 238
 239     /**
 240      * Refreshes the view. - called by datachanged on the store. - do not call directly.
 241      */
 242     refresh : function(){
 243         this.append();
 244         return;
 245         Roo.log('refresh');
 246         var t = this.tpl;
 247
 248         // if we are using something like 'domtemplate', then
 249         // the what gets used is:
 250         // t.applySubtemplate(NAME, data, wrapping data..)
 251         // the outer template then get' applied with
 252         //     the store 'extra data'
 253         // and the body get's added to the
 254         //      roo-name="data" node?
 255         //      <span class='roo-tpl-{name}'></span> ?????
 256
 257
 258
 259         this.clearSelections();
 260         this.el.update("");
 261         var html = [];
 262         var records = this.store.getRange();
 263         if(records.length < 1) {
 264
 265             // is this valid??  = should it render a template??
 266
 267             this.el.update(this.emptyText);
 268             return;
 269         }
 270         var el = this.el;
 271         if (this.dataName) {
 272             this.el.update(t.apply(this.store.meta)); //????
 273             el = this.el.child('.roo-tpl-' + this.dataName);
 274         }
 275
 276         for(var i = 0, len = records.length; i < len; i++){
 277             var data = this.prepareData(records[i].data, i, records[i]);
 278             this.fireEvent("preparedata", this, data, i, records[i]);
 279             html[html.length] = Roo.util.Format.trim(
 280                 this.dataName ?
 281                     t.applySubtemplate(this.dataName, data, this.store.meta) :
 282                     t.apply(data)
 283             );
 284         }
 285
 286
 287
 288         el.update(html.join(""));
 289         this.nodes = el.dom.childNodes;
 290         this.updateIndexes(0);
 291     },
 292
 293     append : function(){
 294         Roo.log('append');
 295         var t = this.tpl;
 296
 297         var html = [];
 298         var records = this.store.getRange();
 299         if(records.length < 1) {
 300
 301             // is this valid??  = should it render a template??
 302
 303             this.el.update(this.emptyText);
 304             return;
 305         }
 306         var el = this.el;
 307         if (this.dataName) {
 308             this.el.update(t.apply(this.store.meta)); //????
 309             el = this.el.child('.roo-tpl-' + this.dataName);
 310         }
 311
 312         for(var i = 0, len = records.length; i < len; i++){
 313             var data = this.prepareData(records[i].data, i, records[i]);
 314             this.fireEvent("preparedata", this, data, i, records[i]);
 315             html[html.length] = Roo.util.Format.trim(
 316                 this.dataName ?
 317                     t.applySubtemplate(this.dataName, data, this.store.meta) :
 318                     t.apply(data)
 319             );
 320         }
 321
 322
 323
 324         el.update(html.join(""));
 325         this.nodes = el.dom.childNodes;
 326         this.updateIndexes(0);
 327     },
 328
 329     /**
 330      * Function to override to reformat the data that is sent to
 331      * the template for each node.
 332      * DEPRICATED - use the preparedata event handler.
 333      * @param {Array/Object} data The raw data (array of colData for a data model bound view or
 334      * a JSON object for an UpdateManager bound view).
 335      */
 336     prepareData : function(data, index, record)
 337     {
 338         this.fireEvent("preparedata", this, data, index, record);
 339         return data;
 340     },
 341
 342     onUpdate : function(ds, record){
 343         this.clearSelections();
 344         var index = this.store.indexOf(record);
 345         var n = this.nodes[index];
 346         this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
 347         n.parentNode.removeChild(n);
 348         this.updateIndexes(index, index);
 349     },
 350
 351
 352
 353 // --------- FIXME
 354     onAdd : function(ds, records, index)
 355     {
 356         this.clearSelections();
 357         if(this.nodes.length == 0){
 358             this.refresh();
 359             return;
 360         }
 361         var n = this.nodes[index];
 362         for(var i = 0, len = records.length; i < len; i++){
 363             var d = this.prepareData(records[i].data, i, records[i]);
 364             if(n){
 365                 this.tpl.insertBefore(n, d);
 366             }else{
 367
 368                 this.tpl.append(this.el, d);
 369             }
 370         }
 371         this.updateIndexes(index);
 372     },
 373
 374     onRemove : function(ds, record, index){
 375         this.clearSelections();
 376         var el = this.dataName  ?
 377             this.el.child('.roo-tpl-' + this.dataName) :
 378             this.el;
 379         el.dom.removeChild(this.nodes[index]);
 380         this.updateIndexes(index);
 381     },
 382
 383     /**
 384      * Refresh an individual node.
 385      * @param {Number} index
 386      */
 387     refreshNode : function(index){
 388         this.onUpdate(this.store, this.store.getAt(index));
 389     },
 390
 391     updateIndexes : function(startIndex, endIndex){
 392         var ns = this.nodes;
 393         startIndex = startIndex || 0;
 394         endIndex = endIndex || ns.length - 1;
 395         for(var i = startIndex; i <= endIndex; i++){
 396             ns[i].nodeIndex = i;
 397         }
 398     },
 399
 400     /**
 401      * Changes the data store this view uses and refresh the view.
 402      * @param {Store} store
 403      */
 404     setStore : function(store, initial){
 405         if(!initial && this.store){
 406             this.store.un("datachanged", this.refresh);
 407             this.store.un("add", this.onAdd);
 408             this.store.un("remove", this.onRemove);
 409             this.store.un("update", this.onUpdate);
 410             this.store.un("clear", this.refresh);
 411             this.store.un("beforeload", this.onBeforeLoad);
 412             this.store.un("load", this.onLoad);
 413             this.store.un("loadexception", this.onLoad);
 414         }
 415         if(store){
 416
 417             store.on("datachanged", this.refresh, this);
 418             store.on("add", this.onAdd, this);
 419             store.on("remove", this.onRemove, this);
 420             store.on("update", this.onUpdate, this);
 421             store.on("clear", this.refresh, this);
 422             store.on("beforeload", this.onBeforeLoad, this);
 423             store.on("load", this.onLoad, this);
 424             store.on("loadexception", this.onLoad, this);
 425         }
 426
 427         if(store){
 428             this.refresh();
 429         }
 430     },
 431     /**
 432      * onbeforeLoad - masks the loading area.
 433      *
 434      */
 435     onBeforeLoad : function()
 436     {
 437         this.el.update("");
 438         this.el.mask(this.mask ? this.mask : "Loading" );
 439     },
 440     onLoad : function ()
 441     {
 442         this.el.unmask();
 443     },
 444
 445
 446     /**
 447      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 448      * @param {HTMLElement} node
 449      * @return {HTMLElement} The template node
 450      */
 451     findItemFromChild : function(node){
 452         var el = this.dataName  ?
 453             this.el.child('.roo-tpl-' + this.dataName,true) :
 454             this.el.dom;
 455
 456         if(!node || node.parentNode == el){
 457                     return node;
 458             }
 459             var p = node.parentNode;
 460             while(p && p != el){
 461             if(p.parentNode == el){
 462                 return p;
 463             }
 464             p = p.parentNode;
 465         }
 466             return null;
 467     },
 468
 469     /** @ignore */
 470     onClick : function(e){
 471         var item = this.findItemFromChild(e.getTarget());
 472         if(item){
 473             var index = this.indexOf(item);
 474             if(this.onItemClick(item, index, e) !== false){
 475                 this.fireEvent("click", this, index, item, e);
 476             }
 477         }else{
 478             this.clearSelections();
 479         }
 480     },
 481
 482     /** @ignore */
 483     onContextMenu : function(e){
 484         var item = this.findItemFromChild(e.getTarget());
 485         if(item){
 486             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 487         }
 488     },
 489
 490     /** @ignore */
 491     onDblClick : function(e){
 492         var item = this.findItemFromChild(e.getTarget());
 493         if(item){
 494             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 495         }
 496     },
 497
 498     onItemClick : function(item, index, e)
 499     {
 500         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 501             return false;
 502         }
 503         if (this.toggleSelect) {
 504             var m = this.isSelected(item) ? 'unselect' : 'select';
 505             Roo.log(m);
 506             var _t = this;
 507             _t[m](item, true, false);
 508             return true;
 509         }
 510         if(this.multiSelect || this.singleSelect){
 511             if(this.multiSelect && e.shiftKey && this.lastSelection){
 512                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 513             }else{
 514                 this.select(item, this.multiSelect && e.ctrlKey);
 515                 this.lastSelection = item;
 516             }
 517             e.preventDefault();
 518         }
 519         return true;
 520     },
 521
 522     /**
 523      * Get the number of selected nodes.
 524      * @return {Number}
 525      */
 526     getSelectionCount : function(){
 527         return this.selections.length;
 528     },
 529
 530     /**
 531      * Get the currently selected nodes.
 532      * @return {Array} An array of HTMLElements
 533      */
 534     getSelectedNodes : function(){
 535         return this.selections;
 536     },
 537
 538     /**
 539      * Get the indexes of the selected nodes.
 540      * @return {Array}
 541      */
 542     getSelectedIndexes : function(){
 543         var indexes = [], s = this.selections;
 544         for(var i = 0, len = s.length; i < len; i++){
 545             indexes.push(s[i].nodeIndex);
 546         }
 547         return indexes;
 548     },
 549
 550     /**
 551      * Clear all selections
 552      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 553      */
 554     clearSelections : function(suppressEvent){
 555         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 556             this.cmp.elements = this.selections;
 557             this.cmp.removeClass(this.selectedClass);
 558             this.selections = [];
 559             if(!suppressEvent){
 560                 this.fireEvent("selectionchange", this, this.selections);
 561             }
 562         }
 563     },
 564
 565     /**
 566      * Returns true if the passed node is selected
 567      * @param {HTMLElement/Number} node The node or node index
 568      * @return {Boolean}
 569      */
 570     isSelected : function(node){
 571         var s = this.selections;
 572         if(s.length < 1){
 573             return false;
 574         }
 575         node = this.getNode(node);
 576         return s.indexOf(node) !== -1;
 577     },
 578
 579     /**
 580      * Selects nodes.
 581      * @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
 582      * @param {Boolean} keepExisting (optional) true to keep existing selections
 583      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 584      */
 585     select : function(nodeInfo, keepExisting, suppressEvent){
 586         if(nodeInfo instanceof Array){
 587             if(!keepExisting){
 588                 this.clearSelections(true);
 589             }
 590             for(var i = 0, len = nodeInfo.length; i < len; i++){
 591                 this.select(nodeInfo[i], true, true);
 592             }
 593             return;
 594         }
 595         var node = this.getNode(nodeInfo);
 596         if(!node || this.isSelected(node)){
 597             return; // already selected.
 598         }
 599         if(!keepExisting){
 600             this.clearSelections(true);
 601         }
 602         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 603             Roo.fly(node).addClass(this.selectedClass);
 604             this.selections.push(node);
 605             if(!suppressEvent){
 606                 this.fireEvent("selectionchange", this, this.selections);
 607             }
 608         }
 609
 610
 611     },
 612       /**
 613      * Unselects nodes.
 614      * @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
 615      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 616      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 617      */
 618     unselect : function(nodeInfo, keepExisting, suppressEvent)
 619     {
 620         if(nodeInfo instanceof Array){
 621             Roo.each(this.selections, function(s) {
 622                 this.unselect(s, nodeInfo);
 623             }, this);
 624             return;
 625         }
 626         var node = this.getNode(nodeInfo);
 627         if(!node || !this.isSelected(node)){
 628             Roo.log("not selected");
 629             return; // not selected.
 630         }
 631         // fireevent???
 632         var ns = [];
 633         Roo.each(this.selections, function(s) {
 634             if (s == node ) {
 635                 Roo.fly(node).removeClass(this.selectedClass);
 636
 637                 return;
 638             }
 639             ns.push(s);
 640         },this);
 641
 642         this.selections= ns;
 643         this.fireEvent("selectionchange", this, this.selections);
 644     },
 645
 646     /**
 647      * Gets a template node.
 648      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 649      * @return {HTMLElement} The node or null if it wasn't found
 650      */
 651     getNode : function(nodeInfo){
 652         if(typeof nodeInfo == "string"){
 653             return document.getElementById(nodeInfo);
 654         }else if(typeof nodeInfo == "number"){
 655             return this.nodes[nodeInfo];
 656         }
 657         return nodeInfo;
 658     },
 659
 660     /**
 661      * Gets a range template nodes.
 662      * @param {Number} startIndex
 663      * @param {Number} endIndex
 664      * @return {Array} An array of nodes
 665      */
 666     getNodes : function(start, end){
 667         var ns = this.nodes;
 668         start = start || 0;
 669         end = typeof end == "undefined" ? ns.length - 1 : end;
 670         var nodes = [];
 671         if(start <= end){
 672             for(var i = start; i <= end; i++){
 673                 nodes.push(ns[i]);
 674             }
 675         } else{
 676             for(var i = start; i >= end; i--){
 677                 nodes.push(ns[i]);
 678             }
 679         }
 680         return nodes;
 681     },
 682
 683     /**
 684      * Finds the index of the passed node
 685      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 686      * @return {Number} The index of the node or -1
 687      */
 688     indexOf : function(node){
 689         node = this.getNode(node);
 690         if(typeof node.nodeIndex == "number"){
 691             return node.nodeIndex;
 692         }
 693         var ns = this.nodes;
 694         for(var i = 0, len = ns.length; i < len; i++){
 695             if(ns[i] == node){
 696                 return i;
 697             }
 698         }
 699         return -1;
 700     }
 701 });