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