]> git.donarmstrong.com Git - roundcube.git/blob - program/js/list.js
Imported Upstream version 0.3
[roundcube.git] / program / js / list.js
1 /*
2  +-----------------------------------------------------------------------+
3  | RoundCube List Widget                                                 |
4  |                                                                       |
5  | This file is part of the RoundCube Webmail client                     |
6  | Copyright (C) 2006-2009, RoundCube Dev, - Switzerland                 |
7  | Licensed under the GNU GPL                                            |
8  |                                                                       |
9  +-----------------------------------------------------------------------+
10  | Authors: Thomas Bruederli <roundcube@gmail.com>                       |
11  |          Charles McNulty <charles@charlesmcnulty.com>                 |
12  +-----------------------------------------------------------------------+
13  | Requires: common.js                                                   |
14  +-----------------------------------------------------------------------+
15
16   $Id: list.js 2761 2009-07-17 08:46:59Z alec $
17 */
18
19
20 /**
21  * RoundCube List Widget class
22  * @contructor
23  */
24 function rcube_list_widget(list, p)
25   {
26   // static contants
27   this.ENTER_KEY = 13;
28   this.DELETE_KEY = 46;
29   this.BACKSPACE_KEY = 8;
30   
31   this.list = list ? list : null;
32   this.frame = null;
33   this.rows = [];
34   this.selection = [];
35   this.rowcount = 0;
36   
37   this.subject_col = -1;
38   this.shiftkey = false;
39   this.multiselect = false;
40   this.multi_selecting = false;
41   this.draggable = false;
42   this.keyboard = false;
43   this.toggleselect = false;
44   
45   this.dont_select = false;
46   this.drag_active = false;
47   this.last_selected = 0;
48   this.shift_start = 0;
49   this.in_selection_before = false;
50   this.focused = false;
51   this.drag_mouse_start = null;
52   this.dblclick_time = 600;
53   this.row_init = function(){};
54   
55   // overwrite default paramaters
56   if (p && typeof(p)=='object')
57     for (var n in p)
58       this[n] = p[n];
59   }
60
61
62 rcube_list_widget.prototype = {
63
64
65 /**
66  * get all message rows from HTML table and init each row
67  */
68 init: function()
69 {
70   if (this.list && this.list.tBodies[0])
71   {
72     this.rows = new Array();
73     this.rowcount = 0;
74
75     var row;
76     for(var r=0; r<this.list.tBodies[0].childNodes.length; r++)
77     {
78       row = this.list.tBodies[0].childNodes[r];
79       while (row && (row.nodeType != 1 || row.style.display == 'none'))
80       {
81         row = row.nextSibling;
82         r++;
83       }
84
85       this.init_row(row);
86       this.rowcount++;
87     }
88
89     this.frame = this.list.parentNode;
90
91     // set body events
92     if (this.keyboard) {
93       rcube_event.add_listener({element:document, event:bw.opera?'keypress':'keydown', object:this, method:'key_press'});
94       rcube_event.add_listener({element:document, event:'keydown', object:this, method:'key_down'});
95     }
96   }
97 },
98
99
100 /**
101  * Init list row and set mouse events on it
102  */
103 init_row: function(row)
104 {
105   // make references in internal array and set event handlers
106   if (row && String(row.id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i))
107   {
108     var p = this;
109     var uid = RegExp.$1;
110     row.uid = uid;
111     this.rows[uid] = {uid:uid, id:row.id, obj:row, classname:row.className};
112
113     // set eventhandlers to table row
114     row.onmousedown = function(e){ return p.drag_row(e, this.uid); };
115     row.onmouseup = function(e){ return p.click_row(e, this.uid); };
116
117     if (document.all)
118       row.onselectstart = function() { return false; };
119
120     this.row_init(this.rows[uid]);
121   }
122 },
123
124
125 /**
126  * Remove all list rows
127  */
128 clear: function(sel)
129 {
130   var tbody = document.createElement('tbody');
131   this.list.insertBefore(tbody, this.list.tBodies[0]);
132   this.list.removeChild(this.list.tBodies[1]);
133   this.rows = new Array();
134   this.rowcount = 0;
135   
136   if (sel) this.clear_selection();
137 },
138
139
140 /**
141  * 'remove' message row from list (just hide it)
142  */
143 remove_row: function(uid, sel_next)
144 {
145   if (this.rows[uid].obj)
146     this.rows[uid].obj.style.display = 'none';
147
148   if (sel_next)
149     this.select_next();
150
151   this.rows[uid] = null;
152   this.rowcount--;
153 },
154
155
156 /**
157  * Add row to the list and initialize it
158  */
159 insert_row: function(row, attop)
160 {
161   if (this.background)
162     var tbody = this.background;
163   else
164     var tbody = this.list.tBodies[0];
165
166   if (attop && tbody.rows.length)
167     tbody.insertBefore(row, tbody.firstChild);
168   else
169     tbody.appendChild(row);
170
171   this.init_row(row);
172   this.rowcount++;
173 },
174
175
176
177 /**
178  * Set focus to the list
179  */
180 focus: function(e)
181 {
182   this.focused = true;
183   for (var n=0; n<this.selection.length; n++)
184   {
185     id = this.selection[n];
186     if (this.rows[id] && this.rows[id].obj) {
187       $(this.rows[id].obj).addClass('selected').removeClass('unfocused');
188     }
189   }
190
191   if (e || (e = window.event))
192     rcube_event.cancel(e);
193 },
194
195
196 /**
197  * remove focus from the list
198  */
199 blur: function()
200 {
201   var id;
202   this.focused = false;
203   for (var n=0; n<this.selection.length; n++)
204   {
205     id = this.selection[n];
206     if (this.rows[id] && this.rows[id].obj) {
207       $(this.rows[id].obj).removeClass('selected').addClass('unfocused');
208     }
209   }
210 },
211
212
213 /**
214  * onmousedown-handler of message list row
215  */
216 drag_row: function(e, id)
217 {
218   // don't do anything (another action processed before)
219   var evtarget = rcube_event.get_target(e);
220   var tagname = evtarget.tagName.toLowerCase();
221   if (this.dont_select || (evtarget && (tagname == 'input' || tagname == 'img')))
222     return true;
223     
224   // accept right-clicks
225   if (rcube_event.get_button(e) == 2)
226     return true;
227   
228   this.in_selection_before = this.in_selection(id) ? id : false;
229
230   // selects currently unselected row
231   if (!this.in_selection_before)
232   {
233     var mod_key = rcube_event.get_modifier(e);
234     this.select_row(id, mod_key, false);
235   }
236
237   if (this.draggable && this.selection.length)
238   {
239     this.drag_start = true;
240     this.drag_mouse_start = rcube_event.get_mouse_pos(e);
241     rcube_event.add_listener({element:document, event:'mousemove', object:this, method:'drag_mouse_move'});
242     rcube_event.add_listener({element:document, event:'mouseup', object:this, method:'drag_mouse_up'});
243
244     // add listener for iframes
245     var iframes = document.getElementsByTagName('iframe');
246     this.iframe_events = Object();
247     for (var n in iframes)
248     {
249       var iframedoc = null;
250       if (iframes[n].contentDocument)
251         iframedoc = iframes[n].contentDocument;
252       else if (iframes[n].contentWindow)
253         iframedoc = iframes[n].contentWindow.document;
254       else if (iframes[n].document)
255         iframedoc = iframes[n].document;
256
257       if (iframedoc)
258       {
259         var list = this;
260         var pos = $('#'+iframes[n].id).offset();
261         this.iframe_events[n] = function(e) { e._offset = pos; return list.drag_mouse_move(e); }
262
263         if (iframedoc.addEventListener)
264           iframedoc.addEventListener('mousemove', this.iframe_events[n], false);
265         else if (iframes[n].attachEvent)
266           iframedoc.attachEvent('onmousemove', this.iframe_events[n]);
267         else
268           iframedoc['onmousemove'] = this.iframe_events[n];
269
270         rcube_event.add_listener({element:iframedoc, event:'mouseup', object:this, method:'drag_mouse_up'});
271       }
272     }
273   }
274
275   return false;
276 },
277
278
279 /**
280  * onmouseup-handler of message list row
281  */
282 click_row: function(e, id)
283 {
284   var now = new Date().getTime();
285   var mod_key = rcube_event.get_modifier(e);
286   var evtarget = rcube_event.get_target(e);
287   var tagname = evtarget.tagName.toLowerCase();
288
289   if ((evtarget && (tagname == 'input' || tagname == 'img')))
290     return true;
291
292   // don't do anything (another action processed before)
293   if (this.dont_select)
294     {
295     this.dont_select = false;
296     return false;
297     }
298     
299   var dblclicked = now - this.rows[id].clicked < this.dblclick_time;
300
301   // unselects currently selected row
302   if (!this.drag_active && this.in_selection_before == id && !dblclicked)
303     this.select_row(id, mod_key, false);
304
305   this.drag_start = false;
306   this.in_selection_before = false;
307
308   // row was double clicked
309   if (this.rows && dblclicked && this.in_selection(id))
310     this.triggerEvent('dblclick');
311   else
312     this.triggerEvent('click');
313
314   if (!this.drag_active)
315     rcube_event.cancel(e);
316
317   this.rows[id].clicked = now;
318   return false;
319 },
320
321
322 /**
323  * get next/previous/last rows that are not hidden
324  */
325 get_next_row: function()
326 {
327   if (!this.rows)
328     return false;
329
330   var last_selected_row = this.rows[this.last_selected];
331   var new_row = last_selected_row ? last_selected_row.obj.nextSibling : null;
332   while (new_row && (new_row.nodeType != 1 || new_row.style.display == 'none'))
333     new_row = new_row.nextSibling;
334
335   return new_row;
336 },
337
338 get_prev_row: function()
339 {
340   if (!this.rows)
341     return false;
342
343   var last_selected_row = this.rows[this.last_selected];
344   var new_row = last_selected_row ? last_selected_row.obj.previousSibling : null;
345   while (new_row && (new_row.nodeType != 1 || new_row.style.display == 'none'))
346     new_row = new_row.previousSibling;
347
348   return new_row;
349 },
350
351 get_last_row: function()
352 {
353   if (this.rowcount)
354     {
355     var rows = this.list.tBodies[0].rows;
356
357     for(var i=rows.length-1; i>=0; i--)
358       if(rows[i].id && String(rows[i].id).match(/rcmrow([a-z0-9\-_=\+\/]+)/i) && this.rows[RegExp.$1] != null)
359         return RegExp.$1;
360     }
361
362   return null;
363 },
364
365
366 /**
367  * selects or unselects the proper row depending on the modifier key pressed
368  */
369 select_row: function(id, mod_key, with_mouse)
370 {
371   var select_before = this.selection.join(',');
372   if (!this.multiselect)
373     mod_key = 0;
374     
375   if (!this.shift_start)
376     this.shift_start = id
377
378   if (!mod_key)
379   {
380     this.shift_start = id;
381     this.highlight_row(id, false);
382     this.multi_selecting = false;
383   }
384   else
385   {
386     switch (mod_key)
387     {
388       case SHIFT_KEY:
389         this.shift_select(id, false);
390         break;
391
392       case CONTROL_KEY:
393         if (!with_mouse)
394           this.highlight_row(id, true);
395         break; 
396
397       case CONTROL_SHIFT_KEY:
398         this.shift_select(id, true);
399         break;
400
401       default:
402         this.highlight_row(id, false);
403         break;
404     }
405     this.multi_selecting = true;
406   }
407
408   // trigger event if selection changed
409   if (this.selection.join(',') != select_before)
410     this.triggerEvent('select');
411
412   if (this.last_selected != 0 && this.rows[this.last_selected])
413     $(this.rows[this.last_selected].obj).removeClass('focused');
414
415   // unselect if toggleselect is active and the same row was clicked again
416   if (this.toggleselect && this.last_selected == id)
417   {
418     this.clear_selection();
419     id = null;
420   }
421   else
422     $(this.rows[id].obj).addClass('focused');
423
424   if (!this.selection.length)
425     this.shift_start = null;
426
427   this.last_selected = id;
428 },
429
430
431 /**
432  * Alias method for select_row
433  */
434 select: function(id)
435 {
436   this.select_row(id, false);
437   this.scrollto(id);
438 },
439
440
441 /**
442  * Select row next to the last selected one.
443  * Either below or above.
444  */
445 select_next: function()
446 {
447   var next_row = this.get_next_row();
448   var prev_row = this.get_prev_row();
449   var new_row = (next_row) ? next_row : prev_row;
450   if (new_row)
451     this.select_row(new_row.uid, false, false);  
452 },
453
454
455 /**
456  * Perform selection when shift key is pressed
457  */
458 shift_select: function(id, control)
459 {
460   if (!this.rows[this.shift_start] || !this.selection.length)
461     this.shift_start = id;
462
463   var from_rowIndex = this.rows[this.shift_start].obj.rowIndex;
464   var to_rowIndex = this.rows[id].obj.rowIndex;
465
466   var i = ((from_rowIndex < to_rowIndex)? from_rowIndex : to_rowIndex);
467   var j = ((from_rowIndex > to_rowIndex)? from_rowIndex : to_rowIndex);
468
469   // iterate through the entire message list
470   for (var n in this.rows)
471   {
472     if ((this.rows[n].obj.rowIndex >= i) && (this.rows[n].obj.rowIndex <= j))
473     {
474       if (!this.in_selection(n))
475         this.highlight_row(n, true);
476     }
477     else
478     {
479       if  (this.in_selection(n) && !control)
480         this.highlight_row(n, true);
481     }
482   }
483 },
484
485
486 /**
487  * Check if given id is part of the current selection
488  */
489 in_selection: function(id)
490 {
491   for(var n in this.selection)
492     if (this.selection[n]==id)
493       return true;
494
495   return false;    
496 },
497
498
499 /**
500  * Select each row in list
501  */
502 select_all: function(filter)
503 {
504   if (!this.rows || !this.rows.length)
505     return false;
506
507   // reset but remember selection first
508   var select_before = this.selection.join(',');
509   this.selection = new Array();
510   
511   for (var n in this.rows)
512   {
513     if (!filter || (this.rows[n] && this.rows[n][filter] == true))
514     {
515       this.last_selected = n;
516       this.highlight_row(n, true);
517     }
518     else if (this.rows[n])
519     {
520       $(this.rows[n].obj).removeClass('selected').removeClass('unfocused');
521     }
522   }
523
524   // trigger event if selection changed
525   if (this.selection.join(',') != select_before)
526     this.triggerEvent('select');
527
528   this.focus();
529
530   return true;
531 },
532
533
534 /**
535  * Invert selection
536  */
537 invert_selection: function()
538 {
539   if (!this.rows || !this.rows.length)
540     return false;
541
542   // remember old selection
543   var select_before = this.selection.join(',');
544   
545   for (var n in this.rows)
546     this.highlight_row(n, true);    
547
548   // trigger event if selection changed
549   if (this.selection.join(',') != select_before)
550     this.triggerEvent('select');
551
552   this.focus();
553
554   return true;
555 },
556
557
558 /**
559  * Unselect selected row(s)
560  */
561 clear_selection: function(id)
562 {
563   var num_select = this.selection.length;
564
565   // one row
566   if (id)
567     {
568     for (var n=0; n<this.selection.length; n++)
569       if (this.selection[n] == id) {
570         this.selection.splice(n,1);
571         break;
572       }
573     }
574   // all rows
575   else
576     {
577     for (var n=0; n<this.selection.length; n++)
578       if (this.rows[this.selection[n]]) {
579         $(this.rows[this.selection[n]].obj).removeClass('selected').removeClass('unfocused');
580         }
581     
582     this.selection = new Array();
583     }
584
585   if (num_select && !this.selection.length)
586     this.triggerEvent('select');
587 },
588
589
590 /**
591  * Getter for the selection array
592  */
593 get_selection: function()
594 {
595   return this.selection;
596 },
597
598
599 /**
600  * Return the ID if only one row is selected
601  */
602 get_single_selection: function()
603 {
604   if (this.selection.length == 1)
605     return this.selection[0];
606   else
607     return null;
608 },
609
610
611 /**
612  * Highlight/unhighlight a row
613  */
614 highlight_row: function(id, multiple)
615 {
616   if (this.rows[id] && !multiple)
617   {
618     if (this.selection.length > 1 || !this.in_selection(id))
619     {
620       this.clear_selection();
621       this.selection[0] = id;
622       $(this.rows[id].obj).addClass('selected');
623     }
624   }
625   else if (this.rows[id])
626   {
627     if (!this.in_selection(id))  // select row
628     {
629       this.selection[this.selection.length] = id;
630       $(this.rows[id].obj).addClass('selected');
631     }
632     else  // unselect row
633     {
634       var p = find_in_array(id, this.selection);
635       var a_pre = this.selection.slice(0, p);
636       var a_post = this.selection.slice(p+1, this.selection.length);
637       this.selection = a_pre.concat(a_post);
638       $(this.rows[id].obj).removeClass('selected').removeClass('unfocused');
639     }
640   }
641 },
642
643
644 /**
645  * Handler for keyboard events
646  */
647 key_press: function(e)
648 {
649   if (this.focused != true)
650     return true;
651
652   var keyCode = rcube_event.get_keycode(e);
653   var mod_key = rcube_event.get_modifier(e);
654
655   switch (keyCode)
656   {
657     case 40:
658     case 38: 
659     case 63233: // "down", in safari keypress
660     case 63232: // "up", in safari keypress
661       // Stop propagation so that the browser doesn't scroll
662       rcube_event.cancel(e);
663       return this.use_arrow_key(keyCode, mod_key);
664     default:
665       this.shiftkey = e.shiftKey;
666       this.key_pressed = keyCode;
667       this.triggerEvent('keypress');
668       
669       if (this.key_pressed == this.BACKSPACE_KEY)
670         return rcube_event.cancel(e);
671   }
672   
673   return true;
674 },
675
676 /**
677  * Handler for keydown events
678  */
679 key_down: function(e)
680 {
681   switch (rcube_event.get_keycode(e))
682   {
683     case 27:
684       if (this.drag_active)
685         return this.drag_mouse_up(e);
686         
687     case 40:
688     case 38: 
689     case 63233:
690     case 63232:
691       if (!rcube_event.get_modifier(e) && this.focused)
692         return rcube_event.cancel(e);
693         
694     default:
695   }
696   
697   return true;
698 },
699
700
701 /**
702  * Special handling method for arrow keys
703  */
704 use_arrow_key: function(keyCode, mod_key)
705 {
706   var new_row;
707   // Safari uses the nonstandard keycodes 63232/63233 for up/down, if we're
708   // using the keypress event (but not the keydown or keyup event).
709   if (keyCode == 40 || keyCode == 63233) // down arrow key pressed
710     new_row = this.get_next_row();
711   else if (keyCode == 38 || keyCode == 63232) // up arrow key pressed
712     new_row = this.get_prev_row();
713
714   if (new_row)
715   {
716     this.select_row(new_row.uid, mod_key, true);
717     this.scrollto(new_row.uid);
718   }
719
720   return false;
721 },
722
723
724 /**
725  * Try to scroll the list to make the specified row visible
726  */
727 scrollto: function(id)
728 {
729   var row = this.rows[id].obj;
730   if (row && this.frame)
731   {
732     var scroll_to = Number(row.offsetTop);
733
734     if (scroll_to < Number(this.frame.scrollTop))
735       this.frame.scrollTop = scroll_to;
736     else if (scroll_to + Number(row.offsetHeight) > Number(this.frame.scrollTop) + Number(this.frame.offsetHeight))
737       this.frame.scrollTop = (scroll_to + Number(row.offsetHeight)) - Number(this.frame.offsetHeight);
738   }
739 },
740
741
742 /**
743  * Handler for mouse move events
744  */
745 drag_mouse_move: function(e)
746 {
747   if (this.drag_start)
748   {
749     // check mouse movement, of less than 3 pixels, don't start dragging
750     var m = rcube_event.get_mouse_pos(e);
751
752     if (!this.drag_mouse_start || (Math.abs(m.x - this.drag_mouse_start.x) < 3 && Math.abs(m.y - this.drag_mouse_start.y) < 3))
753       return false;
754   
755     if (!this.draglayer)
756       this.draglayer = $('<div>').attr('id', 'rcmdraglayer').css({ position:'absolute', display:'none', 'z-index':2000 }).appendTo(document.body);
757
758     // get subjects of selectedd messages
759     var names = '';
760     var c, i, node, subject, obj;
761     for(var n=0; n<this.selection.length; n++)
762     {
763       if (n>12)  // only show 12 lines
764       {
765         names += '...';
766         break;
767       }
768
769       if (this.rows[this.selection[n]].obj)
770       {
771         obj = this.rows[this.selection[n]].obj;
772         subject = '';
773
774         for(c=0, i=0; i<obj.childNodes.length; i++)
775         {
776           if (obj.childNodes[i].nodeName == 'TD')
777           {
778             if (((node = obj.childNodes[i].firstChild) && (node.nodeType==3 || node.nodeName=='A')) &&
779               (this.subject_col < 0 || (this.subject_col >= 0 && this.subject_col == c)))
780             {
781               if (n == 0) {
782                 if (node.nodeType == 3)
783                   this.drag_start_pos = $(obj.childNodes[i]).offset();
784                 else
785                   this.drag_start_pos = $(node).offset();
786               }
787               subject = node.nodeType==3 ? node.data : node.innerHTML;
788               // remove leading spaces
789               subject = subject.replace(/^\s+/i, '');
790               // truncate line to 50 characters
791               names += (subject.length > 50 ? subject.substring(0, 50)+'...' : subject) + '<br />';
792               break;
793             }
794             c++;
795           }
796         }
797       }
798     }
799
800     this.draglayer.html(names);
801     this.draglayer.show();
802
803     this.drag_active = true;
804     this.triggerEvent('dragstart');
805   }
806
807   if (this.drag_active && this.draglayer)
808   {
809     var pos = rcube_event.get_mouse_pos(e);
810     this.draglayer.css({ left:(pos.x+20)+'px', top:(pos.y-5 + (bw.ie ? document.documentElement.scrollTop : 0))+'px' });
811     this.triggerEvent('dragmove', e?e:window.event);
812   }
813
814   this.drag_start = false;
815
816   return false;
817 },
818
819
820 /**
821  * Handler for mouse up events
822  */
823 drag_mouse_up: function(e)
824 {
825   document.onmousemove = null;
826
827   if (this.draglayer && this.draglayer.is(':visible')) {
828     if (this.drag_start_pos)
829       this.draglayer.animate(this.drag_start_pos, 300, 'swing').hide(20);
830     else
831       this.draglayer.hide();
832   }
833
834   this.drag_active = false;
835   this.triggerEvent('dragend');
836
837   rcube_event.remove_listener({element:document, event:'mousemove', object:this, method:'drag_mouse_move'});
838   rcube_event.remove_listener({element:document, event:'mouseup', object:this, method:'drag_mouse_up'});
839
840   var iframes = document.getElementsByTagName('iframe');
841   for (var n in iframes) {
842     var iframedoc;
843     
844     if (iframes[n].contentDocument)
845       iframedoc = iframes[n].contentDocument;
846     else if (iframes[n].contentWindow)
847       iframedoc = iframes[n].contentWindow.document;
848     else if (iframes[n].document)
849       iframedoc = iframes[n].document;
850
851     if (iframedoc) {
852       if (this.iframe_events[n]) {
853         if (iframedoc.removeEventListener)
854           iframedoc.removeEventListener('mousemove', this.iframe_events[n], false);
855         else if (iframedoc.detachEvent)
856           iframedoc.detachEvent('onmousemove', this.iframe_events[n]);
857         else
858           iframedoc['onmousemove'] = null;
859         }
860       rcube_event.remove_listener({element:iframedoc, event:'mouseup', object:this, method:'drag_mouse_up'});
861       }
862     }
863
864   return rcube_event.cancel(e);
865 },
866
867
868 /**
869  * Creating the list in background
870  */
871 set_background_mode: function(flag)
872 {
873   if (flag) {
874     this.background = document.createElement('tbody');
875   } else if (this.background) {
876     this.list.replaceChild(this.background, this.list.tBodies[0]);
877     this.background = null;
878   }
879 }
880
881 };
882
883 rcube_list_widget.prototype.addEventListener = rcube_event_engine.prototype.addEventListener;
884 rcube_list_widget.prototype.removeEventListener = rcube_event_engine.prototype.removeEventListener;
885 rcube_list_widget.prototype.triggerEvent = rcube_event_engine.prototype.triggerEvent;