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