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