4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
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:
19 var store = new Roo.data.Store(...);
21 var view = new Roo.View({
23 tpl : '<div id="{0}">{2} - {1}</div>', // auto create template
26 selectedClass: "ydataview-selected",
30 // listen for node click?
31 view.on("click", function(vw, index, node, e){
32 alert('Node "' + node.id + '" at index: ' + index + " was clicked.");
36 dataModel.load("foobar.xml");
38 For an example of creating a JSON/UpdateManager view, see {@link Roo.JsonView}.
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>
43 * Note: old style constructor is still suported (container, template, config)
47 * @param {Object} config The config object
50 Roo.View = function(config, depreciated_tpl, depreciated_config){
52 if (typeof(depreciated_tpl) == 'undefined') {
53 // new way.. - universal constructor.
54 Roo.apply(this, config);
55 this.el = Roo.get(this.el);
58 this.el = Roo.get(config);
59 this.tpl = depreciated_tpl;
60 Roo.apply(this, depreciated_config);
62 this.wrapEl = this.el.wrap().wrap();
63 ///this.el = this.wrapEla.appendChild(document.createElement("div"));
66 if(typeof(this.tpl) == "string"){
67 this.tpl = new Roo.Template(this.tpl);
69 // support xtype ctors..
70 this.tpl = new Roo.factory(this.tpl, Roo);
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
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
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
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
113 "contextmenu" : true,
115 * @event selectionchange
116 * Fires when the selected nodes change.
117 * @param {Roo.View} this
118 * @param {Array} selections Array of the selected nodes
120 "selectionchange" : true,
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
129 "beforeselect" : true,
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)
144 "click": this.onClick,
145 "dblclick": this.onDblClick,
146 "contextmenu": this.onContextMenu,
150 this.selections = [];
152 this.cmp = new Roo.CompositeElementLite([]);
154 this.store = Roo.factory(this.store, Roo.data);
155 this.setStore(this.store, true);
158 if ( this.footer && this.footer.xtype) {
160 var fctr = this.wrapEl.appendChild(document.createElement("div"));
162 this.footer.dataSource = this.store
163 this.footer.container = fctr;
164 this.footer = Roo.factory(this.footer, Roo);
165 fctr.insertFirst(this.el);
167 // this is a bit insane - as the paging toolbar seems to detach the el..
168 // dom.parentNode.parentNode.parentNode
169 // they get detached?
173 Roo.View.superclass.constructor.call(this);
178 Roo.extend(Roo.View, Roo.util.Observable, {
181 * @cfg {Roo.data.Store} store Data store to load data from.
186 * @cfg {String|Roo.Element} el The container element.
191 * @cfg {String|Roo.Template} tpl The template used by this View
195 * @cfg {String} dataName the named area of the template to use as the data area
196 * Works with domtemplates roo-name="name"
200 * @cfg {String} selectedClass The css class to add to selected nodes
202 selectedClass : "x-view-selected",
204 * @cfg {String} emptyText The empty text to show when nothing is loaded.
209 * @cfg {String} text to display on mask (default Loading)
213 * @cfg {Boolean} multiSelect Allow multiple selection
217 * @cfg {Boolean} singleSelect Allow single selection
222 * @cfg {Boolean} toggleSelect - selecting
224 toggleSelect : false,
227 * @cfg {Boolean} tickable - selecting
232 * Returns the element this view is bound to.
233 * @return {Roo.Element}
242 * Refreshes the view. - called by datachanged on the store. - do not call directly.
244 refresh : function(){
248 // if we are using something like 'domtemplate', then
249 // the what gets used is:
250 // t.applySubtemplate(NAME, data, wrapping data..)
251 // the outer template then get' applied with
252 // the store 'extra data'
253 // and the body get's added to the
254 // roo-name="data" node?
255 // <span class='roo-tpl-{name}'></span> ?????
259 this.clearSelections();
262 var records = this.store.getRange();
263 if(records.length < 1) {
265 // is this valid?? = should it render a template??
267 this.el.update(this.emptyText);
272 this.el.update(t.apply(this.store.meta)); //????
273 el = this.el.child('.roo-tpl-' + this.dataName);
276 for(var i = 0, len = records.length; i < len; i++){
277 var data = this.prepareData(records[i].data, i, records[i]);
278 this.fireEvent("preparedata", this, data, i, records[i]);
280 var d = Roo.apply({}, data);
283 Roo.apply(d, {'roo-id' : Roo.id()});
285 Roo.log(this.parent);
286 // Roo.each(this.tickItems, function(item){
290 html[html.length] = Roo.util.Format.trim(
292 t.applySubtemplate(this.dataName, d, this.store.meta) :
299 el.update(html.join(""));
300 this.nodes = el.dom.childNodes;
301 this.updateIndexes(0);
306 * Function to override to reformat the data that is sent to
307 * the template for each node.
308 * DEPRICATED - use the preparedata event handler.
309 * @param {Array/Object} data The raw data (array of colData for a data model bound view or
310 * a JSON object for an UpdateManager bound view).
312 prepareData : function(data, index, record)
314 this.fireEvent("preparedata", this, data, index, record);
318 onUpdate : function(ds, record){
319 Roo.log('on update');
320 this.clearSelections();
321 var index = this.store.indexOf(record);
322 var n = this.nodes[index];
323 this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
324 n.parentNode.removeChild(n);
325 this.updateIndexes(index, index);
331 onAdd : function(ds, records, index)
333 Roo.log(['on Add', ds, records, index] );
334 this.clearSelections();
335 if(this.nodes.length == 0){
339 var n = this.nodes[index];
340 for(var i = 0, len = records.length; i < len; i++){
341 var d = this.prepareData(records[i].data, i, records[i]);
343 this.tpl.insertBefore(n, d);
346 this.tpl.append(this.el, d);
349 this.updateIndexes(index);
352 onRemove : function(ds, record, index){
354 this.clearSelections();
355 var el = this.dataName ?
356 this.el.child('.roo-tpl-' + this.dataName) :
359 el.dom.removeChild(this.nodes[index]);
360 this.updateIndexes(index);
364 * Refresh an individual node.
365 * @param {Number} index
367 refreshNode : function(index){
368 this.onUpdate(this.store, this.store.getAt(index));
371 updateIndexes : function(startIndex, endIndex){
373 startIndex = startIndex || 0;
374 endIndex = endIndex || ns.length - 1;
375 for(var i = startIndex; i <= endIndex; i++){
381 * Changes the data store this view uses and refresh the view.
382 * @param {Store} store
384 setStore : function(store, initial){
385 if(!initial && this.store){
386 this.store.un("datachanged", this.refresh);
387 this.store.un("add", this.onAdd);
388 this.store.un("remove", this.onRemove);
389 this.store.un("update", this.onUpdate);
390 this.store.un("clear", this.refresh);
391 this.store.un("beforeload", this.onBeforeLoad);
392 this.store.un("load", this.onLoad);
393 this.store.un("loadexception", this.onLoad);
397 store.on("datachanged", this.refresh, this);
398 store.on("add", this.onAdd, this);
399 store.on("remove", this.onRemove, this);
400 store.on("update", this.onUpdate, this);
401 store.on("clear", this.refresh, this);
402 store.on("beforeload", this.onBeforeLoad, this);
403 store.on("load", this.onLoad, this);
404 store.on("loadexception", this.onLoad, this);
412 * onbeforeLoad - masks the loading area.
415 onBeforeLoad : function(store,opts)
417 Roo.log('onBeforeLoad');
421 this.el.mask(this.mask ? this.mask : "Loading" );
430 * Returns the template node the passed child belongs to or null if it doesn't belong to one.
431 * @param {HTMLElement} node
432 * @return {HTMLElement} The template node
434 findItemFromChild : function(node){
435 var el = this.dataName ?
436 this.el.child('.roo-tpl-' + this.dataName,true) :
439 if(!node || node.parentNode == el){
442 var p = node.parentNode;
444 if(p.parentNode == el){
453 onClick : function(e){
454 var item = this.findItemFromChild(e.getTarget());
456 var index = this.indexOf(item);
457 if(this.onItemClick(item, index, e) !== false){
458 this.fireEvent("click", this, index, item, e);
461 this.clearSelections();
466 onContextMenu : function(e){
467 var item = this.findItemFromChild(e.getTarget());
469 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
474 onDblClick : function(e){
475 var item = this.findItemFromChild(e.getTarget());
477 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
481 onItemClick : function(item, index, e)
483 if(this.fireEvent("beforeclick", this, index, item, e) === false){
486 if (this.toggleSelect) {
487 var m = this.isSelected(item) ? 'unselect' : 'select';
490 _t[m](item, true, false);
493 if(this.multiSelect || this.singleSelect){
494 if(this.multiSelect && e.shiftKey && this.lastSelection){
495 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
497 this.select(item, this.multiSelect && e.ctrlKey);
498 this.lastSelection = item;
510 * Get the number of selected nodes.
513 getSelectionCount : function(){
514 return this.selections.length;
518 * Get the currently selected nodes.
519 * @return {Array} An array of HTMLElements
521 getSelectedNodes : function(){
522 return this.selections;
526 * Get the indexes of the selected nodes.
529 getSelectedIndexes : function(){
530 var indexes = [], s = this.selections;
531 for(var i = 0, len = s.length; i < len; i++){
532 indexes.push(s[i].nodeIndex);
538 * Clear all selections
539 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
541 clearSelections : function(suppressEvent){
542 if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
543 this.cmp.elements = this.selections;
544 this.cmp.removeClass(this.selectedClass);
545 this.selections = [];
547 this.fireEvent("selectionchange", this, this.selections);
553 * Returns true if the passed node is selected
554 * @param {HTMLElement/Number} node The node or node index
557 isSelected : function(node){
558 var s = this.selections;
562 node = this.getNode(node);
563 return s.indexOf(node) !== -1;
568 * @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
569 * @param {Boolean} keepExisting (optional) true to keep existing selections
570 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
572 select : function(nodeInfo, keepExisting, suppressEvent){
573 if(nodeInfo instanceof Array){
575 this.clearSelections(true);
577 for(var i = 0, len = nodeInfo.length; i < len; i++){
578 this.select(nodeInfo[i], true, true);
582 var node = this.getNode(nodeInfo);
583 if(!node || this.isSelected(node)){
584 return; // already selected.
587 this.clearSelections(true);
589 if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
590 Roo.fly(node).addClass(this.selectedClass);
591 this.selections.push(node);
593 this.fireEvent("selectionchange", this, this.selections);
601 * @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
602 * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
603 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
605 unselect : function(nodeInfo, keepExisting, suppressEvent)
607 if(nodeInfo instanceof Array){
608 Roo.each(this.selections, function(s) {
609 this.unselect(s, nodeInfo);
613 var node = this.getNode(nodeInfo);
614 if(!node || !this.isSelected(node)){
615 Roo.log("not selected");
616 return; // not selected.
620 Roo.each(this.selections, function(s) {
622 Roo.fly(node).removeClass(this.selectedClass);
630 this.fireEvent("selectionchange", this, this.selections);
634 * Gets a template node.
635 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
636 * @return {HTMLElement} The node or null if it wasn't found
638 getNode : function(nodeInfo){
639 if(typeof nodeInfo == "string"){
640 return document.getElementById(nodeInfo);
641 }else if(typeof nodeInfo == "number"){
642 return this.nodes[nodeInfo];
648 * Gets a range template nodes.
649 * @param {Number} startIndex
650 * @param {Number} endIndex
651 * @return {Array} An array of nodes
653 getNodes : function(start, end){
656 end = typeof end == "undefined" ? ns.length - 1 : end;
659 for(var i = start; i <= end; i++){
663 for(var i = start; i >= end; i--){
671 * Finds the index of the passed node
672 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
673 * @return {Number} The index of the node or -1
675 indexOf : function(node){
676 node = this.getNode(node);
677 if(typeof node.nodeIndex == "number"){
678 return node.nodeIndex;
681 for(var i = 0, len = ns.length; i < len; i++){