source: trunk/web/addons/job_monarch/lib/extjs-30/pkgs/data-list-views-debug.js @ 647

Last change on this file since 647 was 625, checked in by ramonb, 15 years ago

lib/extjs-30:

  • new ExtJS 3.0
File size: 44.1 KB
Line 
1/*!
2 * Ext JS Library 3.0.0
3 * Copyright(c) 2006-2009 Ext JS, LLC
4 * licensing@extjs.com
5 * http://www.extjs.com/license
6 */
7/**
8 * @class Ext.DataView
9 * @extends Ext.BoxComponent
10 * A mechanism for displaying data using custom layout templates and formatting. DataView uses an {@link Ext.XTemplate}
11 * as its internal templating mechanism, and is bound to an {@link Ext.data.Store}
12 * so that as the data in the store changes the view is automatically updated to reflect the changes.  The view also
13 * provides built-in behavior for many common events that can occur for its contained items including click, doubleclick,
14 * mouseover, mouseout, etc. as well as a built-in selection model. <b>In order to use these features, an {@link #itemSelector}
15 * config must be provided for the DataView to determine what nodes it will be working with.</b>
16 *
17 * <p>The example below binds a DataView to a {@link Ext.data.Store} and renders it into an {@link Ext.Panel}.</p>
18 * <pre><code>
19var store = new Ext.data.JsonStore({
20    url: 'get-images.php',
21    root: 'images',
22    fields: [
23        'name', 'url',
24        {name:'size', type: 'float'},
25        {name:'lastmod', type:'date', dateFormat:'timestamp'}
26    ]
27});
28store.load();
29
30var tpl = new Ext.XTemplate(
31    '&lt;tpl for="."&gt;',
32        '&lt;div class="thumb-wrap" id="{name}"&gt;',
33        '&lt;div class="thumb"&gt;&lt;img src="{url}" title="{name}"&gt;&lt;/div&gt;',
34        '&lt;span class="x-editable"&gt;{shortName}&lt;/span&gt;&lt;/div&gt;',
35    '&lt;/tpl&gt;',
36    '&lt;div class="x-clear"&gt;&lt;/div&gt;'
37);
38
39var panel = new Ext.Panel({
40    id:'images-view',
41    frame:true,
42    width:535,
43    autoHeight:true,
44    collapsible:true,
45    layout:'fit',
46    title:'Simple DataView',
47
48    items: new Ext.DataView({
49        store: store,
50        tpl: tpl,
51        autoHeight:true,
52        multiSelect: true,
53        overClass:'x-view-over',
54        itemSelector:'div.thumb-wrap',
55        emptyText: 'No images to display'
56    })
57});
58panel.render(document.body);
59</code></pre>
60 * @constructor
61 * Create a new DataView
62 * @param {Object} config The config object
63 * @xtype dataview
64 */
65Ext.DataView = Ext.extend(Ext.BoxComponent, {
66    /**
67     * @cfg {String/Array} tpl
68     * The HTML fragment or an array of fragments that will make up the template used by this DataView.  This should
69     * be specified in the same format expected by the constructor of {@link Ext.XTemplate}.
70     */
71    /**
72     * @cfg {Ext.data.Store} store
73     * The {@link Ext.data.Store} to bind this DataView to.
74     */
75    /**
76     * @cfg {String} itemSelector
77     * <b>This is a required setting</b>. A simple CSS selector (e.g. <tt>div.some-class</tt> or
78     * <tt>span:first-child</tt>) that will be used to determine what nodes this DataView will be
79     * working with.
80     */
81    /**
82     * @cfg {Boolean} multiSelect
83     * True to allow selection of more than one item at a time, false to allow selection of only a single item
84     * at a time or no selection at all, depending on the value of {@link #singleSelect} (defaults to false).
85     */
86    /**
87     * @cfg {Boolean} singleSelect
88     * True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false).
89     * Note that if {@link #multiSelect} = true, this value will be ignored.
90     */
91    /**
92     * @cfg {Boolean} simpleSelect
93     * True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl,
94     * false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
95     */
96    /**
97     * @cfg {String} overClass
98     * A CSS class to apply to each item in the view on mouseover (defaults to undefined).
99     */
100    /**
101     * @cfg {String} loadingText
102     * A string to display during data load operations (defaults to undefined).  If specified, this text will be
103     * displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's
104     * contents will continue to display normally until the new data is loaded and the contents are replaced.
105     */
106    /**
107     * @cfg {String} selectedClass
108     * A CSS class to apply to each selected item in the view (defaults to 'x-view-selected').
109     */
110    selectedClass : "x-view-selected",
111    /**
112     * @cfg {String} emptyText
113     * The text to display in the view when there is no data to display (defaults to '').
114     */
115    emptyText : "",
116
117    /**
118     * @cfg {Boolean} deferEmptyText True to defer emptyText being applied until the store's first load
119     */
120    deferEmptyText: true,
121    /**
122     * @cfg {Boolean} trackOver True to enable mouseenter and mouseleave events
123     */
124    trackOver: false,
125
126    //private
127    last: false,
128
129    // private
130    initComponent : function(){
131        Ext.DataView.superclass.initComponent.call(this);
132        if(Ext.isString(this.tpl) || Ext.isArray(this.tpl)){
133            this.tpl = new Ext.XTemplate(this.tpl);
134        }
135
136        this.addEvents(
137            /**
138             * @event beforeclick
139             * Fires before a click is processed. Returns false to cancel the default action.
140             * @param {Ext.DataView} this
141             * @param {Number} index The index of the target node
142             * @param {HTMLElement} node The target node
143             * @param {Ext.EventObject} e The raw event object
144             */
145            "beforeclick",
146            /**
147             * @event click
148             * Fires when a template node is clicked.
149             * @param {Ext.DataView} this
150             * @param {Number} index The index of the target node
151             * @param {HTMLElement} node The target node
152             * @param {Ext.EventObject} e The raw event object
153             */
154            "click",
155            /**
156             * @event mouseenter
157             * Fires when the mouse enters a template node. trackOver:true or an overCls must be set to enable this event.
158             * @param {Ext.DataView} this
159             * @param {Number} index The index of the target node
160             * @param {HTMLElement} node The target node
161             * @param {Ext.EventObject} e The raw event object
162             */
163            "mouseenter",
164            /**
165             * @event mouseleave
166             * Fires when the mouse leaves a template node. trackOver:true or an overCls must be set to enable this event.
167             * @param {Ext.DataView} this
168             * @param {Number} index The index of the target node
169             * @param {HTMLElement} node The target node
170             * @param {Ext.EventObject} e The raw event object
171             */
172            "mouseleave",
173            /**
174             * @event containerclick
175             * Fires when a click occurs and it is not on a template node.
176             * @param {Ext.DataView} this
177             * @param {Ext.EventObject} e The raw event object
178             */
179            "containerclick",
180            /**
181             * @event dblclick
182             * Fires when a template node is double clicked.
183             * @param {Ext.DataView} this
184             * @param {Number} index The index of the target node
185             * @param {HTMLElement} node The target node
186             * @param {Ext.EventObject} e The raw event object
187             */
188            "dblclick",
189            /**
190             * @event contextmenu
191             * Fires when a template node is right clicked.
192             * @param {Ext.DataView} this
193             * @param {Number} index The index of the target node
194             * @param {HTMLElement} node The target node
195             * @param {Ext.EventObject} e The raw event object
196             */
197            "contextmenu",
198            /**
199             * @event containercontextmenu
200             * Fires when a right click occurs that is not on a template node.
201             * @param {Ext.DataView} this
202             * @param {Ext.EventObject} e The raw event object
203             */
204            "containercontextmenu",
205            /**
206             * @event selectionchange
207             * Fires when the selected nodes change.
208             * @param {Ext.DataView} this
209             * @param {Array} selections Array of the selected nodes
210             */
211            "selectionchange",
212
213            /**
214             * @event beforeselect
215             * Fires before a selection is made. If any handlers return false, the selection is cancelled.
216             * @param {Ext.DataView} this
217             * @param {HTMLElement} node The node to be selected
218             * @param {Array} selections Array of currently selected nodes
219             */
220            "beforeselect"
221        );
222
223        this.store = Ext.StoreMgr.lookup(this.store);
224        this.all = new Ext.CompositeElementLite();
225        this.selected = new Ext.CompositeElementLite();
226    },
227
228    // private
229    afterRender : function(){
230        Ext.DataView.superclass.afterRender.call(this);
231
232                this.mon(this.getTemplateTarget(), {
233            "click": this.onClick,
234            "dblclick": this.onDblClick,
235            "contextmenu": this.onContextMenu,
236            scope:this
237        });
238
239        if(this.overClass || this.trackOver){
240            this.mon(this.getTemplateTarget(), {
241                "mouseover": this.onMouseOver,
242                "mouseout": this.onMouseOut,
243                scope:this
244            });
245        }
246
247        if(this.store){
248            this.bindStore(this.store, true);
249        }
250    },
251
252    /**
253     * Refreshes the view by reloading the data from the store and re-rendering the template.
254     */
255    refresh : function(){
256        this.clearSelections(false, true);
257        var el = this.getTemplateTarget();
258        el.update("");
259        var records = this.store.getRange();
260        if(records.length < 1){
261            if(!this.deferEmptyText || this.hasSkippedEmptyText){
262                el.update(this.emptyText);
263            }
264            this.all.clear();
265        }else{
266            this.tpl.overwrite(el, this.collectData(records, 0));
267            this.all.fill(Ext.query(this.itemSelector, el.dom));
268            this.updateIndexes(0);
269        }
270        this.hasSkippedEmptyText = true;
271    },
272
273    getTemplateTarget: function(){
274        return this.el;
275    },
276
277    /**
278     * Function which can be overridden to provide custom formatting for each Record that is used by this
279     * DataView's {@link #tpl template} to render each node.
280     * @param {Array/Object} data The raw data object that was used to create the Record.
281     * @param {Number} recordIndex the index number of the Record being prepared for rendering.
282     * @param {Record} record The Record being prepared for rendering.
283     * @return {Array/Object} The formatted data in a format expected by the internal {@link #tpl template}'s overwrite() method.
284     * (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))
285     */
286    prepareData : function(data){
287        return data;
288    },
289
290    /**
291     * <p>Function which can be overridden which returns the data object passed to this
292     * DataView's {@link #tpl template} to render the whole DataView.</p>
293     * <p>This is usually an Array of data objects, each element of which is processed by an
294     * {@link Ext.XTemplate XTemplate} which uses <tt>'&lt;tpl for="."&gt;'</tt> to iterate over its supplied
295     * data object as an Array. However, <i>named</i> properties may be placed into the data object to
296     * provide non-repeating data such as headings, totals etc.</p>
297     * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
298     * @param {Number} startIndex the index number of the Record being prepared for rendering.
299     * @return {Array} An Array of data objects to be processed by a repeating XTemplate. May also
300     * contain <i>named</i> properties.
301     */
302    collectData : function(records, startIndex){
303        var r = [];
304        for(var i = 0, len = records.length; i < len; i++){
305            r[r.length] = this.prepareData(records[i].data, startIndex+i, records[i]);
306        }
307        return r;
308    },
309
310    // private
311    bufferRender : function(records){
312        var div = document.createElement('div');
313        this.tpl.overwrite(div, this.collectData(records));
314        return Ext.query(this.itemSelector, div);
315    },
316
317    // private
318    onUpdate : function(ds, record){
319        var index = this.store.indexOf(record);
320        var sel = this.isSelected(index);
321        var original = this.all.elements[index];
322        var node = this.bufferRender([record], index)[0];
323
324        this.all.replaceElement(index, node, true);
325        if(sel){
326            this.selected.replaceElement(original, node);
327            this.all.item(index).addClass(this.selectedClass);
328        }
329        this.updateIndexes(index, index);
330    },
331
332    // private
333    onAdd : function(ds, records, index){
334        if(this.all.getCount() === 0){
335            this.refresh();
336            return;
337        }
338        var nodes = this.bufferRender(records, index), n, a = this.all.elements;
339        if(index < this.all.getCount()){
340            n = this.all.item(index).insertSibling(nodes, 'before', true);
341            a.splice.apply(a, [index, 0].concat(nodes));
342        }else{
343            n = this.all.last().insertSibling(nodes, 'after', true);
344            a.push.apply(a, nodes);
345        }
346        this.updateIndexes(index);
347    },
348
349    // private
350    onRemove : function(ds, record, index){
351        this.deselect(index);
352        this.all.removeElement(index, true);
353        this.updateIndexes(index);
354        if (this.store.getCount() === 0){
355            this.refresh();
356        }
357    },
358
359    /**
360     * Refreshes an individual node's data from the store.
361     * @param {Number} index The item's data index in the store
362     */
363    refreshNode : function(index){
364        this.onUpdate(this.store, this.store.getAt(index));
365    },
366
367    // private
368    updateIndexes : function(startIndex, endIndex){
369        var ns = this.all.elements;
370        startIndex = startIndex || 0;
371        endIndex = endIndex || ((endIndex === 0) ? 0 : (ns.length - 1));
372        for(var i = startIndex; i <= endIndex; i++){
373            ns[i].viewIndex = i;
374        }
375    },
376   
377    /**
378     * Returns the store associated with this DataView.
379     * @return {Ext.data.Store} The store
380     */
381    getStore : function(){
382        return this.store;
383    },
384
385    /**
386     * Changes the data store bound to this view and refreshes it.
387     * @param {Store} store The store to bind to this view
388     */
389    bindStore : function(store, initial){
390        if(!initial && this.store){
391            this.store.un("beforeload", this.onBeforeLoad, this);
392            this.store.un("datachanged", this.refresh, this);
393            this.store.un("add", this.onAdd, this);
394            this.store.un("remove", this.onRemove, this);
395            this.store.un("update", this.onUpdate, this);
396            this.store.un("clear", this.refresh, this);
397            if(store !== this.store && this.store.autoDestroy){
398                this.store.destroy();
399            }
400        }
401        if(store){
402            store = Ext.StoreMgr.lookup(store);
403            store.on({
404                scope: this,
405                beforeload: this.onBeforeLoad,
406                datachanged: this.refresh,
407                add: this.onAdd,
408                remove: this.onRemove,
409                update: this.onUpdate,
410                clear: this.refresh
411            });
412        }
413        this.store = store;
414        if(store){
415            this.refresh();
416        }
417    },
418
419    /**
420     * Returns the template node the passed child belongs to, or null if it doesn't belong to one.
421     * @param {HTMLElement} node
422     * @return {HTMLElement} The template node
423     */
424    findItemFromChild : function(node){
425        return Ext.fly(node).findParent(this.itemSelector, this.getTemplateTarget());
426    },
427
428    // private
429    onClick : function(e){
430        var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
431        if(item){
432            var index = this.indexOf(item);
433            if(this.onItemClick(item, index, e) !== false){
434                this.fireEvent("click", this, index, item, e);
435            }
436        }else{
437            if(this.fireEvent("containerclick", this, e) !== false){
438                this.onContainerClick(e);
439            }
440        }
441    },
442
443    onContainerClick : function(e){
444        this.clearSelections();
445    },
446
447    // private
448    onContextMenu : function(e){
449        var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
450        if(item){
451            this.fireEvent("contextmenu", this, this.indexOf(item), item, e);
452        }else{
453            this.fireEvent("containercontextmenu", this, e);
454        }
455    },
456
457    // private
458    onDblClick : function(e){
459        var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
460        if(item){
461            this.fireEvent("dblclick", this, this.indexOf(item), item, e);
462        }
463    },
464
465    // private
466    onMouseOver : function(e){
467        var item = e.getTarget(this.itemSelector, this.getTemplateTarget());
468        if(item && item !== this.lastItem){
469            this.lastItem = item;
470            Ext.fly(item).addClass(this.overClass);
471            this.fireEvent("mouseenter", this, this.indexOf(item), item, e);
472        }
473    },
474
475    // private
476    onMouseOut : function(e){
477        if(this.lastItem){
478            if(!e.within(this.lastItem, true, true)){
479                Ext.fly(this.lastItem).removeClass(this.overClass);
480                this.fireEvent("mouseleave", this, this.indexOf(this.lastItem), this.lastItem, e);
481                delete this.lastItem;
482            }
483        }
484    },
485
486    // private
487    onItemClick : function(item, index, e){
488        if(this.fireEvent("beforeclick", this, index, item, e) === false){
489            return false;
490        }
491        if(this.multiSelect){
492            this.doMultiSelection(item, index, e);
493            e.preventDefault();
494        }else if(this.singleSelect){
495            this.doSingleSelection(item, index, e);
496            e.preventDefault();
497        }
498        return true;
499    },
500
501    // private
502    doSingleSelection : function(item, index, e){
503        if(e.ctrlKey && this.isSelected(index)){
504            this.deselect(index);
505        }else{
506            this.select(index, false);
507        }
508    },
509
510    // private
511    doMultiSelection : function(item, index, e){
512        if(e.shiftKey && this.last !== false){
513            var last = this.last;
514            this.selectRange(last, index, e.ctrlKey);
515            this.last = last; // reset the last
516        }else{
517            if((e.ctrlKey||this.simpleSelect) && this.isSelected(index)){
518                this.deselect(index);
519            }else{
520                this.select(index, e.ctrlKey || e.shiftKey || this.simpleSelect);
521            }
522        }
523    },
524
525    /**
526     * Gets the number of selected nodes.
527     * @return {Number} The node count
528     */
529    getSelectionCount : function(){
530        return this.selected.getCount();
531    },
532
533    /**
534     * Gets the currently selected nodes.
535     * @return {Array} An array of HTMLElements
536     */
537    getSelectedNodes : function(){
538        return this.selected.elements;
539    },
540
541    /**
542     * Gets the indexes of the selected nodes.
543     * @return {Array} An array of numeric indexes
544     */
545    getSelectedIndexes : function(){
546        var indexes = [], s = this.selected.elements;
547        for(var i = 0, len = s.length; i < len; i++){
548            indexes.push(s[i].viewIndex);
549        }
550        return indexes;
551    },
552
553    /**
554     * Gets an array of the selected records
555     * @return {Array} An array of {@link Ext.data.Record} objects
556     */
557    getSelectedRecords : function(){
558        var r = [], s = this.selected.elements;
559        for(var i = 0, len = s.length; i < len; i++){
560            r[r.length] = this.store.getAt(s[i].viewIndex);
561        }
562        return r;
563    },
564
565    /**
566     * Gets an array of the records from an array of nodes
567     * @param {Array} nodes The nodes to evaluate
568     * @return {Array} records The {@link Ext.data.Record} objects
569     */
570    getRecords : function(nodes){
571        var r = [], s = nodes;
572        for(var i = 0, len = s.length; i < len; i++){
573            r[r.length] = this.store.getAt(s[i].viewIndex);
574        }
575        return r;
576    },
577
578    /**
579     * Gets a record from a node
580     * @param {HTMLElement} node The node to evaluate
581     * @return {Record} record The {@link Ext.data.Record} object
582     */
583    getRecord : function(node){
584        return this.store.getAt(node.viewIndex);
585    },
586
587    /**
588     * Clears all selections.
589     * @param {Boolean} suppressEvent (optional) True to skip firing of the selectionchange event
590     */
591    clearSelections : function(suppressEvent, skipUpdate){
592        if((this.multiSelect || this.singleSelect) && this.selected.getCount() > 0){
593            if(!skipUpdate){
594                this.selected.removeClass(this.selectedClass);
595            }
596            this.selected.clear();
597            this.last = false;
598            if(!suppressEvent){
599                this.fireEvent("selectionchange", this, this.selected.elements);
600            }
601        }
602    },
603
604    /**
605     * Returns true if the passed node is selected, else false.
606     * @param {HTMLElement/Number} node The node or node index to check
607     * @return {Boolean} True if selected, else false
608     */
609    isSelected : function(node){
610        return this.selected.contains(this.getNode(node));
611    },
612
613    /**
614     * Deselects a node.
615     * @param {HTMLElement/Number} node The node to deselect
616     */
617    deselect : function(node){
618        if(this.isSelected(node)){
619            node = this.getNode(node);
620            this.selected.removeElement(node);
621            if(this.last == node.viewIndex){
622                this.last = false;
623            }
624            Ext.fly(node).removeClass(this.selectedClass);
625            this.fireEvent("selectionchange", this, this.selected.elements);
626        }
627    },
628
629    /**
630     * Selects a set of nodes.
631     * @param {Array/HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node,
632     * id of a template node or an array of any of those to select
633     * @param {Boolean} keepExisting (optional) true to keep existing selections
634     * @param {Boolean} suppressEvent (optional) true to skip firing of the selectionchange vent
635     */
636    select : function(nodeInfo, keepExisting, suppressEvent){
637        if(Ext.isArray(nodeInfo)){
638            if(!keepExisting){
639                this.clearSelections(true);
640            }
641            for(var i = 0, len = nodeInfo.length; i < len; i++){
642                this.select(nodeInfo[i], true, true);
643            }
644            if(!suppressEvent){
645                this.fireEvent("selectionchange", this, this.selected.elements);
646            }
647        } else{
648            var node = this.getNode(nodeInfo);
649            if(!keepExisting){
650                this.clearSelections(true);
651            }
652            if(node && !this.isSelected(node)){
653                if(this.fireEvent("beforeselect", this, node, this.selected.elements) !== false){
654                    Ext.fly(node).addClass(this.selectedClass);
655                    this.selected.add(node);
656                    this.last = node.viewIndex;
657                    if(!suppressEvent){
658                        this.fireEvent("selectionchange", this, this.selected.elements);
659                    }
660                }
661            }
662        }
663    },
664
665    /**
666     * Selects a range of nodes. All nodes between start and end are selected.
667     * @param {Number} start The index of the first node in the range
668     * @param {Number} end The index of the last node in the range
669     * @param {Boolean} keepExisting (optional) True to retain existing selections
670     */
671    selectRange : function(start, end, keepExisting){
672        if(!keepExisting){
673            this.clearSelections(true);
674        }
675        this.select(this.getNodes(start, end), true);
676    },
677
678    /**
679     * Gets a template node.
680     * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
681     * @return {HTMLElement} The node or null if it wasn't found
682     */
683    getNode : function(nodeInfo){
684        if(Ext.isString(nodeInfo)){
685            return document.getElementById(nodeInfo);
686        }else if(Ext.isNumber(nodeInfo)){
687            return this.all.elements[nodeInfo];
688        }
689        return nodeInfo;
690    },
691
692    /**
693     * Gets a range nodes.
694     * @param {Number} start (optional) The index of the first node in the range
695     * @param {Number} end (optional) The index of the last node in the range
696     * @return {Array} An array of nodes
697     */
698    getNodes : function(start, end){
699        var ns = this.all.elements;
700        start = start || 0;
701        end = !Ext.isDefined(end) ? Math.max(ns.length - 1, 0) : end;
702        var nodes = [], i;
703        if(start <= end){
704            for(i = start; i <= end && ns[i]; i++){
705                nodes.push(ns[i]);
706            }
707        } else{
708            for(i = start; i >= end && ns[i]; i--){
709                nodes.push(ns[i]);
710            }
711        }
712        return nodes;
713    },
714
715    /**
716     * Finds the index of the passed node.
717     * @param {HTMLElement/String/Number} nodeInfo An HTMLElement template node, index of a template node or the id of a template node
718     * @return {Number} The index of the node or -1
719     */
720    indexOf : function(node){
721        node = this.getNode(node);
722        if(Ext.isNumber(node.viewIndex)){
723            return node.viewIndex;
724        }
725        return this.all.indexOf(node);
726    },
727
728    // private
729    onBeforeLoad : function(){
730        if(this.loadingText){
731            this.clearSelections(false, true);
732            this.getTemplateTarget().update('<div class="loading-indicator">'+this.loadingText+'</div>');
733            this.all.clear();
734        }
735    },
736
737    onDestroy : function(){
738        Ext.DataView.superclass.onDestroy.call(this);
739        this.bindStore(null);
740    }
741});
742
743/**
744 * Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)
745 * @param {Store} store The store to bind to this view
746 */
747Ext.DataView.prototype.setStore = Ext.DataView.prototype.bindStore;
748
749Ext.reg('dataview', Ext.DataView);/**
750 * @class Ext.ListView
751 * @extends Ext.DataView
752 * <p>Ext.ListView is a fast and light-weight implentation of a
753 * {@link Ext.grid.GridPanel Grid} like view with the following characteristics:</p>
754 * <div class="mdetail-params"><ul>
755 * <li>resizable columns</li>
756 * <li>selectable</li>
757 * <li>column widths are initially proportioned by percentage based on the container
758 * width and number of columns</li>
759 * <li>uses templates to render the data in any required format</li>
760 * <li>no horizontal scrolling</li>
761 * <li>no editing</li>
762 * </ul></div>
763 * <p>Example usage:</p>
764 * <pre><code>
765// consume JSON of this form:
766{
767   "images":[
768      {
769         "name":"dance_fever.jpg",
770         "size":2067,
771         "lastmod":1236974993000,
772         "url":"images\/thumbs\/dance_fever.jpg"
773      },
774      {
775         "name":"zack_sink.jpg",
776         "size":2303,
777         "lastmod":1236974993000,
778         "url":"images\/thumbs\/zack_sink.jpg"
779      }
780   ]
781}
782var store = new Ext.data.JsonStore({
783    url: 'get-images.php',
784    root: 'images',
785    fields: [
786        'name', 'url',
787        {name:'size', type: 'float'},
788        {name:'lastmod', type:'date', dateFormat:'timestamp'}
789    ]
790});
791store.load();
792
793var listView = new Ext.ListView({
794    store: store,
795    multiSelect: true,
796    emptyText: 'No images to display',
797    reserveScrollOffset: true,
798    columns: [{
799        header: 'File',
800        width: .5,
801        dataIndex: 'name'
802    },{
803        header: 'Last Modified',
804        width: .35,
805        dataIndex: 'lastmod',
806        tpl: '{lastmod:date("m-d h:i a")}'
807    },{
808        header: 'Size',
809        dataIndex: 'size',
810        tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
811        align: 'right'
812    }]
813});
814
815// put it in a Panel so it looks pretty
816var panel = new Ext.Panel({
817    id:'images-view',
818    width:425,
819    height:250,
820    collapsible:true,
821    layout:'fit',
822    title:'Simple ListView <i>(0 items selected)</i>',
823    items: listView
824});
825panel.render(document.body);
826
827// little bit of feedback
828listView.on('selectionchange', function(view, nodes){
829    var l = nodes.length;
830    var s = l != 1 ? 's' : '';
831    panel.setTitle('Simple ListView <i>('+l+' item'+s+' selected)</i>');
832});
833 * </code></pre>
834 * @constructor
835 * @param {Object} config
836 * @xtype listview
837 */
838Ext.ListView = Ext.extend(Ext.DataView, {
839    /**
840     * Set this property to <tt>true</tt> to disable the header click handler disabling sort
841     * (defaults to <tt>false</tt>).
842     * @type Boolean
843     * @property disableHeaders
844     */
845    /**
846     * @cfg {Boolean} hideHeaders
847     * <tt>true</tt> to hide the {@link #internalTpl header row} (defaults to <tt>false</tt> so
848     * the {@link #internalTpl header row} will be shown).
849     */
850    /**
851     * @cfg {String} itemSelector
852     * Defaults to <tt>'dl'</tt> to work with the preconfigured <b><tt>{@link Ext.DataView#tpl tpl}</tt></b>.
853     * This setting specifies the CSS selector (e.g. <tt>div.some-class</tt> or <tt>span:first-child</tt>)
854     * that will be used to determine what nodes the ListView will be working with.   
855     */
856    itemSelector: 'dl',
857    /**
858     * @cfg {String} selectedClass The CSS class applied to a selected row (defaults to
859     * <tt>'x-list-selected'</tt>). An example overriding the default styling:
860    <pre><code>
861    .x-list-selected {background-color: yellow;}
862    </code></pre>
863     * @type String
864     */
865    selectedClass:'x-list-selected',
866    /**
867     * @cfg {String} overClass The CSS class applied when over a row (defaults to
868     * <tt>'x-list-over'</tt>). An example overriding the default styling:
869    <pre><code>
870    .x-list-over {background-color: orange;}
871    </code></pre>
872     * @type String
873     */
874    overClass:'x-list-over',
875    /**
876     * @cfg {Boolean} reserveScrollOffset
877     * By default will defer accounting for the configured <b><tt>{@link #scrollOffset}</tt></b>
878     * for 10 milliseconds.  Specify <tt>true</tt> to account for the configured
879     * <b><tt>{@link #scrollOffset}</tt></b> immediately.
880     */
881    /**
882     * @cfg {Number} scrollOffset The amount of space to reserve for the scrollbar (defaults to
883     * <tt>19</tt> pixels)
884     */
885    scrollOffset : 19,
886    /**
887     * @cfg {Boolean/Object} columnResize
888     * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.ColumnResizer}
889     * to enable the columns to be resizable (defaults to <tt>true</tt>).
890     */
891    columnResize: true,
892    /**
893     * @cfg {Array} columns An array of column configuration objects, for example:
894     * <pre><code>
895{
896    align: 'right',
897    dataIndex: 'size',
898    header: 'Size',
899    tpl: '{size:fileSize}',
900    width: .35
901}
902     * </code></pre>
903     * Acceptable properties for each column configuration object are:
904     * <div class="mdetail-params"><ul>
905     * <li><b><tt>align</tt></b> : String<div class="sub-desc">Set the CSS text-align property
906     * of the column. Defaults to <tt>'left'</tt>.</div></li>
907     * <li><b><tt>dataIndex</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
908     * {@link Ext.grid.Column#dataIndex dataIndex} for details.</div></li>
909     * <li><b><tt>header</tt></b> : String<div class="sub-desc">See {@link Ext.grid.Column}.
910     * {@link Ext.grid.Column#header header} for details.</div></li>
911     * <li><b><tt>tpl</tt></b> : String<div class="sub-desc">Specify a string to pass as the
912     * configuration string for {@link Ext.XTemplate}.  By default an {@link Ext.XTemplate}
913     * will be implicitly created using the <tt>dataIndex</tt>.</div></li>
914     * <li><b><tt>width</tt></b> : Number<div class="sub-desc">Percentage of the container width
915     * this column should be allocated.  Columns that have no width specified will be
916     * allocated with an equal percentage to fill 100% of the container width.  To easily take
917     * advantage of the full container width, leave the width of at least one column undefined.
918     * Note that if you do not want to take up the full width of the container, the width of
919     * every column needs to be explicitly defined.</div></li>
920     * </ul></div>
921     */
922    /**
923     * @cfg {Boolean/Object} columnSort
924     * Specify <tt>true</tt> or specify a configuration object for {@link Ext.ListView.Sorter}
925     * to enable the columns to be sortable (defaults to <tt>true</tt>).
926     */
927    columnSort: true,
928    /**
929     * @cfg {String/Array} internalTpl
930     * The template to be used for the header row.  See {@link #tpl} for more details.
931     */
932
933    initComponent : function(){
934        if(this.columnResize){
935            this.colResizer = new Ext.ListView.ColumnResizer(this.colResizer);
936            this.colResizer.init(this);
937        }
938        if(this.columnSort){
939            this.colSorter = new Ext.ListView.Sorter(this.columnSort);
940            this.colSorter.init(this);
941        }
942        if(!this.internalTpl){
943            this.internalTpl = new Ext.XTemplate(
944                '<div class="x-list-header"><div class="x-list-header-inner">',
945                    '<tpl for="columns">',
946                    '<div style="width:{width}%;text-align:{align};"><em unselectable="on" id="',this.id, '-xlhd-{#}">',
947                        '{header}',
948                    '</em></div>',
949                    '</tpl>',
950                    '<div class="x-clear"></div>',
951                '</div></div>',
952                '<div class="x-list-body"><div class="x-list-body-inner">',
953                '</div></div>'
954            );
955        }
956        if(!this.tpl){
957            this.tpl = new Ext.XTemplate(
958                '<tpl for="rows">',
959                    '<dl>',
960                        '<tpl for="parent.columns">',
961                        '<dt style="width:{width}%;text-align:{align};"><em unselectable="on">',
962                            '{[values.tpl.apply(parent)]}',
963                        '</em></dt>',
964                        '</tpl>',
965                        '<div class="x-clear"></div>',
966                    '</dl>',
967                '</tpl>'
968            );
969        };
970        var cs = this.columns, allocatedWidth = 0, colsWithWidth = 0, len = cs.length;
971        for(var i = 0; i < len; i++){
972            var c = cs[i];
973            if(!c.tpl){
974                c.tpl = new Ext.XTemplate('{' + c.dataIndex + '}');
975            }else if(Ext.isString(c.tpl)){
976                c.tpl = new Ext.XTemplate(c.tpl);
977            }
978            c.align = c.align || 'left';
979            if(Ext.isNumber(c.width)){
980                c.width *= 100;
981                allocatedWidth += c.width;
982                colsWithWidth++;
983            }
984        }
985        // auto calculate missing column widths
986        if(colsWithWidth < len){
987            var remaining = len - colsWithWidth;
988            if(allocatedWidth < 100){
989                var perCol = ((100-allocatedWidth) / remaining);
990                for(var j = 0; j < len; j++){
991                    var c = cs[j];
992                    if(!Ext.isNumber(c.width)){
993                        c.width = perCol;
994                    }
995                }
996            }
997        }
998        Ext.ListView.superclass.initComponent.call(this);
999    },
1000
1001    onRender : function(){
1002        Ext.ListView.superclass.onRender.apply(this, arguments);
1003
1004        this.internalTpl.overwrite(this.el, {columns: this.columns});
1005       
1006        this.innerBody = Ext.get(this.el.dom.childNodes[1].firstChild);
1007        this.innerHd = Ext.get(this.el.dom.firstChild.firstChild);
1008
1009        if(this.hideHeaders){
1010            this.el.dom.firstChild.style.display = 'none';
1011        }
1012    },
1013
1014    getTemplateTarget : function(){
1015        return this.innerBody;
1016    },
1017
1018    /**
1019     * <p>Function which can be overridden which returns the data object passed to this
1020     * view's {@link #tpl template} to render the whole ListView. The returned object
1021     * shall contain the following properties:</p>
1022     * <div class="mdetail-params"><ul>
1023     * <li><b>columns</b> : String<div class="sub-desc">See <tt>{@link #columns}</tt></div></li>
1024     * <li><b>rows</b> : String<div class="sub-desc">See
1025     * <tt>{@link Ext.DataView}.{@link Ext.DataView#collectData collectData}</div></li>
1026     * </ul></div>
1027     * @param {Array} records An Array of {@link Ext.data.Record}s to be rendered into the DataView.
1028     * @param {Number} startIndex the index number of the Record being prepared for rendering.
1029     * @return {Object} A data object containing properties to be processed by a repeating
1030     * XTemplate as described above.
1031     */
1032    collectData : function(){
1033        var rs = Ext.ListView.superclass.collectData.apply(this, arguments);
1034        return {
1035            columns: this.columns,
1036            rows: rs
1037        }
1038    },
1039
1040    verifyInternalSize : function(){
1041        if(this.lastSize){
1042            this.onResize(this.lastSize.width, this.lastSize.height);
1043        }
1044    },
1045
1046    // private
1047    onResize : function(w, h){
1048        var bd = this.innerBody.dom;
1049        var hd = this.innerHd.dom
1050        if(!bd){
1051            return;
1052        }
1053        var bdp = bd.parentNode;
1054        if(Ext.isNumber(w)){
1055            var sw = w - this.scrollOffset;
1056            if(this.reserveScrollOffset || ((bdp.offsetWidth - bdp.clientWidth) > 10)){
1057                bd.style.width = sw + 'px';
1058                hd.style.width = sw + 'px';
1059            }else{
1060                bd.style.width = w + 'px';
1061                hd.style.width = w + 'px';
1062                setTimeout(function(){
1063                    if((bdp.offsetWidth - bdp.clientWidth) > 10){
1064                        bd.style.width = sw + 'px';
1065                        hd.style.width = sw + 'px';
1066                    }
1067                }, 10);
1068            }
1069        }
1070        if(Ext.isNumber(h == 'number')){
1071            bdp.style.height = (h - hd.parentNode.offsetHeight) + 'px';
1072        }
1073    },
1074
1075    updateIndexes : function(){
1076        Ext.ListView.superclass.updateIndexes.apply(this, arguments);
1077        this.verifyInternalSize();
1078    },
1079
1080    findHeaderIndex : function(hd){
1081        hd = hd.dom || hd;
1082        var pn = hd.parentNode, cs = pn.parentNode.childNodes;
1083        for(var i = 0, c; c = cs[i]; i++){
1084            if(c == pn){
1085                return i;
1086            }
1087        }
1088        return -1;
1089    },
1090
1091    setHdWidths : function(){
1092        var els = this.innerHd.dom.getElementsByTagName('div');
1093        for(var i = 0, cs = this.columns, len = cs.length; i < len; i++){
1094            els[i].style.width = cs[i].width + '%';
1095        }
1096    }
1097});
1098
1099Ext.reg('listview', Ext.ListView);/**
1100 * @class Ext.ListView.ColumnResizer
1101 * @extends Ext.util.Observable
1102 * <p>Supporting Class for Ext.ListView.</p>
1103 * @constructor
1104 * @param {Object} config
1105 */
1106Ext.ListView.ColumnResizer = Ext.extend(Ext.util.Observable, {
1107    /**
1108     * @cfg {Number} minPct The minimum percentage to allot for any column (defaults to <tt>.05</tt>)
1109     */
1110    minPct: .05,
1111
1112    constructor: function(config){
1113        Ext.apply(this, config);
1114        Ext.ListView.ColumnResizer.superclass.constructor.call(this);
1115    },
1116    init : function(listView){
1117        this.view = listView;
1118        listView.on('render', this.initEvents, this);
1119    },
1120
1121    initEvents : function(view){
1122        view.mon(view.innerHd, 'mousemove', this.handleHdMove, this);
1123        this.tracker = new Ext.dd.DragTracker({
1124            onBeforeStart: this.onBeforeStart.createDelegate(this),
1125            onStart: this.onStart.createDelegate(this),
1126            onDrag: this.onDrag.createDelegate(this),
1127            onEnd: this.onEnd.createDelegate(this),
1128            tolerance: 3,
1129            autoStart: 300
1130        });
1131        this.tracker.initEl(view.innerHd);
1132        view.on('beforedestroy', this.tracker.destroy, this.tracker);
1133    },
1134
1135    handleHdMove : function(e, t){
1136        var hw = 5;
1137        var x = e.getPageX();
1138        var hd = e.getTarget('em', 3, true);
1139        if(hd){
1140            var r = hd.getRegion();
1141            var ss = hd.dom.style;
1142            var pn = hd.dom.parentNode;
1143
1144            if(x - r.left <= hw && pn != pn.parentNode.firstChild){
1145                this.activeHd = Ext.get(pn.previousSibling.firstChild);
1146                                ss.cursor = Ext.isWebKit ? 'e-resize' : 'col-resize';
1147            } else if(r.right - x <= hw && pn != pn.parentNode.lastChild.previousSibling){
1148                this.activeHd = hd;
1149                                ss.cursor = Ext.isWebKit ? 'w-resize' : 'col-resize';
1150            } else{
1151                delete this.activeHd;
1152                ss.cursor = '';
1153            }
1154        }
1155    },
1156
1157    onBeforeStart : function(e){
1158        this.dragHd = this.activeHd;
1159        return !!this.dragHd;
1160    },
1161
1162    onStart: function(e){
1163        this.view.disableHeaders = true;
1164        this.proxy = this.view.el.createChild({cls:'x-list-resizer'});
1165        this.proxy.setHeight(this.view.el.getHeight());
1166
1167        var x = this.tracker.getXY()[0];
1168        var w = this.view.innerHd.getWidth();
1169
1170        this.hdX = this.dragHd.getX();
1171        this.hdIndex = this.view.findHeaderIndex(this.dragHd);
1172
1173        this.proxy.setX(this.hdX);
1174        this.proxy.setWidth(x-this.hdX);
1175
1176        this.minWidth = w*this.minPct;
1177        this.maxWidth = w - (this.minWidth*(this.view.columns.length-1-this.hdIndex));
1178    },
1179
1180    onDrag: function(e){
1181        var cursorX = this.tracker.getXY()[0];
1182        this.proxy.setWidth((cursorX-this.hdX).constrain(this.minWidth, this.maxWidth));
1183    },
1184
1185    onEnd: function(e){
1186        var nw = this.proxy.getWidth();
1187        this.proxy.remove();
1188
1189        var index = this.hdIndex;
1190        var vw = this.view, cs = vw.columns, len = cs.length;
1191        var w = this.view.innerHd.getWidth(), minPct = this.minPct * 100;
1192
1193        var pct = Math.ceil((nw*100) / w);
1194        var diff = cs[index].width - pct;
1195        var each = Math.floor(diff / (len-1-index));
1196        var mod = diff - (each * (len-1-index));
1197
1198        for(var i = index+1; i < len; i++){
1199            var cw = cs[i].width + each;
1200            var ncw = Math.max(minPct, cw);
1201            if(cw != ncw){
1202                mod += cw - ncw;
1203            }
1204            cs[i].width = ncw;
1205        }
1206        cs[index].width = pct;
1207        cs[index+1].width += mod;
1208        delete this.dragHd;
1209        this.view.setHdWidths();
1210        this.view.refresh();
1211        setTimeout(function(){
1212            vw.disableHeaders = false;
1213        }, 100);
1214    }
1215});/**
1216 * @class Ext.ListView.Sorter
1217 * @extends Ext.util.Observable
1218 * <p>Supporting Class for Ext.ListView.</p>
1219 * @constructor
1220 * @param {Object} config
1221 */
1222Ext.ListView.Sorter = Ext.extend(Ext.util.Observable, {
1223    /**
1224     * @cfg {Array} sortClasses
1225     * The CSS classes applied to a header when it is sorted. (defaults to <tt>["sort-asc", "sort-desc"]</tt>)
1226     */
1227    sortClasses : ["sort-asc", "sort-desc"],
1228
1229    constructor: function(config){
1230        Ext.apply(this, config);
1231        Ext.ListView.Sorter.superclass.constructor.call(this);
1232    },
1233
1234    init : function(listView){
1235        this.view = listView;
1236        listView.on('render', this.initEvents, this);
1237    },
1238
1239    initEvents : function(view){
1240        view.mon(view.innerHd, 'click', this.onHdClick, this);
1241        view.innerHd.setStyle('cursor', 'pointer');
1242        view.mon(view.store, 'datachanged', this.updateSortState, this);
1243        this.updateSortState.defer(10, this, [view.store]);
1244    },
1245
1246    updateSortState : function(store){
1247        var state = store.getSortState();
1248        if(!state){
1249            return;
1250        }
1251        this.sortState = state;
1252        var cs = this.view.columns, sortColumn = -1;
1253        for(var i = 0, len = cs.length; i < len; i++){
1254            if(cs[i].dataIndex == state.field){
1255                sortColumn = i;
1256                break;
1257            }
1258        }
1259        if(sortColumn != -1){
1260            var sortDir = state.direction;
1261            this.updateSortIcon(sortColumn, sortDir);
1262        }
1263    },
1264
1265    updateSortIcon : function(col, dir){
1266        var sc = this.sortClasses;
1267        var hds = this.view.innerHd.select('em').removeClass(sc);
1268        hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]);
1269    },
1270
1271    onHdClick : function(e){
1272        var hd = e.getTarget('em', 3);
1273        if(hd && !this.view.disableHeaders){
1274            var index = this.view.findHeaderIndex(hd);
1275            this.view.store.sort(this.view.columns[index].dataIndex);
1276        }
1277    }
1278});
Note: See TracBrowser for help on using the repository browser.