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         Roo.log(this.tpl);
 296         var t = this.tpl;
 297
 298         var html = [];
 299         var records = this.store.getRange();
 300         if(records.length < 1) {
 301
 302             // is this valid??  = should it render a template??
 303
 304             this.el.update(this.emptyText);
 305             return;
 306         }
 307         var el = this.el;
 308         if (this.dataName) {
 309             this.el.update(t.apply(this.store.meta)); //????
 310             el = this.el.child('.roo-tpl-' + this.dataName);
 311         }
 312
 313         for(var i = 0, len = records.length; i < len; i++){
 314             var data = this.prepareData(records[i].data, i, records[i]);
 315             this.fireEvent("preparedata", this, data, i, records[i]);
 316             html[html.length] = Roo.util.Format.trim(
 317                 this.dataName ?
 318                     t.applySubtemplate(this.dataName, data, this.store.meta) :
 319                     t.apply(data)
 320             );
 321         }
 322
 323
 324         Roo.log(html);
 325         el.update(html.join(""));
 326         this.nodes = el.dom.childNodes;
 327         this.updateIndexes(0);
 328     },
 329
 330     /**
 331      * Function to override to reformat the data that is sent to
 332      * the template for each node.
 333      * DEPRICATED - use the preparedata event handler.
 334      * @param {Array/Object} data The raw data (array of colData for a data model bound view or
 335      * a JSON object for an UpdateManager bound view).
 336      */
 337     prepareData : function(data, index, record)
 338     {
 339         this.fireEvent("preparedata", this, data, index, record);
 340         return data;
 341     },
 342
 343     onUpdate : function(ds, record){
 344         this.clearSelections();
 345         var index = this.store.indexOf(record);
 346         var n = this.nodes[index];
 347         this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
 348         n.parentNode.removeChild(n);
 349         this.updateIndexes(index, index);
 350     },
 351
 352
 353
 354 // --------- FIXME
 355     onAdd : function(ds, records, index)
 356     {
 357         this.clearSelections();
 358         if(this.nodes.length == 0){
 359             this.refresh();
 360             return;
 361         }
 362         var n = this.nodes[index];
 363         for(var i = 0, len = records.length; i < len; i++){
 364             var d = this.prepareData(records[i].data, i, records[i]);
 365             if(n){
 366                 this.tpl.insertBefore(n, d);
 367             }else{
 368
 369                 this.tpl.append(this.el, d);
 370             }
 371         }
 372         this.updateIndexes(index);
 373     },
 374
 375     onRemove : function(ds, record, index){
 376         this.clearSelections();
 377         var el = this.dataName  ?
 378             this.el.child('.roo-tpl-' + this.dataName) :
 379             this.el;
 380         el.dom.removeChild(this.nodes[index]);
 381         this.updateIndexes(index);
 382     },
 383
 384     /**
 385      * Refresh an individual node.
 386      * @param {Number} index
 387      */
 388     refreshNode : function(index){
 389         this.onUpdate(this.store, this.store.getAt(index));
 390     },
 391
 392     updateIndexes : function(startIndex, endIndex){
 393         var ns = this.nodes;
 394         startIndex = startIndex || 0;
 395         endIndex = endIndex || ns.length - 1;
 396         for(var i = startIndex; i <= endIndex; i++){
 397             ns[i].nodeIndex = i;
 398         }
 399     },
 400
 401     /**
 402      * Changes the data store this view uses and refresh the view.
 403      * @param {Store} store
 404      */
 405     setStore : function(store, initial){
 406         if(!initial && this.store){
 407             this.store.un("datachanged", this.refresh);
 408             this.store.un("add", this.onAdd);
 409             this.store.un("remove", this.onRemove);
 410             this.store.un("update", this.onUpdate);
 411             this.store.un("clear", this.refresh);
 412             this.store.un("beforeload", this.onBeforeLoad);
 413             this.store.un("load", this.onLoad);
 414             this.store.un("loadexception", this.onLoad);
 415         }
 416         if(store){
 417
 418             store.on("datachanged", this.refresh, this);
 419             store.on("add", this.onAdd, this);
 420             store.on("remove", this.onRemove, this);
 421             store.on("update", this.onUpdate, this);
 422             store.on("clear", this.refresh, this);
 423             store.on("beforeload", this.onBeforeLoad, this);
 424             store.on("load", this.onLoad, this);
 425             store.on("loadexception", this.onLoad, this);
 426         }
 427
 428         if(store){
 429             this.refresh();
 430         }
 431     },
 432     /**
 433      * onbeforeLoad - masks the loading area.
 434      *
 435      */
 436     onBeforeLoad : function()
 437     {
 438         this.el.update("");
 439         this.el.mask(this.mask ? this.mask : "Loading" );
 440     },
 441     onLoad : function ()
 442     {
 443         this.el.unmask();
 444     },
 445
 446
 447     /**
 448      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 449      * @param {HTMLElement} node
 450      * @return {HTMLElement} The template node
 451      */
 452     findItemFromChild : function(node){
 453         var el = this.dataName  ?
 454             this.el.child('.roo-tpl-' + this.dataName,true) :
 455             this.el.dom;
 456
 457         if(!node || node.parentNode == el){
 458                     return node;
 459             }
 460             var p = node.parentNode;
 461             while(p && p != el){
 462             if(p.parentNode == el){
 463                 return p;
 464             }
 465             p = p.parentNode;
 466         }
 467             return null;
 468     },
 469
 470     /** @ignore */
 471     onClick : function(e){
 472         var item = this.findItemFromChild(e.getTarget());
 473         if(item){
 474             var index = this.indexOf(item);
 475             if(this.onItemClick(item, index, e) !== false){
 476                 this.fireEvent("click", this, index, item, e);
 477             }
 478         }else{
 479             this.clearSelections();
 480         }
 481     },
 482
 483     /** @ignore */
 484     onContextMenu : function(e){
 485         var item = this.findItemFromChild(e.getTarget());
 486         if(item){
 487             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 488         }
 489     },
 490
 491     /** @ignore */
 492     onDblClick : function(e){
 493         var item = this.findItemFromChild(e.getTarget());
 494         if(item){
 495             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 496         }
 497     },
 498
 499     onItemClick : function(item, index, e)
 500     {
 501         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 502             return false;
 503         }
 504         if (this.toggleSelect) {
 505             var m = this.isSelected(item) ? 'unselect' : 'select';
 506             Roo.log(m);
 507             var _t = this;
 508             _t[m](item, true, false);
 509             return true;
 510         }
 511         if(this.multiSelect || this.singleSelect){
 512             if(this.multiSelect && e.shiftKey && this.lastSelection){
 513                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 514             }else{
 515                 this.select(item, this.multiSelect && e.ctrlKey);
 516                 this.lastSelection = item;
 517             }
 518             e.preventDefault();
 519         }
 520         return true;
 521     },
 522
 523     /**
 524      * Get the number of selected nodes.
 525      * @return {Number}
 526      */
 527     getSelectionCount : function(){
 528         return this.selections.length;
 529     },
 530
 531     /**
 532      * Get the currently selected nodes.
 533      * @return {Array} An array of HTMLElements
 534      */
 535     getSelectedNodes : function(){
 536         return this.selections;
 537     },
 538
 539     /**
 540      * Get the indexes of the selected nodes.
 541      * @return {Array}
 542      */
 543     getSelectedIndexes : function(){
 544         var indexes = [], s = this.selections;
 545         for(var i = 0, len = s.length; i < len; i++){
 546             indexes.push(s[i].nodeIndex);
 547         }
 548         return indexes;
 549     },
 550
 551     /**
 552      * Clear all selections
 553      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 554      */
 555     clearSelections : function(suppressEvent){
 556         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 557             this.cmp.elements = this.selections;
 558             this.cmp.removeClass(this.selectedClass);
 559             this.selections = [];
 560             if(!suppressEvent){
 561                 this.fireEvent("selectionchange", this, this.selections);
 562             }
 563         }
 564     },
 565
 566     /**
 567      * Returns true if the passed node is selected
 568      * @param {HTMLElement/Number} node The node or node index
 569      * @return {Boolean}
 570      */
 571     isSelected : function(node){
 572         var s = this.selections;
 573         if(s.length < 1){
 574             return false;
 575         }
 576         node = this.getNode(node);
 577         return s.indexOf(node) !== -1;
 578     },
 579
 580     /**
 581      * Selects nodes.
 582      * @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
 583      * @param {Boolean} keepExisting (optional) true to keep existing selections
 584      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 585      */
 586     select : function(nodeInfo, keepExisting, suppressEvent){
 587         if(nodeInfo instanceof Array){
 588             if(!keepExisting){
 589                 this.clearSelections(true);
 590             }
 591             for(var i = 0, len = nodeInfo.length; i < len; i++){
 592                 this.select(nodeInfo[i], true, true);
 593             }
 594             return;
 595         }
 596         var node = this.getNode(nodeInfo);
 597         if(!node || this.isSelected(node)){
 598             return; // already selected.
 599         }
 600         if(!keepExisting){
 601             this.clearSelections(true);
 602         }
 603         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 604             Roo.fly(node).addClass(this.selectedClass);
 605             this.selections.push(node);
 606             if(!suppressEvent){
 607                 this.fireEvent("selectionchange", this, this.selections);
 608             }
 609         }
 610
 611
 612     },
 613       /**
 614      * Unselects nodes.
 615      * @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
 616      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 617      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 618      */
 619     unselect : function(nodeInfo, keepExisting, suppressEvent)
 620     {
 621         if(nodeInfo instanceof Array){
 622             Roo.each(this.selections, function(s) {
 623                 this.unselect(s, nodeInfo);
 624             }, this);
 625             return;
 626         }
 627         var node = this.getNode(nodeInfo);
 628         if(!node || !this.isSelected(node)){
 629             Roo.log("not selected");
 630             return; // not selected.
 631         }
 632         // fireevent???
 633         var ns = [];
 634         Roo.each(this.selections, function(s) {
 635             if (s == node ) {
 636                 Roo.fly(node).removeClass(this.selectedClass);
 637
 638                 return;
 639             }
 640             ns.push(s);
 641         },this);
 642
 643         this.selections= ns;
 644         this.fireEvent("selectionchange", this, this.selections);
 645     },
 646
 647     /**
 648      * Gets a template node.
 649      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 650      * @return {HTMLElement} The node or null if it wasn't found
 651      */
 652     getNode : function(nodeInfo){
 653         if(typeof nodeInfo == "string"){
 654             return document.getElementById(nodeInfo);
 655         }else if(typeof nodeInfo == "number"){
 656             return this.nodes[nodeInfo];
 657         }
 658         return nodeInfo;
 659     },
 660
 661     /**
 662      * Gets a range template nodes.
 663      * @param {Number} startIndex
 664      * @param {Number} endIndex
 665      * @return {Array} An array of nodes
 666      */
 667     getNodes : function(start, end){
 668         var ns = this.nodes;
 669         start = start || 0;
 670         end = typeof end == "undefined" ? ns.length - 1 : end;
 671         var nodes = [];
 672         if(start <= end){
 673             for(var i = start; i <= end; i++){
 674                 nodes.push(ns[i]);
 675             }
 676         } else{
 677             for(var i = start; i >= end; i--){
 678                 nodes.push(ns[i]);
 679             }
 680         }
 681         return nodes;
 682     },
 683
 684     /**
 685      * Finds the index of the passed node
 686      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 687      * @return {Number} The index of the node or -1
 688      */
 689     indexOf : function(node){
 690         node = this.getNode(node);
 691         if(typeof node.nodeIndex == "number"){
 692             return node.nodeIndex;
 693         }
 694         var ns = this.nodes;
 695         for(var i = 0, len = ns.length; i < len; i++){
 696             if(ns[i] == node){
 697                 return i;
 698             }
 699         }
 700         return -1;
 701     }
 702 });