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