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     this.parent = false;
  53
  54     if (typeof(depreciated_tpl) == 'undefined') {
  55         // new way.. - universal constructor.
  56         Roo.apply(this, config);
  57         this.el  = Roo.get(this.el);
  58     } else {
  59         // old format..
  60         this.el  = Roo.get(config);
  61         this.tpl = depreciated_tpl;
  62         Roo.apply(this, depreciated_config);
  63     }
  64     this.wrapEl  = this.el.wrap().wrap();
  65     ///this.el = this.wrapEla.appendChild(document.createElement("div"));
  66
  67
  68     if(typeof(this.tpl) == "string"){
  69         this.tpl = new Roo.Template(this.tpl);
  70     } else {
  71         // support xtype ctors..
  72         this.tpl = new Roo.factory(this.tpl, Roo);
  73     }
  74
  75
  76     this.tpl.compile();
  77
  78     /** @private */
  79     this.addEvents({
  80         /**
  81          * @event beforeclick
  82          * Fires before a click is processed. Returns false to cancel the default action.
  83          * @param {Roo.View} this
  84          * @param {Number} index The index of the target node
  85          * @param {HTMLElement} node The target node
  86          * @param {Roo.EventObject} e The raw event object
  87          */
  88             "beforeclick" : true,
  89         /**
  90          * @event click
  91          * Fires when a template node is clicked.
  92          * @param {Roo.View} this
  93          * @param {Number} index The index of the target node
  94          * @param {HTMLElement} node The target node
  95          * @param {Roo.EventObject} e The raw event object
  96          */
  97             "click" : true,
  98         /**
  99          * @event dblclick
 100          * Fires when a template node is double clicked.
 101          * @param {Roo.View} this
 102          * @param {Number} index The index of the target node
 103          * @param {HTMLElement} node The target node
 104          * @param {Roo.EventObject} e The raw event object
 105          */
 106             "dblclick" : true,
 107         /**
 108          * @event contextmenu
 109          * Fires when a template node is right clicked.
 110          * @param {Roo.View} this
 111          * @param {Number} index The index of the target node
 112          * @param {HTMLElement} node The target node
 113          * @param {Roo.EventObject} e The raw event object
 114          */
 115             "contextmenu" : true,
 116         /**
 117          * @event selectionchange
 118          * Fires when the selected nodes change.
 119          * @param {Roo.View} this
 120          * @param {Array} selections Array of the selected nodes
 121          */
 122             "selectionchange" : true,
 123
 124         /**
 125          * @event beforeselect
 126          * Fires before a selection is made. If any handlers return false, the selection is cancelled.
 127          * @param {Roo.View} this
 128          * @param {HTMLElement} node The node to be selected
 129          * @param {Array} selections Array of currently selected nodes
 130          */
 131             "beforeselect" : true,
 132         /**
 133          * @event preparedata
 134          * Fires on every row to render, to allow you to change the data.
 135          * @param {Roo.View} this
 136          * @param {Object} data to be rendered (change this)
 137          */
 138           "preparedata" : true
 139
 140
 141         });
 142
 143
 144
 145     this.el.on({
 146         "click": this.onClick,
 147         "dblclick": this.onDblClick,
 148         "contextmenu": this.onContextMenu,
 149         scope:this
 150     });
 151
 152     this.selections = [];
 153     this.nodes = [];
 154     this.cmp = new Roo.CompositeElementLite([]);
 155     if(this.store){
 156         this.store = Roo.factory(this.store, Roo.data);
 157         this.setStore(this.store, true);
 158     }
 159
 160     if ( this.footer && this.footer.xtype) {
 161
 162          var fctr = this.wrapEl.appendChild(document.createElement("div"));
 163
 164         this.footer.dataSource = this.store;
 165         this.footer.container = fctr;
 166         this.footer = Roo.factory(this.footer, Roo);
 167         fctr.insertFirst(this.el);
 168
 169         // this is a bit insane - as the paging toolbar seems to detach the el..
 170 //        dom.parentNode.parentNode.parentNode
 171          // they get detached?
 172     }
 173
 174
 175     Roo.View.superclass.constructor.call(this);
 176
 177
 178 };
 179
 180 Roo.extend(Roo.View, Roo.util.Observable, {
 181
 182      /**
 183      * @cfg {Roo.data.Store} store Data store to load data from.
 184      */
 185     store : false,
 186
 187     /**
 188      * @cfg {String|Roo.Element} el The container element.
 189      */
 190     el : '',
 191
 192     /**
 193      * @cfg {String|Roo.Template} tpl The template used by this View
 194      */
 195     tpl : false,
 196     /**
 197      * @cfg {String} dataName the named area of the template to use as the data area
 198      *                          Works with domtemplates roo-name="name"
 199      */
 200     dataName: false,
 201     /**
 202      * @cfg {String} selectedClass The css class to add to selected nodes
 203      */
 204     selectedClass : "x-view-selected",
 205      /**
 206      * @cfg {String} emptyText The empty text to show when nothing is loaded.
 207      */
 208     emptyText : "",
 209
 210     /**
 211      * @cfg {String} text to display on mask (default Loading)
 212      */
 213     mask : false,
 214     /**
 215      * @cfg {Boolean} multiSelect Allow multiple selection
 216      */
 217     multiSelect : false,
 218     /**
 219      * @cfg {Boolean} singleSelect Allow single selection
 220      */
 221     singleSelect:  false,
 222
 223     /**
 224      * @cfg {Boolean} toggleSelect - selecting
 225      */
 226     toggleSelect : false,
 227
 228     /**
 229      * @cfg {Boolean} tickable - selecting
 230      */
 231     tickable : false,
 232
 233     /**
 234      * Returns the element this view is bound to.
 235      * @return {Roo.Element}
 236      */
 237     getEl : function(){
 238         return this.wrapEl;
 239     },
 240
 241
 242
 243     /**
 244      * Refreshes the view. - called by datachanged on the store. - do not call directly.
 245      */
 246     refresh : function(){
 247         //Roo.log('refresh');
 248         var t = this.tpl;
 249
 250         // if we are using something like 'domtemplate', then
 251         // the what gets used is:
 252         // t.applySubtemplate(NAME, data, wrapping data..)
 253         // the outer template then get' applied with
 254         //     the store 'extra data'
 255         // and the body get's added to the
 256         //      roo-name="data" node?
 257         //      <span class='roo-tpl-{name}'></span> ?????
 258
 259
 260
 261         this.clearSelections();
 262         this.el.update("");
 263         var html = [];
 264         var records = this.store.getRange();
 265         if(records.length < 1) {
 266
 267             // is this valid??  = should it render a template??
 268
 269             this.el.update(this.emptyText);
 270             return;
 271         }
 272         var el = this.el;
 273         if (this.dataName) {
 274             this.el.update(t.apply(this.store.meta)); //????
 275             el = this.el.child('.roo-tpl-' + this.dataName);
 276         }
 277
 278         for(var i = 0, len = records.length; i < len; i++){
 279             var data = this.prepareData(records[i].data, i, records[i]);
 280             this.fireEvent("preparedata", this, data, i, records[i]);
 281
 282             var d = Roo.apply({}, data);
 283
 284             if(this.tickable){
 285                 Roo.apply(d, {'roo-id' : Roo.id()});
 286
 287                 var _this = this;
 288
 289                 Roo.each(this.parent.item, function(item){
 290                     if(item[_this.parent.valueField] != data[_this.parent.valueField]){
 291                         return;
 292                     }
 293                     Roo.apply(d, {'roo-data-checked' : 'checked'});
 294                 });
 295             }
 296
 297             html[html.length] = Roo.util.Format.trim(
 298                 this.dataName ?
 299                     t.applySubtemplate(this.dataName, d, this.store.meta) :
 300                     t.apply(d)
 301             );
 302         }
 303
 304
 305
 306         el.update(html.join(""));
 307         this.nodes = el.dom.childNodes;
 308         this.updateIndexes(0);
 309     },
 310
 311
 312     /**
 313      * Function to override to reformat the data that is sent to
 314      * the template for each node.
 315      * DEPRICATED - use the preparedata event handler.
 316      * @param {Array/Object} data The raw data (array of colData for a data model bound view or
 317      * a JSON object for an UpdateManager bound view).
 318      */
 319     prepareData : function(data, index, record)
 320     {
 321         this.fireEvent("preparedata", this, data, index, record);
 322         return data;
 323     },
 324
 325     onUpdate : function(ds, record){
 326         // Roo.log('on update');
 327         this.clearSelections();
 328         var index = this.store.indexOf(record);
 329         var n = this.nodes[index];
 330         this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
 331         n.parentNode.removeChild(n);
 332         this.updateIndexes(index, index);
 333     },
 334
 335
 336
 337 // --------- FIXME
 338     onAdd : function(ds, records, index)
 339     {
 340         //Roo.log(['on Add', ds, records, index] );
 341         this.clearSelections();
 342         if(this.nodes.length == 0){
 343             this.refresh();
 344             return;
 345         }
 346         var n = this.nodes[index];
 347         for(var i = 0, len = records.length; i < len; i++){
 348             var d = this.prepareData(records[i].data, i, records[i]);
 349             if(n){
 350                 this.tpl.insertBefore(n, d);
 351             }else{
 352
 353                 this.tpl.append(this.el, d);
 354             }
 355         }
 356         this.updateIndexes(index);
 357     },
 358
 359     onRemove : function(ds, record, index){
 360        // Roo.log('onRemove');
 361         this.clearSelections();
 362         var el = this.dataName  ?
 363             this.el.child('.roo-tpl-' + this.dataName) :
 364             this.el;
 365
 366         el.dom.removeChild(this.nodes[index]);
 367         this.updateIndexes(index);
 368     },
 369
 370     /**
 371      * Refresh an individual node.
 372      * @param {Number} index
 373      */
 374     refreshNode : function(index){
 375         this.onUpdate(this.store, this.store.getAt(index));
 376     },
 377
 378     updateIndexes : function(startIndex, endIndex){
 379         var ns = this.nodes;
 380         startIndex = startIndex || 0;
 381         endIndex = endIndex || ns.length - 1;
 382         for(var i = startIndex; i <= endIndex; i++){
 383             ns[i].nodeIndex = i;
 384         }
 385     },
 386
 387     /**
 388      * Changes the data store this view uses and refresh the view.
 389      * @param {Store} store
 390      */
 391     setStore : function(store, initial){
 392         if(!initial && this.store){
 393             this.store.un("datachanged", this.refresh);
 394             this.store.un("add", this.onAdd);
 395             this.store.un("remove", this.onRemove);
 396             this.store.un("update", this.onUpdate);
 397             this.store.un("clear", this.refresh);
 398             this.store.un("beforeload", this.onBeforeLoad);
 399             this.store.un("load", this.onLoad);
 400             this.store.un("loadexception", this.onLoad);
 401         }
 402         if(store){
 403
 404             store.on("datachanged", this.refresh, this);
 405             store.on("add", this.onAdd, this);
 406             store.on("remove", this.onRemove, this);
 407             store.on("update", this.onUpdate, this);
 408             store.on("clear", this.refresh, this);
 409             store.on("beforeload", this.onBeforeLoad, this);
 410             store.on("load", this.onLoad, this);
 411             store.on("loadexception", this.onLoad, this);
 412         }
 413
 414         if(store){
 415             this.refresh();
 416         }
 417     },
 418     /**
 419      * onbeforeLoad - masks the loading area.
 420      *
 421      */
 422     onBeforeLoad : function(store,opts)
 423     {
 424          //Roo.log('onBeforeLoad');
 425         if (!opts.add) {
 426             this.el.update("");
 427         }
 428         this.el.mask(this.mask ? this.mask : "Loading" );
 429     },
 430     onLoad : function ()
 431     {
 432         this.el.unmask();
 433     },
 434
 435
 436     /**
 437      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 438      * @param {HTMLElement} node
 439      * @return {HTMLElement} The template node
 440      */
 441     findItemFromChild : function(node){
 442         var el = this.dataName  ?
 443             this.el.child('.roo-tpl-' + this.dataName,true) :
 444             this.el.dom;
 445
 446         if(!node || node.parentNode == el){
 447                     return node;
 448             }
 449             var p = node.parentNode;
 450             while(p && p != el){
 451             if(p.parentNode == el){
 452                 return p;
 453             }
 454             p = p.parentNode;
 455         }
 456             return null;
 457     },
 458
 459     /** @ignore */
 460     onClick : function(e){
 461         var item = this.findItemFromChild(e.getTarget());
 462         if(item){
 463             var index = this.indexOf(item);
 464             if(this.onItemClick(item, index, e) !== false){
 465                 this.fireEvent("click", this, index, item, e);
 466             }
 467         }else{
 468             this.clearSelections();
 469         }
 470     },
 471
 472     /** @ignore */
 473     onContextMenu : function(e){
 474         var item = this.findItemFromChild(e.getTarget());
 475         if(item){
 476             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 477         }
 478     },
 479
 480     /** @ignore */
 481     onDblClick : function(e){
 482         var item = this.findItemFromChild(e.getTarget());
 483         if(item){
 484             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 485         }
 486     },
 487
 488     onItemClick : function(item, index, e)
 489     {
 490         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 491             return false;
 492         }
 493         if (this.toggleSelect) {
 494             var m = this.isSelected(item) ? 'unselect' : 'select';
 495             //Roo.log(m);
 496             var _t = this;
 497             _t[m](item, true, false);
 498             return true;
 499         }
 500         if(this.multiSelect || this.singleSelect){
 501             if(this.multiSelect && e.shiftKey && this.lastSelection){
 502                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 503             }else{
 504                 this.select(item, this.multiSelect && e.ctrlKey);
 505                 this.lastSelection = item;
 506             }
 507
 508             if(!this.tickable){
 509                 e.preventDefault();
 510             }
 511
 512         }
 513         return true;
 514     },
 515
 516     /**
 517      * Get the number of selected nodes.
 518      * @return {Number}
 519      */
 520     getSelectionCount : function(){
 521         return this.selections.length;
 522     },
 523
 524     /**
 525      * Get the currently selected nodes.
 526      * @return {Array} An array of HTMLElements
 527      */
 528     getSelectedNodes : function(){
 529         return this.selections;
 530     },
 531
 532     /**
 533      * Get the indexes of the selected nodes.
 534      * @return {Array}
 535      */
 536     getSelectedIndexes : function(){
 537         var indexes = [], s = this.selections;
 538         for(var i = 0, len = s.length; i < len; i++){
 539             indexes.push(s[i].nodeIndex);
 540         }
 541         return indexes;
 542     },
 543
 544     /**
 545      * Clear all selections
 546      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 547      */
 548     clearSelections : function(suppressEvent){
 549         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 550             this.cmp.elements = this.selections;
 551             this.cmp.removeClass(this.selectedClass);
 552             this.selections = [];
 553             if(!suppressEvent){
 554                 this.fireEvent("selectionchange", this, this.selections);
 555             }
 556         }
 557     },
 558
 559     /**
 560      * Returns true if the passed node is selected
 561      * @param {HTMLElement/Number} node The node or node index
 562      * @return {Boolean}
 563      */
 564     isSelected : function(node){
 565         var s = this.selections;
 566         if(s.length < 1){
 567             return false;
 568         }
 569         node = this.getNode(node);
 570         return s.indexOf(node) !== -1;
 571     },
 572
 573     /**
 574      * Selects 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 to keep existing selections
 577      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 578      */
 579     select : function(nodeInfo, keepExisting, suppressEvent){
 580         if(nodeInfo instanceof Array){
 581             if(!keepExisting){
 582                 this.clearSelections(true);
 583             }
 584             for(var i = 0, len = nodeInfo.length; i < len; i++){
 585                 this.select(nodeInfo[i], true, true);
 586             }
 587             return;
 588         }
 589         var node = this.getNode(nodeInfo);
 590         if(!node || this.isSelected(node)){
 591             return; // already selected.
 592         }
 593         if(!keepExisting){
 594             this.clearSelections(true);
 595         }
 596
 597         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 598             Roo.fly(node).addClass(this.selectedClass);
 599             this.selections.push(node);
 600             if(!suppressEvent){
 601                 this.fireEvent("selectionchange", this, this.selections);
 602             }
 603         }
 604
 605
 606     },
 607       /**
 608      * Unselects nodes.
 609      * @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
 610      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 611      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 612      */
 613     unselect : function(nodeInfo, keepExisting, suppressEvent)
 614     {
 615         if(nodeInfo instanceof Array){
 616             Roo.each(this.selections, function(s) {
 617                 this.unselect(s, nodeInfo);
 618             }, this);
 619             return;
 620         }
 621         var node = this.getNode(nodeInfo);
 622         if(!node || !this.isSelected(node)){
 623             //Roo.log("not selected");
 624             return; // not selected.
 625         }
 626         // fireevent???
 627         var ns = [];
 628         Roo.each(this.selections, function(s) {
 629             if (s == node ) {
 630                 Roo.fly(node).removeClass(this.selectedClass);
 631
 632                 return;
 633             }
 634             ns.push(s);
 635         },this);
 636
 637         this.selections= ns;
 638         this.fireEvent("selectionchange", this, this.selections);
 639     },
 640
 641     /**
 642      * Gets a template node.
 643      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 644      * @return {HTMLElement} The node or null if it wasn't found
 645      */
 646     getNode : function(nodeInfo){
 647         if(typeof nodeInfo == "string"){
 648             return document.getElementById(nodeInfo);
 649         }else if(typeof nodeInfo == "number"){
 650             return this.nodes[nodeInfo];
 651         }
 652         return nodeInfo;
 653     },
 654
 655     /**
 656      * Gets a range template nodes.
 657      * @param {Number} startIndex
 658      * @param {Number} endIndex
 659      * @return {Array} An array of nodes
 660      */
 661     getNodes : function(start, end){
 662         var ns = this.nodes;
 663         start = start || 0;
 664         end = typeof end == "undefined" ? ns.length - 1 : end;
 665         var nodes = [];
 666         if(start <= end){
 667             for(var i = start; i <= end; i++){
 668                 nodes.push(ns[i]);
 669             }
 670         } else{
 671             for(var i = start; i >= end; i--){
 672                 nodes.push(ns[i]);
 673             }
 674         }
 675         return nodes;
 676     },
 677
 678     /**
 679      * Finds the index of the passed node
 680      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 681      * @return {Number} The index of the node or -1
 682      */
 683     indexOf : function(node){
 684         node = this.getNode(node);
 685         if(typeof node.nodeIndex == "number"){
 686             return node.nodeIndex;
 687         }
 688         var ns = this.nodes;
 689         for(var i = 0, len = ns.length; i < len; i++){
 690             if(ns[i] == node){
 691                 return i;
 692             }
 693         }
 694         return -1;
 695     }
 696 });