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