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);
83 * Fires before a click is processed. Returns false to cancel the default action.
84 * @param {Roo.View} this
85 * @param {Number} index The index of the target node
86 * @param {HTMLElement} node The target node
87 * @param {Roo.EventObject} e The raw event object
92 * Fires when a template node is clicked.
93 * @param {Roo.View} this
94 * @param {Number} index The index of the target node
95 * @param {HTMLElement} node The target node
96 * @param {Roo.EventObject} e The raw event object
101 * Fires when a template node is double clicked.
102 * @param {Roo.View} this
103 * @param {Number} index The index of the target node
104 * @param {HTMLElement} node The target node
105 * @param {Roo.EventObject} e The raw event object
110 * Fires when a template node is right clicked.
111 * @param {Roo.View} this
112 * @param {Number} index The index of the target node
113 * @param {HTMLElement} node The target node
114 * @param {Roo.EventObject} e The raw event object
116 "contextmenu" : true,
118 * @event selectionchange
119 * Fires when the selected nodes change.
120 * @param {Roo.View} this
121 * @param {Array} selections Array of the selected nodes
123 "selectionchange" : true,
126 * @event beforeselect
127 * Fires before a selection is made. If any handlers return false, the selection is cancelled.
128 * @param {Roo.View} this
129 * @param {HTMLElement} node The node to be selected
130 * @param {Array} selections Array of currently selected nodes
132 "beforeselect" : true,
135 * Fires on every row to render, to allow you to change the data.
136 * @param {Roo.View} this
137 * @param {Object} data to be rendered (change this)
147 "click": this.onClick,
148 "dblclick": this.onDblClick,
149 "contextmenu": this.onContextMenu,
153 this.selections = [];
155 this.cmp = new Roo.CompositeElementLite([]);
157 this.store = Roo.factory(this.store, Roo.data);
158 this.setStore(this.store, true);
161 if ( this.footer && this.footer.xtype) {
163 var fctr = this.wrapEl.appendChild(document.createElement("div"));
165 this.footer.dataSource = this.store
166 this.footer.container = fctr;
167 this.footer = Roo.factory(this.footer, Roo);
168 fctr.insertFirst(this.el);
170 // this is a bit insane - as the paging toolbar seems to detach the el..
171 // dom.parentNode.parentNode.parentNode
172 // they get detached?
176 Roo.View.superclass.constructor.call(this);
181 Roo.extend(Roo.View, Roo.util.Observable, {
184 * @cfg {Roo.data.Store} store Data store to load data from.
189 * @cfg {String|Roo.Element} el The container element.
194 * @cfg {String|Roo.Template} tpl The template used by this View
198 * @cfg {String} dataName the named area of the template to use as the data area
199 * Works with domtemplates roo-name="name"
203 * @cfg {String} selectedClass The css class to add to selected nodes
205 selectedClass : "x-view-selected",
207 * @cfg {String} emptyText The empty text to show when nothing is loaded.
212 * @cfg {String} text to display on mask (default Loading)
216 * @cfg {Boolean} multiSelect Allow multiple selection
220 * @cfg {Boolean} singleSelect Allow single selection
225 * @cfg {Boolean} toggleSelect - selecting
227 toggleSelect : false,
230 * Returns the element this view is bound to.
231 * @return {Roo.Element}
240 * Refreshes the view. - called by datachanged on the store. - do not call directly.
242 refresh : function(){
246 // if we are using something like 'domtemplate', then
247 // the what gets used is:
248 // t.applySubtemplate(NAME, data, wrapping data..)
249 // the outer template then get' applied with
250 // the store 'extra data'
251 // and the body get's added to the
252 // roo-name="data" node?
253 // <span class='roo-tpl-{name}'></span> ?????
257 this.clearSelections();
260 var records = this.store.getRange();
261 if(records.length < 1) {
263 // is this valid?? = should it render a template??
265 this.el.update(this.emptyText);
270 this.el.update(t.apply(this.store.meta)); //????
271 el = this.el.child('.roo-tpl-' + this.dataName);
274 for(var i = 0, len = records.length; i < len; i++){
275 var data = this.prepareData(records[i].data, i, records[i]);
276 this.fireEvent("preparedata", this, data, i, records[i]);
277 html[html.length] = Roo.util.Format.trim(
279 t.applySubtemplate(this.dataName, data, this.store.meta) :
286 el.update(html.join(""));
287 this.nodes = el.dom.childNodes;
288 this.updateIndexes(0);
293 * Function to override to reformat the data that is sent to
294 * the template for each node.
295 * DEPRICATED - use the preparedata event handler.
296 * @param {Array/Object} data The raw data (array of colData for a data model bound view or
297 * a JSON object for an UpdateManager bound view).
299 prepareData : function(data, index, record)
301 this.fireEvent("preparedata", this, data, index, record);
305 onUpdate : function(ds, record){
306 this.clearSelections();
307 var index = this.store.indexOf(record);
308 var n = this.nodes[index];
309 this.tpl.insertBefore(n, this.prepareData(record.data, index, record));
310 n.parentNode.removeChild(n);
311 this.updateIndexes(index, index);
317 onAdd : function(ds, records, index)
320 this.clearSelections();
321 if(this.nodes.length == 0){
325 var n = this.nodes[index];
326 for(var i = 0, len = records.length; i < len; i++){
327 var d = this.prepareData(records[i].data, i, records[i]);
329 this.tpl.insertBefore(n, d);
332 this.tpl.append(this.el, d);
335 this.updateIndexes(index);
338 onRemove : function(ds, record, index){
339 this.clearSelections();
340 var el = this.dataName ?
341 this.el.child('.roo-tpl-' + this.dataName) :
343 el.dom.removeChild(this.nodes[index]);
344 this.updateIndexes(index);
348 * Refresh an individual node.
349 * @param {Number} index
351 refreshNode : function(index){
352 this.onUpdate(this.store, this.store.getAt(index));
355 updateIndexes : function(startIndex, endIndex){
357 startIndex = startIndex || 0;
358 endIndex = endIndex || ns.length - 1;
359 for(var i = startIndex; i <= endIndex; i++){
365 * Changes the data store this view uses and refresh the view.
366 * @param {Store} store
368 setStore : function(store, initial){
369 if(!initial && this.store){
370 this.store.un("datachanged", this.refresh);
371 this.store.un("add", this.onAdd);
372 this.store.un("remove", this.onRemove);
373 this.store.un("update", this.onUpdate);
374 this.store.un("clear", this.refresh);
375 this.store.un("beforeload", this.onBeforeLoad);
376 this.store.un("load", this.onLoad);
377 this.store.un("loadexception", this.onLoad);
381 store.on("datachanged", this.refresh, this);
382 store.on("add", this.onAdd, this);
383 store.on("remove", this.onRemove, this);
384 store.on("update", this.onUpdate, this);
385 store.on("clear", this.refresh, this);
386 store.on("beforeload", this.onBeforeLoad, this);
387 store.on("load", this.onLoad, this);
388 store.on("loadexception", this.onLoad, this);
396 * onbeforeLoad - masks the loading area.
399 onBeforeLoad : function()
402 this.el.mask(this.mask ? this.mask : "Loading" );
411 * Returns the template node the passed child belongs to or null if it doesn't belong to one.
412 * @param {HTMLElement} node
413 * @return {HTMLElement} The template node
415 findItemFromChild : function(node){
416 var el = this.dataName ?
417 this.el.child('.roo-tpl-' + this.dataName,true) :
420 if(!node || node.parentNode == el){
423 var p = node.parentNode;
425 if(p.parentNode == el){
434 onClick : function(e){
435 var item = this.findItemFromChild(e.getTarget());
437 var index = this.indexOf(item);
438 if(this.onItemClick(item, index, e) !== false){
439 this.fireEvent("click", this, index, item, e);
442 this.clearSelections();
447 onContextMenu : function(e){
448 var item = this.findItemFromChild(e.getTarget());
450 this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
455 onDblClick : function(e){
456 var item = this.findItemFromChild(e.getTarget());
458 this.fireEvent("dblclick", this, this.indexOf(item), item, e);
462 onItemClick : function(item, index, e)
464 if(this.fireEvent("beforeclick", this, index, item, e) === false){
467 if (this.toggleSelect) {
468 var m = this.isSelected(item) ? 'unselect' : 'select';
471 _t[m](item, true, false);
474 if(this.multiSelect || this.singleSelect){
475 if(this.multiSelect && e.shiftKey && this.lastSelection){
476 this.select(this.getNodes(this.indexOf(this.lastSelection), index), false);
478 this.select(item, this.multiSelect && e.ctrlKey);
479 this.lastSelection = item;
487 * Get the number of selected nodes.
490 getSelectionCount : function(){
491 return this.selections.length;
495 * Get the currently selected nodes.
496 * @return {Array} An array of HTMLElements
498 getSelectedNodes : function(){
499 return this.selections;
503 * Get the indexes of the selected nodes.
506 getSelectedIndexes : function(){
507 var indexes = [], s = this.selections;
508 for(var i = 0, len = s.length; i < len; i++){
509 indexes.push(s[i].nodeIndex);
515 * Clear all selections
516 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange event
518 clearSelections : function(suppressEvent){
519 if(this.nodes && (this.multiSelect || this.singleSelect) && this.selections.length > 0){
520 this.cmp.elements = this.selections;
521 this.cmp.removeClass(this.selectedClass);
522 this.selections = [];
524 this.fireEvent("selectionchange", this, this.selections);
530 * Returns true if the passed node is selected
531 * @param {HTMLElement/Number} node The node or node index
534 isSelected : function(node){
535 var s = this.selections;
539 node = this.getNode(node);
540 return s.indexOf(node) !== -1;
545 * @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
546 * @param {Boolean} keepExisting (optional) true to keep existing selections
547 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
549 select : function(nodeInfo, keepExisting, suppressEvent){
550 if(nodeInfo instanceof Array){
552 this.clearSelections(true);
554 for(var i = 0, len = nodeInfo.length; i < len; i++){
555 this.select(nodeInfo[i], true, true);
559 var node = this.getNode(nodeInfo);
560 if(!node || this.isSelected(node)){
561 return; // already selected.
564 this.clearSelections(true);
566 if(this.fireEvent("beforeselect", this, node, this.selections) !== false){
567 Roo.fly(node).addClass(this.selectedClass);
568 this.selections.push(node);
570 this.fireEvent("selectionchange", this, this.selections);
578 * @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
579 * @param {Boolean} keepExisting (optional) true IGNORED (for campatibility with select)
580 * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
582 unselect : function(nodeInfo, keepExisting, suppressEvent)
584 if(nodeInfo instanceof Array){
585 Roo.each(this.selections, function(s) {
586 this.unselect(s, nodeInfo);
590 var node = this.getNode(nodeInfo);
591 if(!node || !this.isSelected(node)){
592 Roo.log("not selected");
593 return; // not selected.
597 Roo.each(this.selections, function(s) {
599 Roo.fly(node).removeClass(this.selectedClass);
607 this.fireEvent("selectionchange", this, this.selections);
611 * Gets a template node.
612 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
613 * @return {HTMLElement} The node or null if it wasn't found
615 getNode : function(nodeInfo){
616 if(typeof nodeInfo == "string"){
617 return document.getElementById(nodeInfo);
618 }else if(typeof nodeInfo == "number"){
619 return this.nodes[nodeInfo];
625 * Gets a range template nodes.
626 * @param {Number} startIndex
627 * @param {Number} endIndex
628 * @return {Array} An array of nodes
630 getNodes : function(start, end){
633 end = typeof end == "undefined" ? ns.length - 1 : end;
636 for(var i = start; i <= end; i++){
640 for(var i = start; i >= end; i--){
648 * Finds the index of the passed node
649 * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
650 * @return {Number} The index of the node or -1
652 indexOf : function(node){
653 node = this.getNode(node);
654 if(typeof node.nodeIndex == "number"){
655 return node.nodeIndex;
658 for(var i = 0, len = ns.length; i < len; i++){