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