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     onAdd : function(ds, records, index){
 281         this.clearSelections();
 282         if(this.nodes.length == 0){
 283             this.refresh();
 284             return;
 285         }
 286         var n = this.nodes[index];
 287         for(var i = 0, len = records.length; i < len; i++){
 288             var d = this.prepareData(records[i].data, i, records[i]);
 289             if(n){
 290                 this.tpl.insertBefore(n, d);
 291             }else{
 292                 this.tpl.append(this.el, d);
 293             }
 294         }
 295         this.updateIndexes(index);
 296     },
 297
 298     onRemove : function(ds, record, index){
 299         this.clearSelections();
 300         this.el.dom.removeChild(this.nodes[index]);
 301         this.updateIndexes(index);
 302     },
 303
 304     /**
 305      * Refresh an individual node.
 306      * @param {Number} index
 307      */
 308     refreshNode : function(index){
 309         this.onUpdate(this.store, this.store.getAt(index));
 310     },
 311
 312     updateIndexes : function(startIndex, endIndex){
 313         var ns = this.nodes;
 314         startIndex = startIndex || 0;
 315         endIndex = endIndex || ns.length - 1;
 316         for(var i = startIndex; i <= endIndex; i++){
 317             ns[i].nodeIndex = i;
 318         }
 319     },
 320
 321     /**
 322      * Changes the data store this view uses and refresh the view.
 323      * @param {Store} store
 324      */
 325     setStore : function(store, initial){
 326         if(!initial && this.store){
 327             this.store.un("datachanged", this.refresh);
 328             this.store.un("add", this.onAdd);
 329             this.store.un("remove", this.onRemove);
 330             this.store.un("update", this.onUpdate);
 331             this.store.un("clear", this.refresh);
 332         }
 333         if(store){
 334
 335             store.on("datachanged", this.refresh, this);
 336             store.on("add", this.onAdd, this);
 337             store.on("remove", this.onRemove, this);
 338             store.on("update", this.onUpdate, this);
 339             store.on("clear", this.refresh, this);
 340         }
 341
 342         if(store){
 343             this.refresh();
 344         }
 345     },
 346
 347     /**
 348      * Returns the template node the passed child belongs to or null if it doesn't belong to one.
 349      * @param {HTMLElement} node
 350      * @return {HTMLElement} The template node
 351      */
 352     findItemFromChild : function(node){
 353         var el = this.el.dom;
 354         if(!node || node.parentNode == el){
 355                     return node;
 356             }
 357             var p = node.parentNode;
 358             while(p && p != el){
 359             if(p.parentNode == el){
 360                 return p;
 361             }
 362             p = p.parentNode;
 363         }
 364             return null;
 365     },
 366
 367     /** @ignore */
 368     onClick : function(e){
 369         var item = this.findItemFromChild(e.getTarget());
 370         if(item){
 371             var index = this.indexOf(item);
 372             if(this.onItemClick(item, index, e) !== false){
 373                 this.fireEvent("click", this, index, item, e);
 374             }
 375         }else{
 376             this.clearSelections();
 377         }
 378     },
 379
 380     /** @ignore */
 381     onContextMenu : function(e){
 382         var item = this.findItemFromChild(e.getTarget());
 383         if(item){
 384             this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
 385         }
 386     },
 387
 388     /** @ignore */
 389     onDblClick : function(e){
 390         var item = this.findItemFromChild(e.getTarget());
 391         if(item){
 392             this.fireEvent("dblclick", this, this.indexOf(item), item, e);
 393         }
 394     },
 395
 396     onItemClick : function(item, index, e)
 397     {
 398         if(this.fireEvent("beforeclick", this, index, item, e) === false){
 399             return false;
 400         }
 401         if (this.toggleSelect) {
 402             var m = this.isSelected(item) ? 'unselect' : 'select';
 403             Roo.log(m);
 404             var _t = this;
 405             _t[m](item, true, false);
 406             return true;
 407         }
 408         if(this.multiSelect || this.singleSelect){
 409             if(this.multiSelect && e.shiftKey && this.lastSelection){
 410                 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
 411             }else{
 412                 this.select(item, this.multiSelect && e.ctrlKey);
 413                 this.lastSelection = item;
 414             }
 415             e.preventDefault();
 416         }
 417         return true;
 418     },
 419
 420     /**
 421      * Get the number of selected nodes.
 422      * @return {Number}
 423      */
 424     getSelectionCount : function(){
 425         return this.selections.length;
 426     },
 427
 428     /**
 429      * Get the currently selected nodes.
 430      * @return {Array} An array of HTMLElements
 431      */
 432     getSelectedNodes : function(){
 433         return this.selections;
 434     },
 435
 436     /**
 437      * Get the indexes of the selected nodes.
 438      * @return {Array}
 439      */
 440     getSelectedIndexes : function(){
 441         var indexes = [], s = this.selections;
 442         for(var i = 0, len = s.length; i < len; i++){
 443             indexes.push(s[i].nodeIndex);
 444         }
 445         return indexes;
 446     },
 447
 448     /**
 449      * Clear all selections
 450      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
 451      */
 452     clearSelections : function(suppressEvent){
 453         if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
 454             this.cmp.elements = this.selections;
 455             this.cmp.removeClass(this.selectedClass);
 456             this.selections = [];
 457             if(!suppressEvent){
 458                 this.fireEvent("selectionchange", this, this.selections);
 459             }
 460         }
 461     },
 462
 463     /**
 464      * Returns true if the passed node is selected
 465      * @param {HTMLElement/Number} node The node or node index
 466      * @return {Boolean}
 467      */
 468     isSelected : function(node){
 469         var s = this.selections;
 470         if(s.length < 1){
 471             return false;
 472         }
 473         node = this.getNode(node);
 474         return s.indexOf(node) !== -1;
 475     },
 476
 477     /**
 478      * Selects nodes.
 479      * @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
 480      * @param {Boolean} keepExisting (optional) true to keep existing selections
 481      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 482      */
 483     select : function(nodeInfo, keepExisting, suppressEvent){
 484         if(nodeInfo instanceof Array){
 485             if(!keepExisting){
 486                 this.clearSelections(true);
 487             }
 488             for(var i = 0, len = nodeInfo.length; i < len; i++){
 489                 this.select(nodeInfo[i], true, true);
 490             }
 491             return;
 492         }
 493         var node = this.getNode(nodeInfo);
 494         if(!node || this.isSelected(node)){
 495             return; // already selected.
 496         }
 497         if(!keepExisting){
 498             this.clearSelections(true);
 499         }
 500         if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
 501             Roo.fly(node).addClass(this.selectedClass);
 502             this.selections.push(node);
 503             if(!suppressEvent){
 504                 this.fireEvent("selectionchange", this, this.selections);
 505             }
 506         }
 507
 508
 509     },
 510       /**
 511      * Unselects nodes.
 512      * @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
 513      * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
 514      * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
 515      */
 516     unselect : function(nodeInfo, keepExisting, suppressEvent)
 517     {
 518         if(nodeInfo instanceof Array){
 519             Roo.each(this.selections, function(s) {
 520                 this.unselect(s, nodeInfo);
 521             }, this);
 522             return;
 523         }
 524         var node = this.getNode(nodeInfo);
 525         if(!node || !this.isSelected(node)){
 526             Roo.log("not selected");
 527             return; // not selected.
 528         }
 529         // fireevent???
 530         var ns = [];
 531         Roo.each(this.selections, function(s) {
 532             if (s == node ) {
 533                 Roo.fly(node).removeClass(this.selectedClass);
 534
 535                 return;
 536             }
 537             ns.push(s);
 538         },this);
 539
 540         this.selections= ns;
 541         this.fireEvent("selectionchange", this, this.selections);
 542     },
 543
 544     /**
 545      * Gets a template node.
 546      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 547      * @return {HTMLElement} The node or null if it wasn't found
 548      */
 549     getNode : function(nodeInfo){
 550         if(typeof nodeInfo == "string"){
 551             return document.getElementById(nodeInfo);
 552         }else if(typeof nodeInfo == "number"){
 553             return this.nodes[nodeInfo];
 554         }
 555         return nodeInfo;
 556     },
 557
 558     /**
 559      * Gets a range template nodes.
 560      * @param {Number} startIndex
 561      * @param {Number} endIndex
 562      * @return {Array} An array of nodes
 563      */
 564     getNodes : function(start, end){
 565         var ns = this.nodes;
 566         start = start || 0;
 567         end = typeof end == "undefined" ? ns.length - 1 : end;
 568         var nodes = [];
 569         if(start <= end){
 570             for(var i = start; i <= end; i++){
 571                 nodes.push(ns[i]);
 572             }
 573         } else{
 574             for(var i = start; i >= end; i--){
 575                 nodes.push(ns[i]);
 576             }
 577         }
 578         return nodes;
 579     },
 580
 581     /**
 582      * Finds the index of the passed node
 583      * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
 584      * @return {Number} The index of the node or -1
 585      */
 586     indexOf : function(node){
 587         node = this.getNode(node);
 588         if(typeof node.nodeIndex == "number"){
 589             return node.nodeIndex;
 590         }
 591         var ns = this.nodes;
 592         for(var i = 0, len = ns.length; i < len; i++){
 593             if(ns[i] == node){
 594                 return i;
 595             }
 596         }
 597         return -1;
 598     }
 599 });